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/Support/Casting.h"
  14 #include "llvm/System/DataTypes.h"
  15
  16 namespace llvm {
  17 class MCAsmInfo;
  18 class MCAsmLayout;
  19 class MCContext;
  20 class MCSymbol;
  21 class MCValue;
  22 class raw_ostream;
  23 class StringRef;
  24
  25 /// MCExpr - Base class for the full range of assembler expressions which are
  26 /// needed for parsing.
  27 class MCExpr {
  28 public:
  29   enum ExprKind {
  30     Binary,    ///< Binary expressions.
  31     Constant,  ///< Constant expressions.
  32     SymbolRef, ///< References to labels and assigned expressions.
  33     Unary,     ///< Unary expressions.
  34     Target     ///< Target specific expression.
  35   };
  36
  37 private:
  38   ExprKind Kind;
  39
  40   MCExpr(const MCExpr&); // DO NOT IMPLEMENT
  41   void operator=(const MCExpr&); // DO NOT IMPLEMENT
  42
  43 protected:
  44   explicit MCExpr(ExprKind _Kind) : Kind(_Kind) {}
  45
  46 public:
  47   /// @name Accessors
  48   /// @{
  49
  50   ExprKind getKind() const { return Kind; }
  51
  52   /// @}
  53   /// @name Utility Methods
  54   /// @{
  55
  56   void print(raw_ostream &OS) const;
  57   void dump() const;
  58
  59   /// @}
  60   /// @name Expression Evaluation
  61   /// @{
  62
  63   /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
  64   ///
  65   /// @param Res - The absolute value, if evaluation succeeds.
  66   /// @param Layout - The assembler layout object to use for evaluating symbol
  67   /// values. If not given, then only non-symbolic expressions will be
  68   /// evaluated.
  69   /// @result - True on success.
  70   bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout *Layout = 0) const;
  71
  72   /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
  73   /// value, i.e. an expression of the fixed form (a - b + constant).
  74   ///
  75   /// @param Res - The relocatable value, if evaluation succeeds.
  76   /// @param Layout - The assembler layout object to use for evaluating values.
  77   /// @result - True on success.
  78   bool EvaluateAsRelocatable(MCValue &Res, const MCAsmLayout *Layout = 0) const;
  79
  80   /// @}
  81
  82   static bool classof(const MCExpr *) { return true; }
  83 };
  84
  85 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
  86   E.print(OS);
  87   return OS;
  88 }
  89
  90 //// MCConstantExpr - Represent a constant integer expression.
  91 class MCConstantExpr : public MCExpr {
  92   int64_t Value;
  93
  94   explicit MCConstantExpr(int64_t _Value)
  95     : MCExpr(MCExpr::Constant), Value(_Value) {}
  96
  97 public:
  98   /// @name Construction
  99   /// @{
 100
 101   static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
 102
 103   /// @}
 104   /// @name Accessors
 105   /// @{
 106
 107   int64_t getValue() const { return Value; }
 108
 109   /// @}
 110
 111   static bool classof(const MCExpr *E) {
 112     return E->getKind() == MCExpr::Constant;
 113   }
 114   static bool classof(const MCConstantExpr *) { return true; }
 115 };
 116
 117 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
 118 /// expression.
 119 ///
 120 /// A symbol reference in an expression may be a use of a label, a use of an
 121 /// assembler variable (defined constant), or constitute an implicit definition
 122 /// of the symbol as external.
 123 class MCSymbolRefExpr : public MCExpr {
 124 public:
 125   enum VariantKind {
 126     VK_None,
 127     VK_Invalid,
 128
 129     VK_GOT,
 130     VK_GOTOFF,
 131     VK_GOTPCREL,
 132     VK_GOTTPOFF,
 133     VK_INDNTPOFF,
 134     VK_NTPOFF,
 135     VK_PLT,
 136     VK_TLSGD,
 137     VK_TPOFF,
 138     VK_ARM_HI16, // The R_ARM_MOVT_ABS relocation (:upper16: in the asm file)
 139     VK_ARM_LO16 // The R_ARM_MOVW_ABS_NC relocation (:lower16: in the asm file)
 140   };
 141
 142 private:
 143   /// The symbol being referenced.
 144   const MCSymbol *Symbol;
 145
 146   /// The symbol reference modifier.
 147   const VariantKind Kind;
 148
 149   explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
 150     : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {}
 151
 152 public:
 153   /// @name Construction
 154   /// @{
 155
 156   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
 157     return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
 158   }
 159
 160   static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
 161                                        MCContext &Ctx);
 162   static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
 163                                        MCContext &Ctx);
 164
 165   /// @}
 166   /// @name Accessors
 167   /// @{
 168
 169   const MCSymbol &getSymbol() const { return *Symbol; }
 170
 171   VariantKind getKind() const { return Kind; }
 172
 173   /// @}
 174   /// @name Static Utility Functions
 175   /// @{
 176
 177   static StringRef getVariantKindName(VariantKind Kind);
 178
 179   static VariantKind getVariantKindForName(StringRef Name);
 180
 181   /// @}
 182
 183   static bool classof(const MCExpr *E) {
 184     return E->getKind() == MCExpr::SymbolRef;
 185   }
 186   static bool classof(const MCSymbolRefExpr *) { return true; }
 187 };
 188
 189 /// MCUnaryExpr - Unary assembler expressions.
 190 class MCUnaryExpr : public MCExpr {
 191 public:
 192   enum Opcode {
 193     LNot,  ///< Logical negation.
 194     Minus, ///< Unary minus.
 195     Not,   ///< Bitwise negation.
 196     Plus   ///< Unary plus.
 197   };
 198
 199 private:
 200   Opcode Op;
 201   const MCExpr *Expr;
 202
 203   MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
 204     : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
 205
 206 public:
 207   /// @name Construction
 208   /// @{
 209
 210   static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
 211                                    MCContext &Ctx);
 212   static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
 213     return Create(LNot, Expr, Ctx);
 214   }
 215   static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
 216     return Create(Minus, Expr, Ctx);
 217   }
 218   static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
 219     return Create(Not, Expr, Ctx);
 220   }
 221   static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
 222     return Create(Plus, Expr, Ctx);
 223   }
 224
 225   /// @}
 226   /// @name Accessors
 227   /// @{
 228
 229   /// getOpcode - Get the kind of this unary expression.
 230   Opcode getOpcode() const { return Op; }
 231
 232   /// getSubExpr - Get the child of this unary expression.
 233   const MCExpr *getSubExpr() const { return Expr; }
 234
 235   /// @}
 236
 237   static bool classof(const MCExpr *E) {
 238     return E->getKind() == MCExpr::Unary;
 239   }
 240   static bool classof(const MCUnaryExpr *) { return true; }
 241 };
 242
 243 /// MCBinaryExpr - Binary assembler expressions.
 244 class MCBinaryExpr : public MCExpr {
 245 public:
 246   enum Opcode {
 247     Add,  ///< Addition.
 248     And,  ///< Bitwise and.
 249     Div,  ///< Signed division.
 250     EQ,   ///< Equality comparison.
 251     GT,   ///< Signed greater than comparison (result is either 0 or some
 252           ///< target-specific non-zero value)
 253     GTE,  ///< Signed greater than or equal comparison (result is either 0 or
 254           ///< some target-specific non-zero value).
 255     LAnd, ///< Logical and.
 256     LOr,  ///< Logical or.
 257     LT,   ///< Signed less than comparison (result is either 0 or
 258           ///< some target-specific non-zero value).
 259     LTE,  ///< Signed less than or equal comparison (result is either 0 or
 260           ///< some target-specific non-zero value).
 261     Mod,  ///< Signed remainder.
 262     Mul,  ///< Multiplication.
 263     NE,   ///< Inequality comparison.
 264     Or,   ///< Bitwise or.
 265     Shl,  ///< Shift left.
 266     Shr,  ///< Shift right (arithmetic or logical, depending on target)
 267     Sub,  ///< Subtraction.
 268     Xor   ///< Bitwise exclusive or.
 269   };
 270
 271 private:
 272   Opcode Op;
 273   const MCExpr *LHS, *RHS;
 274
 275   MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
 276     : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
 277
 278 public:
 279   /// @name Construction
 280   /// @{
 281
 282   static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
 283                                     const MCExpr *RHS, MCContext &Ctx);
 284   static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
 285                                        MCContext &Ctx) {
 286     return Create(Add, LHS, RHS, Ctx);
 287   }
 288   static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
 289                                        MCContext &Ctx) {
 290     return Create(And, LHS, RHS, Ctx);
 291   }
 292   static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
 293                                        MCContext &Ctx) {
 294     return Create(Div, LHS, RHS, Ctx);
 295   }
 296   static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
 297                                       MCContext &Ctx) {
 298     return Create(EQ, LHS, RHS, Ctx);
 299   }
 300   static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
 301                                       MCContext &Ctx) {
 302     return Create(GT, LHS, RHS, Ctx);
 303   }
 304   static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
 305                                        MCContext &Ctx) {
 306     return Create(GTE, LHS, RHS, Ctx);
 307   }
 308   static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
 309                                         MCContext &Ctx) {
 310     return Create(LAnd, LHS, RHS, Ctx);
 311   }
 312   static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
 313                                        MCContext &Ctx) {
 314     return Create(LOr, LHS, RHS, Ctx);
 315   }
 316   static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
 317                                       MCContext &Ctx) {
 318     return Create(LT, LHS, RHS, Ctx);
 319   }
 320   static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
 321                                        MCContext &Ctx) {
 322     return Create(LTE, LHS, RHS, Ctx);
 323   }
 324   static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
 325                                        MCContext &Ctx) {
 326     return Create(Mod, LHS, RHS, Ctx);
 327   }
 328   static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
 329                                        MCContext &Ctx) {
 330     return Create(Mul, LHS, RHS, Ctx);
 331   }
 332   static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
 333                                       MCContext &Ctx) {
 334     return Create(NE, LHS, RHS, Ctx);
 335   }
 336   static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
 337                                       MCContext &Ctx) {
 338     return Create(Or, LHS, RHS, Ctx);
 339   }
 340   static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
 341                                        MCContext &Ctx) {
 342     return Create(Shl, LHS, RHS, Ctx);
 343   }
 344   static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
 345                                        MCContext &Ctx) {
 346     return Create(Shr, LHS, RHS, Ctx);
 347   }
 348   static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
 349                                        MCContext &Ctx) {
 350     return Create(Sub, LHS, RHS, Ctx);
 351   }
 352   static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
 353                                        MCContext &Ctx) {
 354     return Create(Xor, LHS, RHS, Ctx);
 355   }
 356
 357   /// @}
 358   /// @name Accessors
 359   /// @{
 360
 361   /// getOpcode - Get the kind of this binary expression.
 362   Opcode getOpcode() const { return Op; }
 363
 364   /// getLHS - Get the left-hand side expression of the binary operator.
 365   const MCExpr *getLHS() const { return LHS; }
 366
 367   /// getRHS - Get the right-hand side expression of the binary operator.
 368   const MCExpr *getRHS() const { return RHS; }
 369
 370   /// @}
 371
 372   static bool classof(const MCExpr *E) {
 373     return E->getKind() == MCExpr::Binary;
 374   }
 375   static bool classof(const MCBinaryExpr *) { return true; }
 376 };
 377
 378 /// MCTargetExpr - This is an extension point for target-specific MCExpr
 379 /// subclasses to implement.
 380 ///
 381 /// NOTE: All subclasses are required to have trivial destructors because
 382 /// MCExprs are bump pointer allocated and not destructed.
 383 class MCTargetExpr : public MCExpr {
 384   virtual void Anchor();
 385 protected:
 386   MCTargetExpr() : MCExpr(Target) {}
 387   virtual ~MCTargetExpr() {}
 388 public:
 389
 390   virtual void PrintImpl(raw_ostream &OS) const = 0;
 391   virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
 392                                          const MCAsmLayout *Layout) const = 0;
 393
 394
 395   static bool classof(const MCExpr *E) {
 396     return E->getKind() == MCExpr::Target;
 397   }
 398   static bool classof(const MCTargetExpr *) { return true; }
 399 };
 400
 401 } // end namespace llvm
 402
 403 #endif