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