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 MCAsmLayout;
  19 class MCAssembler;
  20 class MCContext;
  21 class MCSection;
  22 class MCSectionData;
  23 class MCSymbol;
  24 class MCValue;
  25 class raw_ostream;
  26 class StringRef;
  27 typedef DenseMap<const MCSectionData*, uint64_t> SectionAddrMap;
  28
  29 /// MCExpr - Base class for the full range of assembler expressions which are
  30 /// needed for parsing.
  31 class MCExpr {
  32 public:
  33   enum ExprKind {
  34     Binary,    ///< Binary expressions.
  35     Constant,  ///< Constant expressions.
  36     SymbolRef, ///< References to labels and assigned expressions.
  37     Unary,     ///< Unary expressions.
  38     Target     ///< Target specific expression.
  39   };
  40
  41 private:
  42   ExprKind Kind;
  43
  44   MCExpr(const MCExpr&) LLVM_DELETED_FUNCTION;
  45   void operator=(const MCExpr&) LLVM_DELETED_FUNCTION;
  46
  47   bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
  48                           const MCAsmLayout *Layout,
  49                           const SectionAddrMap *Addrs) const;
  50 protected:
  51   explicit MCExpr(ExprKind _Kind) : Kind(_Kind) {}
  52
  53   bool EvaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
  54                                  const MCAsmLayout *Layout,
  55                                  const SectionAddrMap *Addrs,
  56                                  bool InSet) const;
  57 public:
  58   /// @name Accessors
  59   /// @{
  60
  61   ExprKind getKind() const { return Kind; }
  62
  63   /// @}
  64   /// @name Utility Methods
  65   /// @{
  66
  67   void print(raw_ostream &OS) const;
  68   void dump() const;
  69
  70   /// @}
  71   /// @name Expression Evaluation
  72   /// @{
  73
  74   /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
  75   ///
  76   /// @param Res - The absolute value, if evaluation succeeds.
  77   /// @param Layout - The assembler layout object to use for evaluating symbol
  78   /// values. If not given, then only non-symbolic expressions will be
  79   /// evaluated.
  80   /// @result - True on success.
  81   bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout,
  82                           const SectionAddrMap &Addrs) const;
  83   bool EvaluateAsAbsolute(int64_t &Res) const;
  84   bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const;
  85   bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const;
  86
  87   /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
  88   /// value, i.e. an expression of the fixed form (a - b + constant).
  89   ///
  90   /// @param Res - The relocatable value, if evaluation succeeds.
  91   /// @param Layout - The assembler layout object to use for evaluating values.
  92   /// @result - True on success.
  93   bool EvaluateAsRelocatable(MCValue &Res, const MCAsmLayout &Layout) const;
  94
  95   /// FindAssociatedSection - Find the "associated section" for this expression,
  96   /// which is currently defined as the absolute section for constants, or
  97   /// otherwise the section associated with the first defined symbol in the
  98   /// expression.
  99   const MCSection *FindAssociatedSection() const;
 100
 101   /// @}
 102 };
 103
 104 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
 105   E.print(OS);
 106   return OS;
 107 }
 108
 109 //// MCConstantExpr - Represent a constant integer expression.
 110 class MCConstantExpr : public MCExpr {
 111   int64_t Value;
 112
 113   explicit MCConstantExpr(int64_t _Value)
 114     : MCExpr(MCExpr::Constant), Value(_Value) {}
 115
 116 public:
 117   /// @name Construction
 118   /// @{
 119
 120   static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
 121
 122   /// @}
 123   /// @name Accessors
 124   /// @{
 125
 126   int64_t getValue() const { return Value; }
 127
 128   /// @}
 129
 130   static bool classof(const MCExpr *E) {
 131     return E->getKind() == MCExpr::Constant;
 132   }
 133 };
 134
 135 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
 136 /// expression.
 137 ///
 138 /// A symbol reference in an expression may be a use of a label, a use of an
 139 /// assembler variable (defined constant), or constitute an implicit definition
 140 /// of the symbol as external.
 141 class MCSymbolRefExpr : public MCExpr {
 142 public:
 143   enum VariantKind {
 144     VK_None,
 145     VK_Invalid,
 146
 147     VK_GOT,
 148     VK_GOTOFF,
 149     VK_GOTPCREL,
 150     VK_GOTTPOFF,
 151     VK_INDNTPOFF,
 152     VK_NTPOFF,
 153     VK_GOTNTPOFF,
 154     VK_PLT,
 155     VK_TLSGD,
 156     VK_TLSLD,
 157     VK_TLSLDM,
 158     VK_TPOFF,
 159     VK_DTPOFF,
 160     VK_TLVP,      // Mach-O thread local variable relocation
 161     VK_SECREL,
 162     // FIXME: We'd really like to use the generic Kinds listed above for these.
 163     VK_ARM_PLT,   // ARM-style PLT references. i.e., (PLT) instead of @PLT
 164     VK_ARM_TLSGD, //   ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
 165     VK_ARM_GOT,
 166     VK_ARM_GOTOFF,
 167     VK_ARM_TPOFF,
 168     VK_ARM_GOTTPOFF,
 169     VK_ARM_TARGET1,
 170     VK_ARM_TARGET2,
 171
 172     VK_PPC_TOC,          // TOC base
 173     VK_PPC_TOC_ENTRY,    // TOC entry
 174     VK_PPC_DARWIN_HA16,  // ha16(symbol)
 175     VK_PPC_DARWIN_LO16,  // lo16(symbol)
 176     VK_PPC_GAS_HA16,     // symbol@ha
 177     VK_PPC_GAS_LO16,     // symbol@l
 178     VK_PPC_TPREL16_HA,   // symbol@tprel@ha
 179     VK_PPC_TPREL16_LO,   // symbol@tprel@l
 180     VK_PPC_TOC16_HA,     // symbol@toc@ha
 181     VK_PPC_TOC16_LO,     // symbol@toc@l
 182
 183     VK_Mips_GPREL,
 184     VK_Mips_GOT_CALL,
 185     VK_Mips_GOT16,
 186     VK_Mips_GOT,
 187     VK_Mips_ABS_HI,
 188     VK_Mips_ABS_LO,
 189     VK_Mips_TLSGD,
 190     VK_Mips_TLSLDM,
 191     VK_Mips_DTPREL_HI,
 192     VK_Mips_DTPREL_LO,
 193     VK_Mips_GOTTPREL,
 194     VK_Mips_TPREL_HI,
 195     VK_Mips_TPREL_LO,
 196     VK_Mips_GPOFF_HI,
 197     VK_Mips_GPOFF_LO,
 198     VK_Mips_GOT_DISP,
 199     VK_Mips_GOT_PAGE,
 200     VK_Mips_GOT_OFST,
 201     VK_Mips_HIGHER,
 202     VK_Mips_HIGHEST,
 203     VK_Mips_GOT_HI16,
 204     VK_Mips_GOT_LO16,
 205     VK_Mips_CALL_HI16,
 206     VK_Mips_CALL_LO16
 207   };
 208
 209 private:
 210   /// The symbol being referenced.
 211   const MCSymbol *Symbol;
 212
 213   /// The symbol reference modifier.
 214   const VariantKind Kind;
 215
 216   explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
 217     : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {
 218     assert(Symbol);
 219   }
 220
 221 public:
 222   /// @name Construction
 223   /// @{
 224
 225   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
 226     return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
 227   }
 228
 229   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
 230                                        MCContext &Ctx);
 231   static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
 232                                        MCContext &Ctx);
 233
 234   /// @}
 235   /// @name Accessors
 236   /// @{
 237
 238   const MCSymbol &getSymbol() const { return *Symbol; }
 239
 240   VariantKind getKind() const { return Kind; }
 241
 242   /// @}
 243   /// @name Static Utility Functions
 244   /// @{
 245
 246   static StringRef getVariantKindName(VariantKind Kind);
 247
 248   static VariantKind getVariantKindForName(StringRef Name);
 249
 250   /// @}
 251
 252   static bool classof(const MCExpr *E) {
 253     return E->getKind() == MCExpr::SymbolRef;
 254   }
 255 };
 256
 257 /// MCUnaryExpr - Unary assembler expressions.
 258 class MCUnaryExpr : public MCExpr {
 259 public:
 260   enum Opcode {
 261     LNot,  ///< Logical negation.
 262     Minus, ///< Unary minus.
 263     Not,   ///< Bitwise negation.
 264     Plus   ///< Unary plus.
 265   };
 266
 267 private:
 268   Opcode Op;
 269   const MCExpr *Expr;
 270
 271   MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
 272     : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
 273
 274 public:
 275   /// @name Construction
 276   /// @{
 277
 278   static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
 279                                    MCContext &Ctx);
 280   static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
 281     return Create(LNot, Expr, Ctx);
 282   }
 283   static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
 284     return Create(Minus, Expr, Ctx);
 285   }
 286   static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
 287     return Create(Not, Expr, Ctx);
 288   }
 289   static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
 290     return Create(Plus, Expr, Ctx);
 291   }
 292
 293   /// @}
 294   /// @name Accessors
 295   /// @{
 296
 297   /// getOpcode - Get the kind of this unary expression.
 298   Opcode getOpcode() const { return Op; }
 299
 300   /// getSubExpr - Get the child of this unary expression.
 301   const MCExpr *getSubExpr() const { return Expr; }
 302
 303   /// @}
 304
 305   static bool classof(const MCExpr *E) {
 306     return E->getKind() == MCExpr::Unary;
 307   }
 308 };
 309
 310 /// MCBinaryExpr - Binary assembler expressions.
 311 class MCBinaryExpr : public MCExpr {
 312 public:
 313   enum Opcode {
 314     Add,  ///< Addition.
 315     And,  ///< Bitwise and.
 316     Div,  ///< Signed division.
 317     EQ,   ///< Equality comparison.
 318     GT,   ///< Signed greater than comparison (result is either 0 or some
 319           ///< target-specific non-zero value)
 320     GTE,  ///< Signed greater than or equal comparison (result is either 0 or
 321           ///< some target-specific non-zero value).
 322     LAnd, ///< Logical and.
 323     LOr,  ///< Logical or.
 324     LT,   ///< Signed less than comparison (result is either 0 or
 325           ///< some target-specific non-zero value).
 326     LTE,  ///< Signed less than or equal comparison (result is either 0 or
 327           ///< some target-specific non-zero value).
 328     Mod,  ///< Signed remainder.
 329     Mul,  ///< Multiplication.
 330     NE,   ///< Inequality comparison.
 331     Or,   ///< Bitwise or.
 332     Shl,  ///< Shift left.
 333     Shr,  ///< Shift right (arithmetic or logical, depending on target)
 334     Sub,  ///< Subtraction.
 335     Xor   ///< Bitwise exclusive or.
 336   };
 337
 338 private:
 339   Opcode Op;
 340   const MCExpr *LHS, *RHS;
 341
 342   MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
 343     : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
 344
 345 public:
 346   /// @name Construction
 347   /// @{
 348
 349   static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
 350                                     const MCExpr *RHS, MCContext &Ctx);
 351   static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
 352                                        MCContext &Ctx) {
 353     return Create(Add, LHS, RHS, Ctx);
 354   }
 355   static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
 356                                        MCContext &Ctx) {
 357     return Create(And, LHS, RHS, Ctx);
 358   }
 359   static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
 360                                        MCContext &Ctx) {
 361     return Create(Div, LHS, RHS, Ctx);
 362   }
 363   static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
 364                                       MCContext &Ctx) {
 365     return Create(EQ, LHS, RHS, Ctx);
 366   }
 367   static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
 368                                       MCContext &Ctx) {
 369     return Create(GT, LHS, RHS, Ctx);
 370   }
 371   static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
 372                                        MCContext &Ctx) {
 373     return Create(GTE, LHS, RHS, Ctx);
 374   }
 375   static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
 376                                         MCContext &Ctx) {
 377     return Create(LAnd, LHS, RHS, Ctx);
 378   }
 379   static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
 380                                        MCContext &Ctx) {
 381     return Create(LOr, LHS, RHS, Ctx);
 382   }
 383   static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
 384                                       MCContext &Ctx) {
 385     return Create(LT, LHS, RHS, Ctx);
 386   }
 387   static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
 388                                        MCContext &Ctx) {
 389     return Create(LTE, LHS, RHS, Ctx);
 390   }
 391   static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
 392                                        MCContext &Ctx) {
 393     return Create(Mod, LHS, RHS, Ctx);
 394   }
 395   static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
 396                                        MCContext &Ctx) {
 397     return Create(Mul, LHS, RHS, Ctx);
 398   }
 399   static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
 400                                       MCContext &Ctx) {
 401     return Create(NE, LHS, RHS, Ctx);
 402   }
 403   static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
 404                                       MCContext &Ctx) {
 405     return Create(Or, LHS, RHS, Ctx);
 406   }
 407   static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
 408                                        MCContext &Ctx) {
 409     return Create(Shl, LHS, RHS, Ctx);
 410   }
 411   static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
 412                                        MCContext &Ctx) {
 413     return Create(Shr, LHS, RHS, Ctx);
 414   }
 415   static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
 416                                        MCContext &Ctx) {
 417     return Create(Sub, LHS, RHS, Ctx);
 418   }
 419   static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
 420                                        MCContext &Ctx) {
 421     return Create(Xor, LHS, RHS, Ctx);
 422   }
 423
 424   /// @}
 425   /// @name Accessors
 426   /// @{
 427
 428   /// getOpcode - Get the kind of this binary expression.
 429   Opcode getOpcode() const { return Op; }
 430
 431   /// getLHS - Get the left-hand side expression of the binary operator.
 432   const MCExpr *getLHS() const { return LHS; }
 433
 434   /// getRHS - Get the right-hand side expression of the binary operator.
 435   const MCExpr *getRHS() const { return RHS; }
 436
 437   /// @}
 438
 439   static bool classof(const MCExpr *E) {
 440     return E->getKind() == MCExpr::Binary;
 441   }
 442 };
 443
 444 /// MCTargetExpr - This is an extension point for target-specific MCExpr
 445 /// subclasses to implement.
 446 ///
 447 /// NOTE: All subclasses are required to have trivial destructors because
 448 /// MCExprs are bump pointer allocated and not destructed.
 449 class MCTargetExpr : public MCExpr {
 450   virtual void anchor();
 451 protected:
 452   MCTargetExpr() : MCExpr(Target) {}
 453   virtual ~MCTargetExpr() {}
 454 public:
 455
 456   virtual void PrintImpl(raw_ostream &OS) const = 0;
 457   virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
 458                                          const MCAsmLayout *Layout) const = 0;
 459   virtual void AddValueSymbols(MCAssembler *) const = 0;
 460   virtual const MCSection *FindAssociatedSection() const = 0;
 461
 462   static bool classof(const MCExpr *E) {
 463     return E->getKind() == MCExpr::Target;
 464   }
 465 };
 466
 467 } // end namespace llvm
 468
 469 #endif