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