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
 169     VK_PPC_LO,             // symbol@l
 170     VK_PPC_HI,             // symbol@h
 171     VK_PPC_HA,             // symbol@ha
 172     VK_PPC_HIGHER,         // symbol@higher
 173     VK_PPC_HIGHERA,        // symbol@highera
 174     VK_PPC_HIGHEST,        // symbol@highest
 175     VK_PPC_HIGHESTA,       // symbol@highesta
 176     VK_PPC_GOT_LO,         // symbol@got@l
 177     VK_PPC_GOT_HI,         // symbol@got@h
 178     VK_PPC_GOT_HA,         // symbol@got@ha
 179     VK_PPC_TOCBASE,        // symbol@tocbase
 180     VK_PPC_TOC,            // symbol@toc
 181     VK_PPC_TOC_LO,         // symbol@toc@l
 182     VK_PPC_TOC_HI,         // symbol@toc@h
 183     VK_PPC_TOC_HA,         // symbol@toc@ha
 184     VK_PPC_DTPMOD,         // symbol@dtpmod
 185     VK_PPC_TPREL,          // symbol@tprel
 186     VK_PPC_TPREL_LO,       // symbol@tprel@l
 187     VK_PPC_TPREL_HI,       // symbol@tprel@h
 188     VK_PPC_TPREL_HA,       // symbol@tprel@ha
 189     VK_PPC_TPREL_HIGHER,   // symbol@tprel@higher
 190     VK_PPC_TPREL_HIGHERA,  // symbol@tprel@highera
 191     VK_PPC_TPREL_HIGHEST,  // symbol@tprel@highest
 192     VK_PPC_TPREL_HIGHESTA, // symbol@tprel@highesta
 193     VK_PPC_DTPREL,         // symbol@dtprel
 194     VK_PPC_DTPREL_LO,      // symbol@dtprel@l
 195     VK_PPC_DTPREL_HI,      // symbol@dtprel@h
 196     VK_PPC_DTPREL_HA,      // symbol@dtprel@ha
 197     VK_PPC_DTPREL_HIGHER,  // symbol@dtprel@higher
 198     VK_PPC_DTPREL_HIGHERA, // symbol@dtprel@highera
 199     VK_PPC_DTPREL_HIGHEST, // symbol@dtprel@highest
 200     VK_PPC_DTPREL_HIGHESTA,// symbol@dtprel@highesta
 201     VK_PPC_GOT_TPREL,      // symbol@got@tprel
 202     VK_PPC_GOT_TPREL_LO,   // symbol@got@tprel@l
 203     VK_PPC_GOT_TPREL_HI,   // symbol@got@tprel@h
 204     VK_PPC_GOT_TPREL_HA,   // symbol@got@tprel@ha
 205     VK_PPC_GOT_DTPREL,     // symbol@got@dtprel
 206     VK_PPC_GOT_DTPREL_LO,  // symbol@got@dtprel@l
 207     VK_PPC_GOT_DTPREL_HI,  // symbol@got@dtprel@h
 208     VK_PPC_GOT_DTPREL_HA,  // symbol@got@dtprel@ha
 209     VK_PPC_TLS,            // symbol@tls
 210     VK_PPC_GOT_TLSGD,      // symbol@got@tlsgd
 211     VK_PPC_GOT_TLSGD_LO,   // symbol@got@tlsgd@l
 212     VK_PPC_GOT_TLSGD_HI,   // symbol@got@tlsgd@h
 213     VK_PPC_GOT_TLSGD_HA,   // symbol@got@tlsgd@ha
 214     VK_PPC_TLSGD,          // symbol@tlsgd
 215     VK_PPC_GOT_TLSLD,      // symbol@got@tlsld
 216     VK_PPC_GOT_TLSLD_LO,   // symbol@got@tlsld@l
 217     VK_PPC_GOT_TLSLD_HI,   // symbol@got@tlsld@h
 218     VK_PPC_GOT_TLSLD_HA,   // symbol@got@tlsld@ha
 219     VK_PPC_TLSLD,          // symbol@tlsld
 220
 221     VK_Mips_GPREL,
 222     VK_Mips_GOT_CALL,
 223     VK_Mips_GOT16,
 224     VK_Mips_GOT,
 225     VK_Mips_ABS_HI,
 226     VK_Mips_ABS_LO,
 227     VK_Mips_TLSGD,
 228     VK_Mips_TLSLDM,
 229     VK_Mips_DTPREL_HI,
 230     VK_Mips_DTPREL_LO,
 231     VK_Mips_GOTTPREL,
 232     VK_Mips_TPREL_HI,
 233     VK_Mips_TPREL_LO,
 234     VK_Mips_GPOFF_HI,
 235     VK_Mips_GPOFF_LO,
 236     VK_Mips_GOT_DISP,
 237     VK_Mips_GOT_PAGE,
 238     VK_Mips_GOT_OFST,
 239     VK_Mips_HIGHER,
 240     VK_Mips_HIGHEST,
 241     VK_Mips_GOT_HI16,
 242     VK_Mips_GOT_LO16,
 243     VK_Mips_CALL_HI16,
 244     VK_Mips_CALL_LO16,
 245
 246     VK_COFF_IMGREL32 // symbol@imgrel (image-relative)
 247   };
 248
 249 private:
 250   /// The symbol being referenced.
 251   const MCSymbol *Symbol;
 252
 253   /// The symbol reference modifier.
 254   const VariantKind Kind;
 255
 256   /// MCAsmInfo that is used to print symbol variants correctly.
 257   const MCAsmInfo *MAI;
 258
 259   explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind,
 260                            const MCAsmInfo *_MAI)
 261     : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind), MAI(_MAI) {
 262     assert(Symbol);
 263     assert(MAI);
 264   }
 265
 266 public:
 267   /// @name Construction
 268   /// @{
 269
 270   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
 271     return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
 272   }
 273
 274   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
 275                                        MCContext &Ctx);
 276   static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
 277                                        MCContext &Ctx);
 278
 279   /// @}
 280   /// @name Accessors
 281   /// @{
 282
 283   const MCSymbol &getSymbol() const { return *Symbol; }
 284   const MCAsmInfo &getMCAsmInfo() const { return *MAI; }
 285
 286   VariantKind getKind() const { return Kind; }
 287
 288   /// @}
 289   /// @name Static Utility Functions
 290   /// @{
 291
 292   static StringRef getVariantKindName(VariantKind Kind);
 293
 294   static VariantKind getVariantKindForName(StringRef Name);
 295
 296   /// @}
 297
 298   static bool classof(const MCExpr *E) {
 299     return E->getKind() == MCExpr::SymbolRef;
 300   }
 301 };
 302
 303 /// MCUnaryExpr - Unary assembler expressions.
 304 class MCUnaryExpr : public MCExpr {
 305 public:
 306   enum Opcode {
 307     LNot,  ///< Logical negation.
 308     Minus, ///< Unary minus.
 309     Not,   ///< Bitwise negation.
 310     Plus   ///< Unary plus.
 311   };
 312
 313 private:
 314   Opcode Op;
 315   const MCExpr *Expr;
 316
 317   MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
 318     : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
 319
 320 public:
 321   /// @name Construction
 322   /// @{
 323
 324   static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
 325                                    MCContext &Ctx);
 326   static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
 327     return Create(LNot, Expr, Ctx);
 328   }
 329   static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
 330     return Create(Minus, Expr, Ctx);
 331   }
 332   static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
 333     return Create(Not, Expr, Ctx);
 334   }
 335   static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
 336     return Create(Plus, Expr, Ctx);
 337   }
 338
 339   /// @}
 340   /// @name Accessors
 341   /// @{
 342
 343   /// getOpcode - Get the kind of this unary expression.
 344   Opcode getOpcode() const { return Op; }
 345
 346   /// getSubExpr - Get the child of this unary expression.
 347   const MCExpr *getSubExpr() const { return Expr; }
 348
 349   /// @}
 350
 351   static bool classof(const MCExpr *E) {
 352     return E->getKind() == MCExpr::Unary;
 353   }
 354 };
 355
 356 /// MCBinaryExpr - Binary assembler expressions.
 357 class MCBinaryExpr : public MCExpr {
 358 public:
 359   enum Opcode {
 360     Add,  ///< Addition.
 361     And,  ///< Bitwise and.
 362     Div,  ///< Signed division.
 363     EQ,   ///< Equality comparison.
 364     GT,   ///< Signed greater than comparison (result is either 0 or some
 365           ///< target-specific non-zero value)
 366     GTE,  ///< Signed greater than or equal comparison (result is either 0 or
 367           ///< some target-specific non-zero value).
 368     LAnd, ///< Logical and.
 369     LOr,  ///< Logical or.
 370     LT,   ///< Signed less than comparison (result is either 0 or
 371           ///< some target-specific non-zero value).
 372     LTE,  ///< Signed less than or equal comparison (result is either 0 or
 373           ///< some target-specific non-zero value).
 374     Mod,  ///< Signed remainder.
 375     Mul,  ///< Multiplication.
 376     NE,   ///< Inequality comparison.
 377     Or,   ///< Bitwise or.
 378     Shl,  ///< Shift left.
 379     Shr,  ///< Shift right (arithmetic or logical, depending on target)
 380     Sub,  ///< Subtraction.
 381     Xor   ///< Bitwise exclusive or.
 382   };
 383
 384 private:
 385   Opcode Op;
 386   const MCExpr *LHS, *RHS;
 387
 388   MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
 389     : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
 390
 391 public:
 392   /// @name Construction
 393   /// @{
 394
 395   static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
 396                                     const MCExpr *RHS, MCContext &Ctx);
 397   static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
 398                                        MCContext &Ctx) {
 399     return Create(Add, LHS, RHS, Ctx);
 400   }
 401   static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
 402                                        MCContext &Ctx) {
 403     return Create(And, LHS, RHS, Ctx);
 404   }
 405   static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
 406                                        MCContext &Ctx) {
 407     return Create(Div, LHS, RHS, Ctx);
 408   }
 409   static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
 410                                       MCContext &Ctx) {
 411     return Create(EQ, LHS, RHS, Ctx);
 412   }
 413   static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
 414                                       MCContext &Ctx) {
 415     return Create(GT, LHS, RHS, Ctx);
 416   }
 417   static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
 418                                        MCContext &Ctx) {
 419     return Create(GTE, LHS, RHS, Ctx);
 420   }
 421   static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
 422                                         MCContext &Ctx) {
 423     return Create(LAnd, LHS, RHS, Ctx);
 424   }
 425   static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
 426                                        MCContext &Ctx) {
 427     return Create(LOr, LHS, RHS, Ctx);
 428   }
 429   static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
 430                                       MCContext &Ctx) {
 431     return Create(LT, LHS, RHS, Ctx);
 432   }
 433   static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
 434                                        MCContext &Ctx) {
 435     return Create(LTE, LHS, RHS, Ctx);
 436   }
 437   static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
 438                                        MCContext &Ctx) {
 439     return Create(Mod, LHS, RHS, Ctx);
 440   }
 441   static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
 442                                        MCContext &Ctx) {
 443     return Create(Mul, LHS, RHS, Ctx);
 444   }
 445   static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
 446                                       MCContext &Ctx) {
 447     return Create(NE, LHS, RHS, Ctx);
 448   }
 449   static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
 450                                       MCContext &Ctx) {
 451     return Create(Or, LHS, RHS, Ctx);
 452   }
 453   static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
 454                                        MCContext &Ctx) {
 455     return Create(Shl, LHS, RHS, Ctx);
 456   }
 457   static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
 458                                        MCContext &Ctx) {
 459     return Create(Shr, LHS, RHS, Ctx);
 460   }
 461   static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
 462                                        MCContext &Ctx) {
 463     return Create(Sub, LHS, RHS, Ctx);
 464   }
 465   static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
 466                                        MCContext &Ctx) {
 467     return Create(Xor, LHS, RHS, Ctx);
 468   }
 469
 470   /// @}
 471   /// @name Accessors
 472   /// @{
 473
 474   /// getOpcode - Get the kind of this binary expression.
 475   Opcode getOpcode() const { return Op; }
 476
 477   /// getLHS - Get the left-hand side expression of the binary operator.
 478   const MCExpr *getLHS() const { return LHS; }
 479
 480   /// getRHS - Get the right-hand side expression of the binary operator.
 481   const MCExpr *getRHS() const { return RHS; }
 482
 483   /// @}
 484
 485   static bool classof(const MCExpr *E) {
 486     return E->getKind() == MCExpr::Binary;
 487   }
 488 };
 489
 490 /// MCTargetExpr - This is an extension point for target-specific MCExpr
 491 /// subclasses to implement.
 492 ///
 493 /// NOTE: All subclasses are required to have trivial destructors because
 494 /// MCExprs are bump pointer allocated and not destructed.
 495 class MCTargetExpr : public MCExpr {
 496   virtual void anchor();
 497 protected:
 498   MCTargetExpr() : MCExpr(Target) {}
 499   virtual ~MCTargetExpr() {}
 500 public:
 501
 502   virtual void PrintImpl(raw_ostream &OS) const = 0;
 503   virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
 504                                          const MCAsmLayout *Layout) const = 0;
 505   virtual void AddValueSymbols(MCAssembler *) const = 0;
 506   virtual const MCSection *FindAssociatedSection() const = 0;
 507
 508   virtual void fixELFSymbolsInTLSFixups(MCAssembler &) const = 0;
 509
 510   static bool classof(const MCExpr *E) {
 511     return E->getKind() == MCExpr::Target;
 512   }
 513 };
 514
 515 } // end namespace llvm
 516
 517 #endif