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"
30 typedef DenseMap<const MCSectionData*, uint64_t> SectionAddrMap;
32 /// MCExpr - Base class for the full range of assembler expressions which are
33 /// needed for parsing.
37 Binary, ///< Binary expressions.
38 Constant, ///< Constant expressions.
39 SymbolRef, ///< References to labels and assigned expressions.
40 Unary, ///< Unary expressions.
41 Target ///< Target specific expression.
47 MCExpr(const MCExpr&) LLVM_DELETED_FUNCTION;
48 void operator=(const MCExpr&) LLVM_DELETED_FUNCTION;
50 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
51 const MCAsmLayout *Layout,
52 const SectionAddrMap *Addrs) const;
54 explicit MCExpr(ExprKind _Kind) : Kind(_Kind) {}
56 bool EvaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
57 const MCAsmLayout *Layout,
59 const SectionAddrMap *Addrs, bool InSet,
60 bool ForceVarExpansion) const;
66 ExprKind getKind() const { return Kind; }
69 /// @name Utility Methods
72 void print(raw_ostream &OS) const;
76 /// @name Expression Evaluation
79 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
81 /// @param Res - The absolute value, if evaluation succeeds.
82 /// @param Layout - The assembler layout object to use for evaluating symbol
83 /// values. If not given, then only non-symbolic expressions will be
85 /// @result - True on success.
86 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout,
87 const SectionAddrMap &Addrs) const;
88 bool EvaluateAsAbsolute(int64_t &Res) const;
89 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const;
90 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const;
92 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
93 /// value, i.e. an expression of the fixed form (a - b + constant).
95 /// @param Res - The relocatable value, if evaluation succeeds.
96 /// @param Layout - The assembler layout object to use for evaluating values.
97 /// @param Fixup - The Fixup object if available.
98 /// @result - True on success.
99 bool EvaluateAsRelocatable(MCValue &Res, const MCAsmLayout *Layout,
100 const MCFixup *Fixup) const;
102 /// \brief Try to evaluate the expression to the form (a - b + constant) where
103 /// neither a nor b are variables.
105 /// This is a more aggressive variant of EvaluateAsRelocatable. The intended
106 /// use is for when relocations are not available, like the symbol value in
107 /// the symbol table.
108 bool EvaluateAsValue(MCValue &Res, const MCAsmLayout *Layout,
109 const MCFixup *Fixup) const;
111 /// FindAssociatedSection - Find the "associated section" for this expression,
112 /// which is currently defined as the absolute section for constants, or
113 /// otherwise the section associated with the first defined symbol in the
115 const MCSection *FindAssociatedSection() const;
120 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
125 //// MCConstantExpr - Represent a constant integer expression.
126 class MCConstantExpr : public MCExpr {
129 explicit MCConstantExpr(int64_t _Value)
130 : MCExpr(MCExpr::Constant), Value(_Value) {}
133 /// @name Construction
136 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
142 int64_t getValue() const { return Value; }
146 static bool classof(const MCExpr *E) {
147 return E->getKind() == MCExpr::Constant;
151 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
154 /// A symbol reference in an expression may be a use of a label, a use of an
155 /// assembler variable (defined constant), or constitute an implicit definition
156 /// of the symbol as external.
157 class MCSymbolRefExpr : public MCExpr {
176 VK_TLVP, // Mach-O thread local variable relocations
184 VK_WEAKREF, // The link between the symbols in .weakref foo, bar
190 VK_ARM_TLSLDO, // symbol(tlsldo)
191 VK_ARM_TLSCALL, // symbol(tlscall)
192 VK_ARM_TLSDESC, // symbol(tlsdesc)
195 VK_PPC_LO, // symbol@l
196 VK_PPC_HI, // symbol@h
197 VK_PPC_HA, // symbol@ha
198 VK_PPC_HIGHER, // symbol@higher
199 VK_PPC_HIGHERA, // symbol@highera
200 VK_PPC_HIGHEST, // symbol@highest
201 VK_PPC_HIGHESTA, // symbol@highesta
202 VK_PPC_GOT_LO, // symbol@got@l
203 VK_PPC_GOT_HI, // symbol@got@h
204 VK_PPC_GOT_HA, // symbol@got@ha
205 VK_PPC_TOCBASE, // symbol@tocbase
206 VK_PPC_TOC, // symbol@toc
207 VK_PPC_TOC_LO, // symbol@toc@l
208 VK_PPC_TOC_HI, // symbol@toc@h
209 VK_PPC_TOC_HA, // symbol@toc@ha
210 VK_PPC_DTPMOD, // symbol@dtpmod
211 VK_PPC_TPREL, // symbol@tprel
212 VK_PPC_TPREL_LO, // symbol@tprel@l
213 VK_PPC_TPREL_HI, // symbol@tprel@h
214 VK_PPC_TPREL_HA, // symbol@tprel@ha
215 VK_PPC_TPREL_HIGHER, // symbol@tprel@higher
216 VK_PPC_TPREL_HIGHERA, // symbol@tprel@highera
217 VK_PPC_TPREL_HIGHEST, // symbol@tprel@highest
218 VK_PPC_TPREL_HIGHESTA, // symbol@tprel@highesta
219 VK_PPC_DTPREL, // symbol@dtprel
220 VK_PPC_DTPREL_LO, // symbol@dtprel@l
221 VK_PPC_DTPREL_HI, // symbol@dtprel@h
222 VK_PPC_DTPREL_HA, // symbol@dtprel@ha
223 VK_PPC_DTPREL_HIGHER, // symbol@dtprel@higher
224 VK_PPC_DTPREL_HIGHERA, // symbol@dtprel@highera
225 VK_PPC_DTPREL_HIGHEST, // symbol@dtprel@highest
226 VK_PPC_DTPREL_HIGHESTA,// symbol@dtprel@highesta
227 VK_PPC_GOT_TPREL, // symbol@got@tprel
228 VK_PPC_GOT_TPREL_LO, // symbol@got@tprel@l
229 VK_PPC_GOT_TPREL_HI, // symbol@got@tprel@h
230 VK_PPC_GOT_TPREL_HA, // symbol@got@tprel@ha
231 VK_PPC_GOT_DTPREL, // symbol@got@dtprel
232 VK_PPC_GOT_DTPREL_LO, // symbol@got@dtprel@l
233 VK_PPC_GOT_DTPREL_HI, // symbol@got@dtprel@h
234 VK_PPC_GOT_DTPREL_HA, // symbol@got@dtprel@ha
235 VK_PPC_TLS, // symbol@tls
236 VK_PPC_GOT_TLSGD, // symbol@got@tlsgd
237 VK_PPC_GOT_TLSGD_LO, // symbol@got@tlsgd@l
238 VK_PPC_GOT_TLSGD_HI, // symbol@got@tlsgd@h
239 VK_PPC_GOT_TLSGD_HA, // symbol@got@tlsgd@ha
240 VK_PPC_TLSGD, // symbol@tlsgd
241 VK_PPC_GOT_TLSLD, // symbol@got@tlsld
242 VK_PPC_GOT_TLSLD_LO, // symbol@got@tlsld@l
243 VK_PPC_GOT_TLSLD_HI, // symbol@got@tlsld@h
244 VK_PPC_GOT_TLSLD_HA, // symbol@got@tlsld@ha
245 VK_PPC_TLSLD, // symbol@tlsld
274 VK_COFF_IMGREL32 // symbol@imgrel (image-relative)
278 /// The symbol being referenced.
279 const MCSymbol *Symbol;
281 /// The symbol reference modifier.
282 const VariantKind Kind;
284 /// MCAsmInfo that is used to print symbol variants correctly.
285 const MCAsmInfo *MAI;
287 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind,
288 const MCAsmInfo *_MAI)
289 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind), MAI(_MAI) {
295 /// @name Construction
298 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
299 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
302 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
304 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
311 const MCSymbol &getSymbol() const { return *Symbol; }
312 const MCAsmInfo &getMCAsmInfo() const { return *MAI; }
314 VariantKind getKind() const { return Kind; }
317 /// @name Static Utility Functions
320 static StringRef getVariantKindName(VariantKind Kind);
322 static VariantKind getVariantKindForName(StringRef Name);
326 static bool classof(const MCExpr *E) {
327 return E->getKind() == MCExpr::SymbolRef;
331 /// MCUnaryExpr - Unary assembler expressions.
332 class MCUnaryExpr : public MCExpr {
335 LNot, ///< Logical negation.
336 Minus, ///< Unary minus.
337 Not, ///< Bitwise negation.
338 Plus ///< Unary plus.
345 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
346 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
349 /// @name Construction
352 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
354 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
355 return Create(LNot, Expr, Ctx);
357 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
358 return Create(Minus, Expr, Ctx);
360 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
361 return Create(Not, Expr, Ctx);
363 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
364 return Create(Plus, Expr, Ctx);
371 /// getOpcode - Get the kind of this unary expression.
372 Opcode getOpcode() const { return Op; }
374 /// getSubExpr - Get the child of this unary expression.
375 const MCExpr *getSubExpr() const { return Expr; }
379 static bool classof(const MCExpr *E) {
380 return E->getKind() == MCExpr::Unary;
384 /// MCBinaryExpr - Binary assembler expressions.
385 class MCBinaryExpr : public MCExpr {
389 And, ///< Bitwise and.
390 Div, ///< Signed division.
391 EQ, ///< Equality comparison.
392 GT, ///< Signed greater than comparison (result is either 0 or some
393 ///< target-specific non-zero value)
394 GTE, ///< Signed greater than or equal comparison (result is either 0 or
395 ///< some target-specific non-zero value).
396 LAnd, ///< Logical and.
397 LOr, ///< Logical or.
398 LT, ///< Signed less than comparison (result is either 0 or
399 ///< some target-specific non-zero value).
400 LTE, ///< Signed less than or equal comparison (result is either 0 or
401 ///< some target-specific non-zero value).
402 Mod, ///< Signed remainder.
403 Mul, ///< Multiplication.
404 NE, ///< Inequality comparison.
406 Shl, ///< Shift left.
407 Shr, ///< Shift right (arithmetic or logical, depending on target)
408 Sub, ///< Subtraction.
409 Xor ///< Bitwise exclusive or.
414 const MCExpr *LHS, *RHS;
416 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
417 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
420 /// @name Construction
423 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
424 const MCExpr *RHS, MCContext &Ctx);
425 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
427 return Create(Add, LHS, RHS, Ctx);
429 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
431 return Create(And, LHS, RHS, Ctx);
433 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
435 return Create(Div, LHS, RHS, Ctx);
437 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
439 return Create(EQ, LHS, RHS, Ctx);
441 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
443 return Create(GT, LHS, RHS, Ctx);
445 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
447 return Create(GTE, LHS, RHS, Ctx);
449 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
451 return Create(LAnd, LHS, RHS, Ctx);
453 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
455 return Create(LOr, LHS, RHS, Ctx);
457 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
459 return Create(LT, LHS, RHS, Ctx);
461 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
463 return Create(LTE, LHS, RHS, Ctx);
465 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
467 return Create(Mod, LHS, RHS, Ctx);
469 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
471 return Create(Mul, LHS, RHS, Ctx);
473 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
475 return Create(NE, LHS, RHS, Ctx);
477 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
479 return Create(Or, LHS, RHS, Ctx);
481 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
483 return Create(Shl, LHS, RHS, Ctx);
485 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
487 return Create(Shr, LHS, RHS, Ctx);
489 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
491 return Create(Sub, LHS, RHS, Ctx);
493 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
495 return Create(Xor, LHS, RHS, Ctx);
502 /// getOpcode - Get the kind of this binary expression.
503 Opcode getOpcode() const { return Op; }
505 /// getLHS - Get the left-hand side expression of the binary operator.
506 const MCExpr *getLHS() const { return LHS; }
508 /// getRHS - Get the right-hand side expression of the binary operator.
509 const MCExpr *getRHS() const { return RHS; }
513 static bool classof(const MCExpr *E) {
514 return E->getKind() == MCExpr::Binary;
518 /// MCTargetExpr - This is an extension point for target-specific MCExpr
519 /// subclasses to implement.
521 /// NOTE: All subclasses are required to have trivial destructors because
522 /// MCExprs are bump pointer allocated and not destructed.
523 class MCTargetExpr : public MCExpr {
524 virtual void anchor();
526 MCTargetExpr() : MCExpr(Target) {}
527 virtual ~MCTargetExpr() {}
530 virtual void PrintImpl(raw_ostream &OS) const = 0;
531 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
532 const MCAsmLayout *Layout,
533 const MCFixup *Fixup) const = 0;
534 virtual void visitUsedExpr(MCStreamer& Streamer) const = 0;
535 virtual const MCSection *FindAssociatedSection() const = 0;
537 virtual void fixELFSymbolsInTLSFixups(MCAssembler &) const = 0;
539 static bool classof(const MCExpr *E) {
540 return E->getKind() == MCExpr::Target;
544 } // end namespace llvm