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