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.
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
174 VK_PPC_LO, // symbol@l
175 VK_PPC_HI, // symbol@h
176 VK_PPC_HA, // symbol@ha
177 VK_PPC_TOCBASE, // symbol@tocbase
178 VK_PPC_TOC, // symbol@toc
179 VK_PPC_TOC_LO, // symbol@toc@l
180 VK_PPC_TOC_HA, // symbol@toc@ha
181 VK_PPC_TPREL_LO, // symbol@tprel@l
182 VK_PPC_TPREL_HA, // symbol@tprel@ha
183 VK_PPC_DTPREL_LO, // symbol@dtprel@l
184 VK_PPC_DTPREL_HA, // symbol@dtprel@ha
185 VK_PPC_GOT_TPREL_LO, // symbol@got@tprel@l
186 VK_PPC_GOT_TPREL_HA, // symbol@got@tprel@ha
187 VK_PPC_TLS, // symbol@tls
188 VK_PPC_GOT_TLSGD_LO, // symbol@got@tlsgd@l
189 VK_PPC_GOT_TLSGD_HA, // symbol@got@tlsgd@ha
190 VK_PPC_TLSGD, // symbol@tlsgd
191 VK_PPC_GOT_TLSLD_LO, // symbol@got@tlsld@l
192 VK_PPC_GOT_TLSLD_HA, // symbol@got@tlsld@ha
193 VK_PPC_TLSLD, // symbol@tlsld
220 VK_COFF_IMGREL32 // symbol@imgrel (image-relative)
224 /// The symbol being referenced.
225 const MCSymbol *Symbol;
227 /// The symbol reference modifier.
228 const VariantKind Kind;
230 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
231 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {
236 /// @name Construction
239 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
240 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
243 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
245 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
252 const MCSymbol &getSymbol() const { return *Symbol; }
254 VariantKind getKind() const { return Kind; }
257 /// @name Static Utility Functions
260 static StringRef getVariantKindName(VariantKind Kind);
262 static VariantKind getVariantKindForName(StringRef Name);
266 static bool classof(const MCExpr *E) {
267 return E->getKind() == MCExpr::SymbolRef;
271 /// MCUnaryExpr - Unary assembler expressions.
272 class MCUnaryExpr : public MCExpr {
275 LNot, ///< Logical negation.
276 Minus, ///< Unary minus.
277 Not, ///< Bitwise negation.
278 Plus ///< Unary plus.
285 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
286 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
289 /// @name Construction
292 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
294 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
295 return Create(LNot, Expr, Ctx);
297 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
298 return Create(Minus, Expr, Ctx);
300 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
301 return Create(Not, Expr, Ctx);
303 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
304 return Create(Plus, Expr, Ctx);
311 /// getOpcode - Get the kind of this unary expression.
312 Opcode getOpcode() const { return Op; }
314 /// getSubExpr - Get the child of this unary expression.
315 const MCExpr *getSubExpr() const { return Expr; }
319 static bool classof(const MCExpr *E) {
320 return E->getKind() == MCExpr::Unary;
324 /// MCBinaryExpr - Binary assembler expressions.
325 class MCBinaryExpr : public MCExpr {
329 And, ///< Bitwise and.
330 Div, ///< Signed division.
331 EQ, ///< Equality comparison.
332 GT, ///< Signed greater than comparison (result is either 0 or some
333 ///< target-specific non-zero value)
334 GTE, ///< Signed greater than or equal comparison (result is either 0 or
335 ///< some target-specific non-zero value).
336 LAnd, ///< Logical and.
337 LOr, ///< Logical or.
338 LT, ///< Signed less than comparison (result is either 0 or
339 ///< some target-specific non-zero value).
340 LTE, ///< Signed less than or equal comparison (result is either 0 or
341 ///< some target-specific non-zero value).
342 Mod, ///< Signed remainder.
343 Mul, ///< Multiplication.
344 NE, ///< Inequality comparison.
346 Shl, ///< Shift left.
347 Shr, ///< Shift right (arithmetic or logical, depending on target)
348 Sub, ///< Subtraction.
349 Xor ///< Bitwise exclusive or.
354 const MCExpr *LHS, *RHS;
356 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
357 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
360 /// @name Construction
363 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
364 const MCExpr *RHS, MCContext &Ctx);
365 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
367 return Create(Add, LHS, RHS, Ctx);
369 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
371 return Create(And, LHS, RHS, Ctx);
373 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
375 return Create(Div, LHS, RHS, Ctx);
377 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
379 return Create(EQ, LHS, RHS, Ctx);
381 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
383 return Create(GT, LHS, RHS, Ctx);
385 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
387 return Create(GTE, LHS, RHS, Ctx);
389 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
391 return Create(LAnd, LHS, RHS, Ctx);
393 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
395 return Create(LOr, LHS, RHS, Ctx);
397 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
399 return Create(LT, LHS, RHS, Ctx);
401 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
403 return Create(LTE, LHS, RHS, Ctx);
405 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
407 return Create(Mod, LHS, RHS, Ctx);
409 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
411 return Create(Mul, LHS, RHS, Ctx);
413 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
415 return Create(NE, LHS, RHS, Ctx);
417 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
419 return Create(Or, LHS, RHS, Ctx);
421 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
423 return Create(Shl, LHS, RHS, Ctx);
425 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
427 return Create(Shr, LHS, RHS, Ctx);
429 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
431 return Create(Sub, LHS, RHS, Ctx);
433 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
435 return Create(Xor, LHS, RHS, Ctx);
442 /// getOpcode - Get the kind of this binary expression.
443 Opcode getOpcode() const { return Op; }
445 /// getLHS - Get the left-hand side expression of the binary operator.
446 const MCExpr *getLHS() const { return LHS; }
448 /// getRHS - Get the right-hand side expression of the binary operator.
449 const MCExpr *getRHS() const { return RHS; }
453 static bool classof(const MCExpr *E) {
454 return E->getKind() == MCExpr::Binary;
458 /// MCTargetExpr - This is an extension point for target-specific MCExpr
459 /// subclasses to implement.
461 /// NOTE: All subclasses are required to have trivial destructors because
462 /// MCExprs are bump pointer allocated and not destructed.
463 class MCTargetExpr : public MCExpr {
464 virtual void anchor();
466 MCTargetExpr() : MCExpr(Target) {}
467 virtual ~MCTargetExpr() {}
470 virtual void PrintImpl(raw_ostream &OS) const = 0;
471 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
472 const MCAsmLayout *Layout) const = 0;
473 virtual void AddValueSymbols(MCAssembler *) const = 0;
474 virtual const MCSection *FindAssociatedSection() const = 0;
476 virtual void fixELFSymbolsInTLSFixups(MCAssembler &) const = 0;
478 static bool classof(const MCExpr *E) {
479 return E->getKind() == MCExpr::Target;
483 } // end namespace llvm