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
171 VK_PPC_TOC, // TOC base
172 VK_PPC_TOC_ENTRY, // TOC entry
173 VK_PPC_DARWIN_HA16, // ha16(symbol)
174 VK_PPC_DARWIN_LO16, // lo16(symbol)
175 VK_PPC_GAS_HA16, // symbol@ha
176 VK_PPC_GAS_LO16, // symbol@l
177 VK_PPC_TPREL16_HA, // symbol@tprel@ha
178 VK_PPC_TPREL16_LO, // symbol@tprel@l
203 /// The symbol being referenced.
204 const MCSymbol *Symbol;
206 /// The symbol reference modifier.
207 const VariantKind Kind;
209 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
210 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {
215 /// @name Construction
218 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
219 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
222 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
224 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
231 const MCSymbol &getSymbol() const { return *Symbol; }
233 VariantKind getKind() const { return Kind; }
236 /// @name Static Utility Functions
239 static StringRef getVariantKindName(VariantKind Kind);
241 static VariantKind getVariantKindForName(StringRef Name);
245 static bool classof(const MCExpr *E) {
246 return E->getKind() == MCExpr::SymbolRef;
250 /// MCUnaryExpr - Unary assembler expressions.
251 class MCUnaryExpr : public MCExpr {
254 LNot, ///< Logical negation.
255 Minus, ///< Unary minus.
256 Not, ///< Bitwise negation.
257 Plus ///< Unary plus.
264 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
265 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
268 /// @name Construction
271 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
273 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
274 return Create(LNot, Expr, Ctx);
276 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
277 return Create(Minus, Expr, Ctx);
279 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
280 return Create(Not, Expr, Ctx);
282 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
283 return Create(Plus, Expr, Ctx);
290 /// getOpcode - Get the kind of this unary expression.
291 Opcode getOpcode() const { return Op; }
293 /// getSubExpr - Get the child of this unary expression.
294 const MCExpr *getSubExpr() const { return Expr; }
298 static bool classof(const MCExpr *E) {
299 return E->getKind() == MCExpr::Unary;
303 /// MCBinaryExpr - Binary assembler expressions.
304 class MCBinaryExpr : public MCExpr {
308 And, ///< Bitwise and.
309 Div, ///< Signed division.
310 EQ, ///< Equality comparison.
311 GT, ///< Signed greater than comparison (result is either 0 or some
312 ///< target-specific non-zero value)
313 GTE, ///< Signed greater than or equal comparison (result is either 0 or
314 ///< some target-specific non-zero value).
315 LAnd, ///< Logical and.
316 LOr, ///< Logical or.
317 LT, ///< Signed less than comparison (result is either 0 or
318 ///< some target-specific non-zero value).
319 LTE, ///< Signed less than or equal comparison (result is either 0 or
320 ///< some target-specific non-zero value).
321 Mod, ///< Signed remainder.
322 Mul, ///< Multiplication.
323 NE, ///< Inequality comparison.
325 Shl, ///< Shift left.
326 Shr, ///< Shift right (arithmetic or logical, depending on target)
327 Sub, ///< Subtraction.
328 Xor ///< Bitwise exclusive or.
333 const MCExpr *LHS, *RHS;
335 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
336 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
339 /// @name Construction
342 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
343 const MCExpr *RHS, MCContext &Ctx);
344 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
346 return Create(Add, LHS, RHS, Ctx);
348 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
350 return Create(And, LHS, RHS, Ctx);
352 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
354 return Create(Div, LHS, RHS, Ctx);
356 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
358 return Create(EQ, LHS, RHS, Ctx);
360 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
362 return Create(GT, LHS, RHS, Ctx);
364 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
366 return Create(GTE, LHS, RHS, Ctx);
368 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
370 return Create(LAnd, LHS, RHS, Ctx);
372 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
374 return Create(LOr, LHS, RHS, Ctx);
376 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
378 return Create(LT, LHS, RHS, Ctx);
380 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
382 return Create(LTE, LHS, RHS, Ctx);
384 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
386 return Create(Mod, LHS, RHS, Ctx);
388 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
390 return Create(Mul, LHS, RHS, Ctx);
392 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
394 return Create(NE, LHS, RHS, Ctx);
396 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
398 return Create(Or, LHS, RHS, Ctx);
400 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
402 return Create(Shl, LHS, RHS, Ctx);
404 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
406 return Create(Shr, LHS, RHS, Ctx);
408 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
410 return Create(Sub, LHS, RHS, Ctx);
412 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
414 return Create(Xor, LHS, RHS, Ctx);
421 /// getOpcode - Get the kind of this binary expression.
422 Opcode getOpcode() const { return Op; }
424 /// getLHS - Get the left-hand side expression of the binary operator.
425 const MCExpr *getLHS() const { return LHS; }
427 /// getRHS - Get the right-hand side expression of the binary operator.
428 const MCExpr *getRHS() const { return RHS; }
432 static bool classof(const MCExpr *E) {
433 return E->getKind() == MCExpr::Binary;
437 /// MCTargetExpr - This is an extension point for target-specific MCExpr
438 /// subclasses to implement.
440 /// NOTE: All subclasses are required to have trivial destructors because
441 /// MCExprs are bump pointer allocated and not destructed.
442 class MCTargetExpr : public MCExpr {
443 virtual void anchor();
445 MCTargetExpr() : MCExpr(Target) {}
446 virtual ~MCTargetExpr() {}
449 virtual void PrintImpl(raw_ostream &OS) const = 0;
450 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
451 const MCAsmLayout *Layout) const = 0;
452 virtual void AddValueSymbols(MCAssembler *) const = 0;
453 virtual const MCSection *FindAssociatedSection() const = 0;
455 static bool classof(const MCExpr *E) {
456 return E->getKind() == MCExpr::Target;
460 } // end namespace llvm