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