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 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 MCAsmLayout *Layout,
  48                           const SectionAddrMap *Addrs) const;
  49 protected:
  50   explicit MCExpr(ExprKind _Kind) : Kind(_Kind) {}
  51
  52   bool EvaluateAsRelocatableImpl(MCValue &Res, const MCAsmLayout *Layout,
  53                                  const SectionAddrMap *Addrs,
  54                                  bool InSet) const;
  55 public:
  56   /// @name Accessors
  57   /// @{
  58
  59   ExprKind getKind() const { return Kind; }
  60
  61   /// @}
  62   /// @name Utility Methods
  63   /// @{
  64
  65   void print(raw_ostream &OS) const;
  66   void dump() const;
  67
  68   /// @}
  69   /// @name Expression Evaluation
  70   /// @{
  71
  72   /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
  73   ///
  74   /// @param Res - The absolute value, if evaluation succeeds.
  75   /// @param Layout - The assembler layout object to use for evaluating symbol
  76   /// values. If not given, then only non-symbolic expressions will be
  77   /// evaluated.
  78   /// @result - True on success.
  79   bool EvaluateAsAbsolute(int64_t &Res) const {
  80     return EvaluateAsAbsolute(Res, 0, 0);
  81   }
  82   bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const{
  83     return EvaluateAsAbsolute(Res, &Layout, 0);
  84   }
  85   bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout,
  86                           const SectionAddrMap &Addrs) const {
  87     return EvaluateAsAbsolute(Res, &Layout, &Addrs);
  88   }
  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 = 0) const;
  97
  98   /// @}
  99
 100   static bool classof(const MCExpr *) { return true; }
 101 };
 102
 103 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
 104   E.print(OS);
 105   return OS;
 106 }
 107
 108 //// MCConstantExpr - Represent a constant integer expression.
 109 class MCConstantExpr : public MCExpr {
 110   int64_t Value;
 111
 112   explicit MCConstantExpr(int64_t _Value)
 113     : MCExpr(MCExpr::Constant), Value(_Value) {}
 114
 115 public:
 116   /// @name Construction
 117   /// @{
 118
 119   static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
 120
 121   /// @}
 122   /// @name Accessors
 123   /// @{
 124
 125   int64_t getValue() const { return Value; }
 126
 127   /// @}
 128
 129   static bool classof(const MCExpr *E) {
 130     return E->getKind() == MCExpr::Constant;
 131   }
 132   static bool classof(const MCConstantExpr *) { return true; }
 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_ARM_HI16,  // The R_ARM_MOVT_ABS relocation (:upper16: in the .s file)
 162     VK_ARM_LO16,  // The R_ARM_MOVW_ABS_NC relocation (:lower16: in the .w file)
 163     // FIXME: We'd really like to use the generic Kinds listed above for these.
 164     VK_ARM_PLT,   // ARM-style PLT references. i.e., (PLT) instead of @PLT
 165     VK_ARM_TLSGD, //   ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
 166     VK_ARM_GOT,
 167     VK_ARM_GOTOFF,
 168     VK_ARM_TPOFF,
 169     VK_ARM_GOTTPOFF,
 170
 171     VK_PPC_TOC,
 172     VK_PPC_HA16,  // ha16(symbol)
 173     VK_PPC_LO16   // lo16(symbol)
 174   };
 175
 176 private:
 177   /// The symbol being referenced.
 178   const MCSymbol *Symbol;
 179
 180   /// The symbol reference modifier.
 181   const VariantKind Kind;
 182
 183   explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
 184     : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {}
 185
 186 public:
 187   /// @name Construction
 188   /// @{
 189
 190   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
 191     return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
 192   }
 193
 194   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
 195                                        MCContext &Ctx);
 196   static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
 197                                        MCContext &Ctx);
 198
 199   /// @}
 200   /// @name Accessors
 201   /// @{
 202
 203   const MCSymbol &getSymbol() const { return *Symbol; }
 204
 205   VariantKind getKind() const { return Kind; }
 206
 207   /// @}
 208   /// @name Static Utility Functions
 209   /// @{
 210
 211   static StringRef getVariantKindName(VariantKind Kind);
 212
 213   static VariantKind getVariantKindForName(StringRef Name);
 214
 215   /// @}
 216
 217   static bool classof(const MCExpr *E) {
 218     return E->getKind() == MCExpr::SymbolRef;
 219   }
 220   static bool classof(const MCSymbolRefExpr *) { return true; }
 221 };
 222
 223 /// MCUnaryExpr - Unary assembler expressions.
 224 class MCUnaryExpr : public MCExpr {
 225 public:
 226   enum Opcode {
 227     LNot,  ///< Logical negation.
 228     Minus, ///< Unary minus.
 229     Not,   ///< Bitwise negation.
 230     Plus   ///< Unary plus.
 231   };
 232
 233 private:
 234   Opcode Op;
 235   const MCExpr *Expr;
 236
 237   MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
 238     : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
 239
 240 public:
 241   /// @name Construction
 242   /// @{
 243
 244   static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
 245                                    MCContext &Ctx);
 246   static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
 247     return Create(LNot, Expr, Ctx);
 248   }
 249   static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
 250     return Create(Minus, Expr, Ctx);
 251   }
 252   static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
 253     return Create(Not, Expr, Ctx);
 254   }
 255   static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
 256     return Create(Plus, Expr, Ctx);
 257   }
 258
 259   /// @}
 260   /// @name Accessors
 261   /// @{
 262
 263   /// getOpcode - Get the kind of this unary expression.
 264   Opcode getOpcode() const { return Op; }
 265
 266   /// getSubExpr - Get the child of this unary expression.
 267   const MCExpr *getSubExpr() const { return Expr; }
 268
 269   /// @}
 270
 271   static bool classof(const MCExpr *E) {
 272     return E->getKind() == MCExpr::Unary;
 273   }
 274   static bool classof(const MCUnaryExpr *) { return true; }
 275 };
 276
 277 /// MCBinaryExpr - Binary assembler expressions.
 278 class MCBinaryExpr : public MCExpr {
 279 public:
 280   enum Opcode {
 281     Add,  ///< Addition.
 282     And,  ///< Bitwise and.
 283     Div,  ///< Signed division.
 284     EQ,   ///< Equality comparison.
 285     GT,   ///< Signed greater than comparison (result is either 0 or some
 286           ///< target-specific non-zero value)
 287     GTE,  ///< Signed greater than or equal comparison (result is either 0 or
 288           ///< some target-specific non-zero value).
 289     LAnd, ///< Logical and.
 290     LOr,  ///< Logical or.
 291     LT,   ///< Signed less than comparison (result is either 0 or
 292           ///< some target-specific non-zero value).
 293     LTE,  ///< Signed less than or equal comparison (result is either 0 or
 294           ///< some target-specific non-zero value).
 295     Mod,  ///< Signed remainder.
 296     Mul,  ///< Multiplication.
 297     NE,   ///< Inequality comparison.
 298     Or,   ///< Bitwise or.
 299     Shl,  ///< Shift left.
 300     Shr,  ///< Shift right (arithmetic or logical, depending on target)
 301     Sub,  ///< Subtraction.
 302     Xor   ///< Bitwise exclusive or.
 303   };
 304
 305 private:
 306   Opcode Op;
 307   const MCExpr *LHS, *RHS;
 308
 309   MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
 310     : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
 311
 312 public:
 313   /// @name Construction
 314   /// @{
 315
 316   static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
 317                                     const MCExpr *RHS, MCContext &Ctx);
 318   static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
 319                                        MCContext &Ctx) {
 320     return Create(Add, LHS, RHS, Ctx);
 321   }
 322   static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
 323                                        MCContext &Ctx) {
 324     return Create(And, LHS, RHS, Ctx);
 325   }
 326   static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
 327                                        MCContext &Ctx) {
 328     return Create(Div, LHS, RHS, Ctx);
 329   }
 330   static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
 331                                       MCContext &Ctx) {
 332     return Create(EQ, LHS, RHS, Ctx);
 333   }
 334   static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
 335                                       MCContext &Ctx) {
 336     return Create(GT, LHS, RHS, Ctx);
 337   }
 338   static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
 339                                        MCContext &Ctx) {
 340     return Create(GTE, LHS, RHS, Ctx);
 341   }
 342   static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
 343                                         MCContext &Ctx) {
 344     return Create(LAnd, LHS, RHS, Ctx);
 345   }
 346   static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
 347                                        MCContext &Ctx) {
 348     return Create(LOr, LHS, RHS, Ctx);
 349   }
 350   static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
 351                                       MCContext &Ctx) {
 352     return Create(LT, LHS, RHS, Ctx);
 353   }
 354   static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
 355                                        MCContext &Ctx) {
 356     return Create(LTE, LHS, RHS, Ctx);
 357   }
 358   static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
 359                                        MCContext &Ctx) {
 360     return Create(Mod, LHS, RHS, Ctx);
 361   }
 362   static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
 363                                        MCContext &Ctx) {
 364     return Create(Mul, LHS, RHS, Ctx);
 365   }
 366   static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
 367                                       MCContext &Ctx) {
 368     return Create(NE, LHS, RHS, Ctx);
 369   }
 370   static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
 371                                       MCContext &Ctx) {
 372     return Create(Or, LHS, RHS, Ctx);
 373   }
 374   static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
 375                                        MCContext &Ctx) {
 376     return Create(Shl, LHS, RHS, Ctx);
 377   }
 378   static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
 379                                        MCContext &Ctx) {
 380     return Create(Shr, LHS, RHS, Ctx);
 381   }
 382   static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
 383                                        MCContext &Ctx) {
 384     return Create(Sub, LHS, RHS, Ctx);
 385   }
 386   static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
 387                                        MCContext &Ctx) {
 388     return Create(Xor, LHS, RHS, Ctx);
 389   }
 390
 391   /// @}
 392   /// @name Accessors
 393   /// @{
 394
 395   /// getOpcode - Get the kind of this binary expression.
 396   Opcode getOpcode() const { return Op; }
 397
 398   /// getLHS - Get the left-hand side expression of the binary operator.
 399   const MCExpr *getLHS() const { return LHS; }
 400
 401   /// getRHS - Get the right-hand side expression of the binary operator.
 402   const MCExpr *getRHS() const { return RHS; }
 403
 404   /// @}
 405
 406   static bool classof(const MCExpr *E) {
 407     return E->getKind() == MCExpr::Binary;
 408   }
 409   static bool classof(const MCBinaryExpr *) { return true; }
 410 };
 411
 412 /// MCTargetExpr - This is an extension point for target-specific MCExpr
 413 /// subclasses to implement.
 414 ///
 415 /// NOTE: All subclasses are required to have trivial destructors because
 416 /// MCExprs are bump pointer allocated and not destructed.
 417 class MCTargetExpr : public MCExpr {
 418   virtual void Anchor();
 419 protected:
 420   MCTargetExpr() : MCExpr(Target) {}
 421   virtual ~MCTargetExpr() {}
 422 public:
 423
 424   virtual void PrintImpl(raw_ostream &OS) const = 0;
 425   virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
 426                                          const MCAsmLayout *Layout) const = 0;
 427
 428
 429   static bool classof(const MCExpr *E) {
 430     return E->getKind() == MCExpr::Target;
 431   }
 432   static bool classof(const MCTargetExpr *) { return true; }
 433 };
 434
 435 } // end namespace llvm
 436
 437 #endif