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_TOC, // TOC base
175 VK_PPC_TOC_ENTRY, // TOC entry
176 VK_PPC_DARWIN_HA16, // ha16(symbol)
177 VK_PPC_DARWIN_LO16, // lo16(symbol)
178 VK_PPC_GAS_HA16, // symbol@ha
179 VK_PPC_GAS_LO16, // symbol@l
180 VK_PPC_TPREL16_HA, // symbol@tprel@ha
181 VK_PPC_TPREL16_LO, // symbol@tprel@l
182 VK_PPC_TOC16_HA, // symbol@toc@ha
183 VK_PPC_TOC16_LO, // symbol@toc@l
184 VK_PPC_GOT_TPREL16_DS, // symbol@got@tprel
185 VK_PPC_TLS, // symbol@tls
186 VK_PPC_GOT_TLSGD16_HA, // symbol@got@tlsgd@ha
187 VK_PPC_GOT_TLSGD16_LO, // symbol@got@tlsgd@l
188 VK_PPC_TLSGD, // symbol@tlsgd
217 /// The symbol being referenced.
218 const MCSymbol *Symbol;
220 /// The symbol reference modifier.
221 const VariantKind Kind;
223 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
224 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {
229 /// @name Construction
232 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
233 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
236 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
238 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
245 const MCSymbol &getSymbol() const { return *Symbol; }
247 VariantKind getKind() const { return Kind; }
250 /// @name Static Utility Functions
253 static StringRef getVariantKindName(VariantKind Kind);
255 static VariantKind getVariantKindForName(StringRef Name);
259 static bool classof(const MCExpr *E) {
260 return E->getKind() == MCExpr::SymbolRef;
264 /// MCUnaryExpr - Unary assembler expressions.
265 class MCUnaryExpr : public MCExpr {
268 LNot, ///< Logical negation.
269 Minus, ///< Unary minus.
270 Not, ///< Bitwise negation.
271 Plus ///< Unary plus.
278 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
279 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
282 /// @name Construction
285 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
287 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
288 return Create(LNot, Expr, Ctx);
290 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
291 return Create(Minus, Expr, Ctx);
293 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
294 return Create(Not, Expr, Ctx);
296 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
297 return Create(Plus, Expr, Ctx);
304 /// getOpcode - Get the kind of this unary expression.
305 Opcode getOpcode() const { return Op; }
307 /// getSubExpr - Get the child of this unary expression.
308 const MCExpr *getSubExpr() const { return Expr; }
312 static bool classof(const MCExpr *E) {
313 return E->getKind() == MCExpr::Unary;
317 /// MCBinaryExpr - Binary assembler expressions.
318 class MCBinaryExpr : public MCExpr {
322 And, ///< Bitwise and.
323 Div, ///< Signed division.
324 EQ, ///< Equality comparison.
325 GT, ///< Signed greater than comparison (result is either 0 or some
326 ///< target-specific non-zero value)
327 GTE, ///< Signed greater than or equal comparison (result is either 0 or
328 ///< some target-specific non-zero value).
329 LAnd, ///< Logical and.
330 LOr, ///< Logical or.
331 LT, ///< Signed less than comparison (result is either 0 or
332 ///< some target-specific non-zero value).
333 LTE, ///< Signed less than or equal comparison (result is either 0 or
334 ///< some target-specific non-zero value).
335 Mod, ///< Signed remainder.
336 Mul, ///< Multiplication.
337 NE, ///< Inequality comparison.
339 Shl, ///< Shift left.
340 Shr, ///< Shift right (arithmetic or logical, depending on target)
341 Sub, ///< Subtraction.
342 Xor ///< Bitwise exclusive or.
347 const MCExpr *LHS, *RHS;
349 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
350 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
353 /// @name Construction
356 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
357 const MCExpr *RHS, MCContext &Ctx);
358 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
360 return Create(Add, LHS, RHS, Ctx);
362 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
364 return Create(And, LHS, RHS, Ctx);
366 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
368 return Create(Div, LHS, RHS, Ctx);
370 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
372 return Create(EQ, LHS, RHS, Ctx);
374 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
376 return Create(GT, LHS, RHS, Ctx);
378 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
380 return Create(GTE, LHS, RHS, Ctx);
382 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
384 return Create(LAnd, LHS, RHS, Ctx);
386 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
388 return Create(LOr, LHS, RHS, Ctx);
390 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
392 return Create(LT, LHS, RHS, Ctx);
394 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
396 return Create(LTE, LHS, RHS, Ctx);
398 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
400 return Create(Mod, LHS, RHS, Ctx);
402 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
404 return Create(Mul, LHS, RHS, Ctx);
406 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
408 return Create(NE, LHS, RHS, Ctx);
410 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
412 return Create(Or, LHS, RHS, Ctx);
414 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
416 return Create(Shl, LHS, RHS, Ctx);
418 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
420 return Create(Shr, LHS, RHS, Ctx);
422 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
424 return Create(Sub, LHS, RHS, Ctx);
426 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
428 return Create(Xor, LHS, RHS, Ctx);
435 /// getOpcode - Get the kind of this binary expression.
436 Opcode getOpcode() const { return Op; }
438 /// getLHS - Get the left-hand side expression of the binary operator.
439 const MCExpr *getLHS() const { return LHS; }
441 /// getRHS - Get the right-hand side expression of the binary operator.
442 const MCExpr *getRHS() const { return RHS; }
446 static bool classof(const MCExpr *E) {
447 return E->getKind() == MCExpr::Binary;
451 /// MCTargetExpr - This is an extension point for target-specific MCExpr
452 /// subclasses to implement.
454 /// NOTE: All subclasses are required to have trivial destructors because
455 /// MCExprs are bump pointer allocated and not destructed.
456 class MCTargetExpr : public MCExpr {
457 virtual void anchor();
459 MCTargetExpr() : MCExpr(Target) {}
460 virtual ~MCTargetExpr() {}
463 virtual void PrintImpl(raw_ostream &OS) const = 0;
464 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
465 const MCAsmLayout *Layout) const = 0;
466 virtual void AddValueSymbols(MCAssembler *) const = 0;
467 virtual const MCSection *FindAssociatedSection() const = 0;
469 static bool classof(const MCExpr *E) {
470 return E->getKind() == MCExpr::Target;
474 } // end namespace llvm