include/llvm/MC/MCExpr.h

   1 //===- MCExpr.h - Assembly Level Expressions --------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLVM_MC_MCEXPR_H
  11 #define LLVM_MC_MCEXPR_H
  12
  13 #include "llvm/ADT/DenseMap.h"
  14 #include "llvm/Support/Casting.h"
  15 #include "llvm/Support/DataTypes.h"
  16
  17 namespace llvm {
  18 class MCAsmInfo;
  19 class MCAsmLayout;
  20 class MCAssembler;
  21 class MCContext;
  22 class MCSection;
  23 class MCSectionData;
  24 class MCSymbol;
  25 class MCValue;
  26 class raw_ostream;
  27 class StringRef;
  28 typedef DenseMap<const MCSectionData*, uint64_t> SectionAddrMap;
  29
  30 /// MCExpr - Base class for the full range of assembler expressions which are
  31 /// needed for parsing.
  32 class MCExpr {
  33 public:
  34   enum ExprKind {
  35     Binary,    ///< Binary expressions.
  36     Constant,  ///< Constant expressions.
  37     SymbolRef, ///< References to labels and assigned expressions.
  38     Unary,     ///< Unary expressions.
  39     Target     ///< Target specific expression.
  40   };
  41
  42 private:
  43   ExprKind Kind;
  44
  45   MCExpr(const MCExpr&) LLVM_DELETED_FUNCTION;
  46   void operator=(const MCExpr&) LLVM_DELETED_FUNCTION;
  47
  48   bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
  49                           const MCAsmLayout *Layout,
  50                           const SectionAddrMap *Addrs) const;
  51 protected:
  52   explicit MCExpr(ExprKind _Kind) : Kind(_Kind) {}
  53
  54   bool EvaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
  55                                  const MCAsmLayout *Layout,
  56                                  const SectionAddrMap *Addrs,
  57                                  bool InSet) const;
  58 public:
  59   /// @name Accessors
  60   /// @{
  61
  62   ExprKind getKind() const { return Kind; }
  63
  64   /// @}
  65   /// @name Utility Methods
  66   /// @{
  67
  68   void print(raw_ostream &OS) const;
  69   void dump() const;
  70
  71   /// @}
  72   /// @name Expression Evaluation
  73   /// @{
  74
  75   /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
  76   ///
  77   /// @param Res - The absolute value, if evaluation succeeds.
  78   /// @param Layout - The assembler layout object to use for evaluating symbol
  79   /// values. If not given, then only non-symbolic expressions will be
  80   /// evaluated.
  81   /// @result - True on success.
  82   bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout,
  83                           const SectionAddrMap &Addrs) const;
  84   bool EvaluateAsAbsolute(int64_t &Res) const;
  85   bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const;
  86   bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const;
  87
  88   /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
  89   /// value, i.e. an expression of the fixed form (a - b + constant).
  90   ///
  91   /// @param Res - The relocatable value, if evaluation succeeds.
  92   /// @param Layout - The assembler layout object to use for evaluating values.
  93   /// @result - True on success.
  94   bool EvaluateAsRelocatable(MCValue &Res, const MCAsmLayout &Layout) const;
  95
  96   /// FindAssociatedSection - Find the "associated section" for this expression,
  97   /// which is currently defined as the absolute section for constants, or
  98   /// otherwise the section associated with the first defined symbol in the
  99   /// expression.
 100   const MCSection *FindAssociatedSection() const;
 101
 102   /// @}
 103 };
 104
 105 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
 106   E.print(OS);
 107   return OS;
 108 }
 109
 110 //// MCConstantExpr - Represent a constant integer expression.
 111 class MCConstantExpr : public MCExpr {
 112   int64_t Value;
 113
 114   explicit MCConstantExpr(int64_t _Value)
 115     : MCExpr(MCExpr::Constant), Value(_Value) {}
 116
 117 public:
 118   /// @name Construction
 119   /// @{
 120
 121   static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
 122
 123   /// @}
 124   /// @name Accessors
 125   /// @{
 126
 127   int64_t getValue() const { return Value; }
 128
 129   /// @}
 130
 131   static bool classof(const MCExpr *E) {
 132     return E->getKind() == MCExpr::Constant;
 133   }
 134 };
 135
 136 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
 137 /// expression.
 138 ///
 139 /// A symbol reference in an expression may be a use of a label, a use of an
 140 /// assembler variable (defined constant), or constitute an implicit definition
 141 /// of the symbol as external.
 142 class MCSymbolRefExpr : public MCExpr {
 143 public:
 144   enum VariantKind {
 145     VK_None,
 146     VK_Invalid,
 147
 148     VK_GOT,
 149     VK_GOTOFF,
 150     VK_GOTPCREL,
 151     VK_GOTTPOFF,
 152     VK_INDNTPOFF,
 153     VK_NTPOFF,
 154     VK_GOTNTPOFF,
 155     VK_PLT,
 156     VK_TLSGD,
 157     VK_TLSLD,
 158     VK_TLSLDM,
 159     VK_TPOFF,
 160     VK_DTPOFF,
 161     VK_TLVP,      // Mach-O thread local variable relocation
 162     VK_SECREL,
 163
 164     VK_ARM_NONE,
 165     VK_ARM_TARGET1,
 166     VK_ARM_TARGET2,
 167     VK_ARM_PREL31,
 168     VK_ARM_TLSLDO,         // symbol(tlsldo)
 169     VK_ARM_TLSCALL,        // symbol(tlscall)
 170
 171     VK_PPC_LO,             // symbol@l
 172     VK_PPC_HI,             // symbol@h
 173     VK_PPC_HA,             // symbol@ha
 174     VK_PPC_HIGHER,         // symbol@higher
 175     VK_PPC_HIGHERA,        // symbol@highera
 176     VK_PPC_HIGHEST,        // symbol@highest
 177     VK_PPC_HIGHESTA,       // symbol@highesta
 178     VK_PPC_GOT_LO,         // symbol@got@l
 179     VK_PPC_GOT_HI,         // symbol@got@h
 180     VK_PPC_GOT_HA,         // symbol@got@ha
 181     VK_PPC_TOCBASE,        // symbol@tocbase
 182     VK_PPC_TOC,            // symbol@toc
 183     VK_PPC_TOC_LO,         // symbol@toc@l
 184     VK_PPC_TOC_HI,         // symbol@toc@h
 185     VK_PPC_TOC_HA,         // symbol@toc@ha
 186     VK_PPC_DTPMOD,         // symbol@dtpmod
 187     VK_PPC_TPREL,          // symbol@tprel
 188     VK_PPC_TPREL_LO,       // symbol@tprel@l
 189     VK_PPC_TPREL_HI,       // symbol@tprel@h
 190     VK_PPC_TPREL_HA,       // symbol@tprel@ha
 191     VK_PPC_TPREL_HIGHER,   // symbol@tprel@higher
 192     VK_PPC_TPREL_HIGHERA,  // symbol@tprel@highera
 193     VK_PPC_TPREL_HIGHEST,  // symbol@tprel@highest
 194     VK_PPC_TPREL_HIGHESTA, // symbol@tprel@highesta
 195     VK_PPC_DTPREL,         // symbol@dtprel
 196     VK_PPC_DTPREL_LO,      // symbol@dtprel@l
 197     VK_PPC_DTPREL_HI,      // symbol@dtprel@h
 198     VK_PPC_DTPREL_HA,      // symbol@dtprel@ha
 199     VK_PPC_DTPREL_HIGHER,  // symbol@dtprel@higher
 200     VK_PPC_DTPREL_HIGHERA, // symbol@dtprel@highera
 201     VK_PPC_DTPREL_HIGHEST, // symbol@dtprel@highest
 202     VK_PPC_DTPREL_HIGHESTA,// symbol@dtprel@highesta
 203     VK_PPC_GOT_TPREL,      // symbol@got@tprel
 204     VK_PPC_GOT_TPREL_LO,   // symbol@got@tprel@l
 205     VK_PPC_GOT_TPREL_HI,   // symbol@got@tprel@h
 206     VK_PPC_GOT_TPREL_HA,   // symbol@got@tprel@ha
 207     VK_PPC_GOT_DTPREL,     // symbol@got@dtprel
 208     VK_PPC_GOT_DTPREL_LO,  // symbol@got@dtprel@l
 209     VK_PPC_GOT_DTPREL_HI,  // symbol@got@dtprel@h
 210     VK_PPC_GOT_DTPREL_HA,  // symbol@got@dtprel@ha
 211     VK_PPC_TLS,            // symbol@tls
 212     VK_PPC_GOT_TLSGD,      // symbol@got@tlsgd
 213     VK_PPC_GOT_TLSGD_LO,   // symbol@got@tlsgd@l
 214     VK_PPC_GOT_TLSGD_HI,   // symbol@got@tlsgd@h
 215     VK_PPC_GOT_TLSGD_HA,   // symbol@got@tlsgd@ha
 216     VK_PPC_TLSGD,          // symbol@tlsgd
 217     VK_PPC_GOT_TLSLD,      // symbol@got@tlsld
 218     VK_PPC_GOT_TLSLD_LO,   // symbol@got@tlsld@l
 219     VK_PPC_GOT_TLSLD_HI,   // symbol@got@tlsld@h
 220     VK_PPC_GOT_TLSLD_HA,   // symbol@got@tlsld@ha
 221     VK_PPC_TLSLD,          // symbol@tlsld
 222
 223     VK_Mips_GPREL,
 224     VK_Mips_GOT_CALL,
 225     VK_Mips_GOT16,
 226     VK_Mips_GOT,
 227     VK_Mips_ABS_HI,
 228     VK_Mips_ABS_LO,
 229     VK_Mips_TLSGD,
 230     VK_Mips_TLSLDM,
 231     VK_Mips_DTPREL_HI,
 232     VK_Mips_DTPREL_LO,
 233     VK_Mips_GOTTPREL,
 234     VK_Mips_TPREL_HI,
 235     VK_Mips_TPREL_LO,
 236     VK_Mips_GPOFF_HI,
 237     VK_Mips_GPOFF_LO,
 238     VK_Mips_GOT_DISP,
 239     VK_Mips_GOT_PAGE,
 240     VK_Mips_GOT_OFST,
 241     VK_Mips_HIGHER,
 242     VK_Mips_HIGHEST,
 243     VK_Mips_GOT_HI16,
 244     VK_Mips_GOT_LO16,
 245     VK_Mips_CALL_HI16,
 246     VK_Mips_CALL_LO16,
 247
 248     VK_COFF_IMGREL32 // symbol@imgrel (image-relative)
 249   };
 250
 251 private:
 252   /// The symbol being referenced.
 253   const MCSymbol *Symbol;
 254
 255   /// The symbol reference modifier.
 256   const VariantKind Kind;
 257
 258   /// MCAsmInfo that is used to print symbol variants correctly.
 259   const MCAsmInfo *MAI;
 260
 261   explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind,
 262                            const MCAsmInfo *_MAI)
 263     : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind), MAI(_MAI) {
 264     assert(Symbol);
 265     assert(MAI);
 266   }
 267
 268 public:
 269   /// @name Construction
 270   /// @{
 271
 272   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
 273     return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
 274   }
 275
 276   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
 277                                        MCContext &Ctx);
 278   static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
 279                                        MCContext &Ctx);
 280
 281   /// @}
 282   /// @name Accessors
 283   /// @{
 284
 285   const MCSymbol &getSymbol() const { return *Symbol; }
 286   const MCAsmInfo &getMCAsmInfo() const { return *MAI; }
 287
 288   VariantKind getKind() const { return Kind; }
 289
 290   /// @}
 291   /// @name Static Utility Functions
 292   /// @{
 293
 294   static StringRef getVariantKindName(VariantKind Kind);
 295
 296   static VariantKind getVariantKindForName(StringRef Name);
 297
 298   /// @}
 299
 300   static bool classof(const MCExpr *E) {
 301     return E->getKind() == MCExpr::SymbolRef;
 302   }
 303 };
 304
 305 /// MCUnaryExpr - Unary assembler expressions.
 306 class MCUnaryExpr : public MCExpr {
 307 public:
 308   enum Opcode {
 309     LNot,  ///< Logical negation.
 310     Minus, ///< Unary minus.
 311     Not,   ///< Bitwise negation.
 312     Plus   ///< Unary plus.
 313   };
 314
 315 private:
 316   Opcode Op;
 317   const MCExpr *Expr;
 318
 319   MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
 320     : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
 321
 322 public:
 323   /// @name Construction
 324   /// @{
 325
 326   static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
 327                                    MCContext &Ctx);
 328   static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
 329     return Create(LNot, Expr, Ctx);
 330   }
 331   static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
 332     return Create(Minus, Expr, Ctx);
 333   }
 334   static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
 335     return Create(Not, Expr, Ctx);
 336   }
 337   static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
 338     return Create(Plus, Expr, Ctx);
 339   }
 340
 341   /// @}
 342   /// @name Accessors
 343   /// @{
 344
 345   /// getOpcode - Get the kind of this unary expression.
 346   Opcode getOpcode() const { return Op; }
 347
 348   /// getSubExpr - Get the child of this unary expression.
 349   const MCExpr *getSubExpr() const { return Expr; }
 350
 351   /// @}
 352
 353   static bool classof(const MCExpr *E) {
 354     return E->getKind() == MCExpr::Unary;
 355   }
 356 };
 357
 358 /// MCBinaryExpr - Binary assembler expressions.
 359 class MCBinaryExpr : public MCExpr {
 360 public:
 361   enum Opcode {
 362     Add,  ///< Addition.
 363     And,  ///< Bitwise and.
 364     Div,  ///< Signed division.
 365     EQ,   ///< Equality comparison.
 366     GT,   ///< Signed greater than comparison (result is either 0 or some
 367           ///< target-specific non-zero value)
 368     GTE,  ///< Signed greater than or equal comparison (result is either 0 or
 369           ///< some target-specific non-zero value).
 370     LAnd, ///< Logical and.
 371     LOr,  ///< Logical or.
 372     LT,   ///< Signed less than comparison (result is either 0 or
 373           ///< some target-specific non-zero value).
 374     LTE,  ///< Signed less than or equal comparison (result is either 0 or
 375           ///< some target-specific non-zero value).
 376     Mod,  ///< Signed remainder.
 377     Mul,  ///< Multiplication.
 378     NE,   ///< Inequality comparison.
 379     Or,   ///< Bitwise or.
 380     Shl,  ///< Shift left.
 381     Shr,  ///< Shift right (arithmetic or logical, depending on target)
 382     Sub,  ///< Subtraction.
 383     Xor   ///< Bitwise exclusive or.
 384   };
 385
 386 private:
 387   Opcode Op;
 388   const MCExpr *LHS, *RHS;
 389
 390   MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
 391     : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
 392
 393 public:
 394   /// @name Construction
 395   /// @{
 396
 397   static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
 398                                     const MCExpr *RHS, MCContext &Ctx);
 399   static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
 400                                        MCContext &Ctx) {
 401     return Create(Add, LHS, RHS, Ctx);
 402   }
 403   static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
 404                                        MCContext &Ctx) {
 405     return Create(And, LHS, RHS, Ctx);
 406   }
 407   static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
 408                                        MCContext &Ctx) {
 409     return Create(Div, LHS, RHS, Ctx);
 410   }
 411   static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
 412                                       MCContext &Ctx) {
 413     return Create(EQ, LHS, RHS, Ctx);
 414   }
 415   static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
 416                                       MCContext &Ctx) {
 417     return Create(GT, LHS, RHS, Ctx);
 418   }
 419   static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
 420                                        MCContext &Ctx) {
 421     return Create(GTE, LHS, RHS, Ctx);
 422   }
 423   static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
 424                                         MCContext &Ctx) {
 425     return Create(LAnd, LHS, RHS, Ctx);
 426   }
 427   static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
 428                                        MCContext &Ctx) {
 429     return Create(LOr, LHS, RHS, Ctx);
 430   }
 431   static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
 432                                       MCContext &Ctx) {
 433     return Create(LT, LHS, RHS, Ctx);
 434   }
 435   static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
 436                                        MCContext &Ctx) {
 437     return Create(LTE, LHS, RHS, Ctx);
 438   }
 439   static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
 440                                        MCContext &Ctx) {
 441     return Create(Mod, LHS, RHS, Ctx);
 442   }
 443   static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
 444                                        MCContext &Ctx) {
 445     return Create(Mul, LHS, RHS, Ctx);
 446   }
 447   static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
 448                                       MCContext &Ctx) {
 449     return Create(NE, LHS, RHS, Ctx);
 450   }
 451   static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
 452                                       MCContext &Ctx) {
 453     return Create(Or, LHS, RHS, Ctx);
 454   }
 455   static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
 456                                        MCContext &Ctx) {
 457     return Create(Shl, LHS, RHS, Ctx);
 458   }
 459   static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
 460                                        MCContext &Ctx) {
 461     return Create(Shr, LHS, RHS, Ctx);
 462   }
 463   static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
 464                                        MCContext &Ctx) {
 465     return Create(Sub, LHS, RHS, Ctx);
 466   }
 467   static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
 468                                        MCContext &Ctx) {
 469     return Create(Xor, LHS, RHS, Ctx);
 470   }
 471
 472   /// @}
 473   /// @name Accessors
 474   /// @{
 475
 476   /// getOpcode - Get the kind of this binary expression.
 477   Opcode getOpcode() const { return Op; }
 478
 479   /// getLHS - Get the left-hand side expression of the binary operator.
 480   const MCExpr *getLHS() const { return LHS; }
 481
 482   /// getRHS - Get the right-hand side expression of the binary operator.
 483   const MCExpr *getRHS() const { return RHS; }
 484
 485   /// @}
 486
 487   static bool classof(const MCExpr *E) {
 488     return E->getKind() == MCExpr::Binary;
 489   }
 490 };
 491
 492 /// MCTargetExpr - This is an extension point for target-specific MCExpr
 493 /// subclasses to implement.
 494 ///
 495 /// NOTE: All subclasses are required to have trivial destructors because
 496 /// MCExprs are bump pointer allocated and not destructed.
 497 class MCTargetExpr : public MCExpr {
 498   virtual void anchor();
 499 protected:
 500   MCTargetExpr() : MCExpr(Target) {}
 501   virtual ~MCTargetExpr() {}
 502 public:
 503
 504   virtual void PrintImpl(raw_ostream &OS) const = 0;
 505   virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
 506                                          const MCAsmLayout *Layout) const = 0;
 507   virtual void AddValueSymbols(MCAssembler *) const = 0;
 508   virtual const MCSection *FindAssociatedSection() const = 0;
 509
 510   virtual void fixELFSymbolsInTLSFixups(MCAssembler &) const = 0;
 511
 512   static bool classof(const MCExpr *E) {
 513     return E->getKind() == MCExpr::Target;
 514   }
 515 };
 516
 517 } // end namespace llvm
 518
 519 #endif