1 //===- MCExpr.h - Assembly Level Expressions --------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_MC_MCEXPR_H
11 #define LLVM_MC_MCEXPR_H
13 #include "llvm/ADT/DenseMap.h"
14 #include "llvm/Support/Casting.h"
15 #include "llvm/Support/DataTypes.h"
27 typedef DenseMap<const MCSectionData*, uint64_t> SectionAddrMap;
29 /// MCExpr - Base class for the full range of assembler expressions which are
30 /// needed for parsing.
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.
44 MCExpr(const MCExpr&) LLVM_DELETED_FUNCTION;
45 void operator=(const MCExpr&) LLVM_DELETED_FUNCTION;
47 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
48 const MCAsmLayout *Layout,
49 const SectionAddrMap *Addrs) const;
51 explicit MCExpr(ExprKind _Kind) : Kind(_Kind) {}
53 bool EvaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
54 const MCAsmLayout *Layout,
55 const SectionAddrMap *Addrs,
61 ExprKind getKind() const { return Kind; }
64 /// @name Utility Methods
67 void print(raw_ostream &OS) const;
71 /// @name Expression Evaluation
74 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
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
80 /// @result - True on success.
81 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout,
82 const SectionAddrMap &Addrs) const;
83 bool EvaluateAsAbsolute(int64_t &Res) const;
84 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const;
85 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const;
87 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
88 /// value, i.e. an expression of the fixed form (a - b + constant).
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) const;
95 /// FindAssociatedSection - Find the "associated section" for this expression,
96 /// which is currently defined as the absolute section for constants, or
97 /// otherwise the section associated with the first defined symbol in the
99 const MCSection *FindAssociatedSection() const;
104 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
109 //// MCConstantExpr - Represent a constant integer expression.
110 class MCConstantExpr : public MCExpr {
113 explicit MCConstantExpr(int64_t _Value)
114 : MCExpr(MCExpr::Constant), Value(_Value) {}
117 /// @name Construction
120 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
126 int64_t getValue() const { return Value; }
130 static bool classof(const MCExpr *E) {
131 return E->getKind() == MCExpr::Constant;
135 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
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 {
160 VK_TLVP, // Mach-O thread local variable relocation
162 // FIXME: We'd really like to use the generic Kinds listed above for these.
163 VK_ARM_PLT, // ARM-style PLT references. i.e., (PLT) instead of @PLT
164 VK_ARM_TLSGD, // ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
172 VK_PPC_TOC, // TOC base
173 VK_PPC_TOC_ENTRY, // TOC entry
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 VK_PPC_TPREL16_HA, // symbol@tprel@ha
179 VK_PPC_TPREL16_LO, // symbol@tprel@l
180 VK_PPC_TOC16_HA, // symbol@toc@ha
181 VK_PPC_TOC16_LO, // symbol@toc@l
182 VK_PPC_GOT_TPREL16_DS, // symbol@got@tprel
183 VK_PPC_TLS, // symbol@tls
212 /// The symbol being referenced.
213 const MCSymbol *Symbol;
215 /// The symbol reference modifier.
216 const VariantKind Kind;
218 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
219 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {
224 /// @name Construction
227 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
228 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
231 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
233 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
240 const MCSymbol &getSymbol() const { return *Symbol; }
242 VariantKind getKind() const { return Kind; }
245 /// @name Static Utility Functions
248 static StringRef getVariantKindName(VariantKind Kind);
250 static VariantKind getVariantKindForName(StringRef Name);
254 static bool classof(const MCExpr *E) {
255 return E->getKind() == MCExpr::SymbolRef;
259 /// MCUnaryExpr - Unary assembler expressions.
260 class MCUnaryExpr : public MCExpr {
263 LNot, ///< Logical negation.
264 Minus, ///< Unary minus.
265 Not, ///< Bitwise negation.
266 Plus ///< Unary plus.
273 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
274 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
277 /// @name Construction
280 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
282 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
283 return Create(LNot, Expr, Ctx);
285 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
286 return Create(Minus, Expr, Ctx);
288 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
289 return Create(Not, Expr, Ctx);
291 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
292 return Create(Plus, Expr, Ctx);
299 /// getOpcode - Get the kind of this unary expression.
300 Opcode getOpcode() const { return Op; }
302 /// getSubExpr - Get the child of this unary expression.
303 const MCExpr *getSubExpr() const { return Expr; }
307 static bool classof(const MCExpr *E) {
308 return E->getKind() == MCExpr::Unary;
312 /// MCBinaryExpr - Binary assembler expressions.
313 class MCBinaryExpr : public MCExpr {
317 And, ///< Bitwise and.
318 Div, ///< Signed division.
319 EQ, ///< Equality comparison.
320 GT, ///< Signed greater than comparison (result is either 0 or some
321 ///< target-specific non-zero value)
322 GTE, ///< Signed greater than or equal comparison (result is either 0 or
323 ///< some target-specific non-zero value).
324 LAnd, ///< Logical and.
325 LOr, ///< Logical or.
326 LT, ///< Signed less than comparison (result is either 0 or
327 ///< some target-specific non-zero value).
328 LTE, ///< Signed less than or equal comparison (result is either 0 or
329 ///< some target-specific non-zero value).
330 Mod, ///< Signed remainder.
331 Mul, ///< Multiplication.
332 NE, ///< Inequality comparison.
334 Shl, ///< Shift left.
335 Shr, ///< Shift right (arithmetic or logical, depending on target)
336 Sub, ///< Subtraction.
337 Xor ///< Bitwise exclusive or.
342 const MCExpr *LHS, *RHS;
344 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
345 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
348 /// @name Construction
351 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
352 const MCExpr *RHS, MCContext &Ctx);
353 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
355 return Create(Add, LHS, RHS, Ctx);
357 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
359 return Create(And, LHS, RHS, Ctx);
361 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
363 return Create(Div, LHS, RHS, Ctx);
365 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
367 return Create(EQ, LHS, RHS, Ctx);
369 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
371 return Create(GT, LHS, RHS, Ctx);
373 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
375 return Create(GTE, LHS, RHS, Ctx);
377 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
379 return Create(LAnd, LHS, RHS, Ctx);
381 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
383 return Create(LOr, LHS, RHS, Ctx);
385 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
387 return Create(LT, LHS, RHS, Ctx);
389 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
391 return Create(LTE, LHS, RHS, Ctx);
393 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
395 return Create(Mod, LHS, RHS, Ctx);
397 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
399 return Create(Mul, LHS, RHS, Ctx);
401 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
403 return Create(NE, LHS, RHS, Ctx);
405 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
407 return Create(Or, LHS, RHS, Ctx);
409 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
411 return Create(Shl, LHS, RHS, Ctx);
413 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
415 return Create(Shr, LHS, RHS, Ctx);
417 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
419 return Create(Sub, LHS, RHS, Ctx);
421 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
423 return Create(Xor, LHS, RHS, Ctx);
430 /// getOpcode - Get the kind of this binary expression.
431 Opcode getOpcode() const { return Op; }
433 /// getLHS - Get the left-hand side expression of the binary operator.
434 const MCExpr *getLHS() const { return LHS; }
436 /// getRHS - Get the right-hand side expression of the binary operator.
437 const MCExpr *getRHS() const { return RHS; }
441 static bool classof(const MCExpr *E) {
442 return E->getKind() == MCExpr::Binary;
446 /// MCTargetExpr - This is an extension point for target-specific MCExpr
447 /// subclasses to implement.
449 /// NOTE: All subclasses are required to have trivial destructors because
450 /// MCExprs are bump pointer allocated and not destructed.
451 class MCTargetExpr : public MCExpr {
452 virtual void anchor();
454 MCTargetExpr() : MCExpr(Target) {}
455 virtual ~MCTargetExpr() {}
458 virtual void PrintImpl(raw_ostream &OS) const = 0;
459 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
460 const MCAsmLayout *Layout) const = 0;
461 virtual void AddValueSymbols(MCAssembler *) const = 0;
462 virtual const MCSection *FindAssociatedSection() const = 0;
464 static bool classof(const MCExpr *E) {
465 return E->getKind() == MCExpr::Target;
469 } // end namespace llvm