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