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"
28 typedef DenseMap<const MCSectionData*, uint64_t> SectionAddrMap;
30 /// MCExpr - Base class for the full range of assembler expressions which are
31 /// needed for parsing.
35 Binary, ///< Binary expressions.
36 Constant, ///< Constant expressions.
37 SymbolRef, ///< References to labels and assigned expressions.
38 Unary, ///< Unary expressions.
39 Target ///< Target specific expression.
45 MCExpr(const MCExpr&) LLVM_DELETED_FUNCTION;
46 void operator=(const MCExpr&) LLVM_DELETED_FUNCTION;
48 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
49 const MCAsmLayout *Layout,
50 const SectionAddrMap *Addrs) const;
52 explicit MCExpr(ExprKind _Kind) : Kind(_Kind) {}
54 bool EvaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
55 const MCAsmLayout *Layout,
56 const SectionAddrMap *Addrs,
62 ExprKind getKind() const { return Kind; }
65 /// @name Utility Methods
68 void print(raw_ostream &OS) const;
72 /// @name Expression Evaluation
75 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
77 /// @param Res - The absolute value, if evaluation succeeds.
78 /// @param Layout - The assembler layout object to use for evaluating symbol
79 /// values. If not given, then only non-symbolic expressions will be
81 /// @result - True on success.
82 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout,
83 const SectionAddrMap &Addrs) const;
84 bool EvaluateAsAbsolute(int64_t &Res) const;
85 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const;
86 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const;
88 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
89 /// value, i.e. an expression of the fixed form (a - b + constant).
91 /// @param Res - The relocatable value, if evaluation succeeds.
92 /// @param Layout - The assembler layout object to use for evaluating values.
93 /// @result - True on success.
94 bool EvaluateAsRelocatable(MCValue &Res, const MCAsmLayout &Layout) const;
96 /// FindAssociatedSection - Find the "associated section" for this expression,
97 /// which is currently defined as the absolute section for constants, or
98 /// otherwise the section associated with the first defined symbol in the
100 const MCSection *FindAssociatedSection() const;
105 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
110 //// MCConstantExpr - Represent a constant integer expression.
111 class MCConstantExpr : public MCExpr {
114 explicit MCConstantExpr(int64_t _Value)
115 : MCExpr(MCExpr::Constant), Value(_Value) {}
118 /// @name Construction
121 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
127 int64_t getValue() const { return Value; }
131 static bool classof(const MCExpr *E) {
132 return E->getKind() == MCExpr::Constant;
136 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
139 /// A symbol reference in an expression may be a use of a label, a use of an
140 /// assembler variable (defined constant), or constitute an implicit definition
141 /// of the symbol as external.
142 class MCSymbolRefExpr : public MCExpr {
161 VK_TLVP, // Mach-O thread local variable relocation
168 VK_ARM_TLSLDO, // symbol(tlsldo)
169 VK_ARM_TLSCALL, // symbol(tlscall)
170 VK_ARM_TLSDESC, // symbol(tlsdesc)
172 VK_PPC_LO, // symbol@l
173 VK_PPC_HI, // symbol@h
174 VK_PPC_HA, // symbol@ha
175 VK_PPC_HIGHER, // symbol@higher
176 VK_PPC_HIGHERA, // symbol@highera
177 VK_PPC_HIGHEST, // symbol@highest
178 VK_PPC_HIGHESTA, // symbol@highesta
179 VK_PPC_GOT_LO, // symbol@got@l
180 VK_PPC_GOT_HI, // symbol@got@h
181 VK_PPC_GOT_HA, // symbol@got@ha
182 VK_PPC_TOCBASE, // symbol@tocbase
183 VK_PPC_TOC, // symbol@toc
184 VK_PPC_TOC_LO, // symbol@toc@l
185 VK_PPC_TOC_HI, // symbol@toc@h
186 VK_PPC_TOC_HA, // symbol@toc@ha
187 VK_PPC_DTPMOD, // symbol@dtpmod
188 VK_PPC_TPREL, // symbol@tprel
189 VK_PPC_TPREL_LO, // symbol@tprel@l
190 VK_PPC_TPREL_HI, // symbol@tprel@h
191 VK_PPC_TPREL_HA, // symbol@tprel@ha
192 VK_PPC_TPREL_HIGHER, // symbol@tprel@higher
193 VK_PPC_TPREL_HIGHERA, // symbol@tprel@highera
194 VK_PPC_TPREL_HIGHEST, // symbol@tprel@highest
195 VK_PPC_TPREL_HIGHESTA, // symbol@tprel@highesta
196 VK_PPC_DTPREL, // symbol@dtprel
197 VK_PPC_DTPREL_LO, // symbol@dtprel@l
198 VK_PPC_DTPREL_HI, // symbol@dtprel@h
199 VK_PPC_DTPREL_HA, // symbol@dtprel@ha
200 VK_PPC_DTPREL_HIGHER, // symbol@dtprel@higher
201 VK_PPC_DTPREL_HIGHERA, // symbol@dtprel@highera
202 VK_PPC_DTPREL_HIGHEST, // symbol@dtprel@highest
203 VK_PPC_DTPREL_HIGHESTA,// symbol@dtprel@highesta
204 VK_PPC_GOT_TPREL, // symbol@got@tprel
205 VK_PPC_GOT_TPREL_LO, // symbol@got@tprel@l
206 VK_PPC_GOT_TPREL_HI, // symbol@got@tprel@h
207 VK_PPC_GOT_TPREL_HA, // symbol@got@tprel@ha
208 VK_PPC_GOT_DTPREL, // symbol@got@dtprel
209 VK_PPC_GOT_DTPREL_LO, // symbol@got@dtprel@l
210 VK_PPC_GOT_DTPREL_HI, // symbol@got@dtprel@h
211 VK_PPC_GOT_DTPREL_HA, // symbol@got@dtprel@ha
212 VK_PPC_TLS, // symbol@tls
213 VK_PPC_GOT_TLSGD, // symbol@got@tlsgd
214 VK_PPC_GOT_TLSGD_LO, // symbol@got@tlsgd@l
215 VK_PPC_GOT_TLSGD_HI, // symbol@got@tlsgd@h
216 VK_PPC_GOT_TLSGD_HA, // symbol@got@tlsgd@ha
217 VK_PPC_TLSGD, // symbol@tlsgd
218 VK_PPC_GOT_TLSLD, // symbol@got@tlsld
219 VK_PPC_GOT_TLSLD_LO, // symbol@got@tlsld@l
220 VK_PPC_GOT_TLSLD_HI, // symbol@got@tlsld@h
221 VK_PPC_GOT_TLSLD_HA, // symbol@got@tlsld@ha
222 VK_PPC_TLSLD, // symbol@tlsld
249 VK_COFF_IMGREL32 // symbol@imgrel (image-relative)
253 /// The symbol being referenced.
254 const MCSymbol *Symbol;
256 /// The symbol reference modifier.
257 const VariantKind Kind;
259 /// MCAsmInfo that is used to print symbol variants correctly.
260 const MCAsmInfo *MAI;
262 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind,
263 const MCAsmInfo *_MAI)
264 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind), MAI(_MAI) {
270 /// @name Construction
273 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
274 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
277 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
279 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
286 const MCSymbol &getSymbol() const { return *Symbol; }
287 const MCAsmInfo &getMCAsmInfo() const { return *MAI; }
289 VariantKind getKind() const { return Kind; }
292 /// @name Static Utility Functions
295 static StringRef getVariantKindName(VariantKind Kind);
297 static VariantKind getVariantKindForName(StringRef Name);
301 static bool classof(const MCExpr *E) {
302 return E->getKind() == MCExpr::SymbolRef;
306 /// MCUnaryExpr - Unary assembler expressions.
307 class MCUnaryExpr : public MCExpr {
310 LNot, ///< Logical negation.
311 Minus, ///< Unary minus.
312 Not, ///< Bitwise negation.
313 Plus ///< Unary plus.
320 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
321 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
324 /// @name Construction
327 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
329 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
330 return Create(LNot, Expr, Ctx);
332 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
333 return Create(Minus, Expr, Ctx);
335 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
336 return Create(Not, Expr, Ctx);
338 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
339 return Create(Plus, Expr, Ctx);
346 /// getOpcode - Get the kind of this unary expression.
347 Opcode getOpcode() const { return Op; }
349 /// getSubExpr - Get the child of this unary expression.
350 const MCExpr *getSubExpr() const { return Expr; }
354 static bool classof(const MCExpr *E) {
355 return E->getKind() == MCExpr::Unary;
359 /// MCBinaryExpr - Binary assembler expressions.
360 class MCBinaryExpr : public MCExpr {
364 And, ///< Bitwise and.
365 Div, ///< Signed division.
366 EQ, ///< Equality comparison.
367 GT, ///< Signed greater than comparison (result is either 0 or some
368 ///< target-specific non-zero value)
369 GTE, ///< Signed greater than or equal comparison (result is either 0 or
370 ///< some target-specific non-zero value).
371 LAnd, ///< Logical and.
372 LOr, ///< Logical or.
373 LT, ///< Signed less than comparison (result is either 0 or
374 ///< some target-specific non-zero value).
375 LTE, ///< Signed less than or equal comparison (result is either 0 or
376 ///< some target-specific non-zero value).
377 Mod, ///< Signed remainder.
378 Mul, ///< Multiplication.
379 NE, ///< Inequality comparison.
381 Shl, ///< Shift left.
382 Shr, ///< Shift right (arithmetic or logical, depending on target)
383 Sub, ///< Subtraction.
384 Xor ///< Bitwise exclusive or.
389 const MCExpr *LHS, *RHS;
391 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
392 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
395 /// @name Construction
398 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
399 const MCExpr *RHS, MCContext &Ctx);
400 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
402 return Create(Add, LHS, RHS, Ctx);
404 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
406 return Create(And, LHS, RHS, Ctx);
408 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
410 return Create(Div, LHS, RHS, Ctx);
412 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
414 return Create(EQ, LHS, RHS, Ctx);
416 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
418 return Create(GT, LHS, RHS, Ctx);
420 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
422 return Create(GTE, LHS, RHS, Ctx);
424 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
426 return Create(LAnd, LHS, RHS, Ctx);
428 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
430 return Create(LOr, LHS, RHS, Ctx);
432 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
434 return Create(LT, LHS, RHS, Ctx);
436 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
438 return Create(LTE, LHS, RHS, Ctx);
440 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
442 return Create(Mod, LHS, RHS, Ctx);
444 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
446 return Create(Mul, LHS, RHS, Ctx);
448 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
450 return Create(NE, LHS, RHS, Ctx);
452 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
454 return Create(Or, LHS, RHS, Ctx);
456 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
458 return Create(Shl, LHS, RHS, Ctx);
460 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
462 return Create(Shr, LHS, RHS, Ctx);
464 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
466 return Create(Sub, LHS, RHS, Ctx);
468 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
470 return Create(Xor, LHS, RHS, Ctx);
477 /// getOpcode - Get the kind of this binary expression.
478 Opcode getOpcode() const { return Op; }
480 /// getLHS - Get the left-hand side expression of the binary operator.
481 const MCExpr *getLHS() const { return LHS; }
483 /// getRHS - Get the right-hand side expression of the binary operator.
484 const MCExpr *getRHS() const { return RHS; }
488 static bool classof(const MCExpr *E) {
489 return E->getKind() == MCExpr::Binary;
493 /// MCTargetExpr - This is an extension point for target-specific MCExpr
494 /// subclasses to implement.
496 /// NOTE: All subclasses are required to have trivial destructors because
497 /// MCExprs are bump pointer allocated and not destructed.
498 class MCTargetExpr : public MCExpr {
499 virtual void anchor();
501 MCTargetExpr() : MCExpr(Target) {}
502 virtual ~MCTargetExpr() {}
505 virtual void PrintImpl(raw_ostream &OS) const = 0;
506 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
507 const MCAsmLayout *Layout) const = 0;
508 virtual void AddValueSymbols(MCAssembler *) const = 0;
509 virtual const MCSection *FindAssociatedSection() const = 0;
511 virtual void fixELFSymbolsInTLSFixups(MCAssembler &) const = 0;
513 static bool classof(const MCExpr *E) {
514 return E->getKind() == MCExpr::Target;
518 } // end namespace llvm