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