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&); // DO NOT IMPLEMENT
46 void operator=(const MCExpr&); // DO NOT IMPLEMENT
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;
83 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const;
84 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const;
85 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout,
86 const SectionAddrMap &Addrs) 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;
104 static bool classof(const MCExpr *) { return true; }
107 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
112 //// MCConstantExpr - Represent a constant integer expression.
113 class MCConstantExpr : public MCExpr {
116 explicit MCConstantExpr(int64_t _Value)
117 : MCExpr(MCExpr::Constant), Value(_Value) {}
120 /// @name Construction
123 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
129 int64_t getValue() const { return Value; }
133 static bool classof(const MCExpr *E) {
134 return E->getKind() == MCExpr::Constant;
136 static bool classof(const MCConstantExpr *) { return true; }
139 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
142 /// A symbol reference in an expression may be a use of a label, a use of an
143 /// assembler variable (defined constant), or constitute an implicit definition
144 /// of the symbol as external.
145 class MCSymbolRefExpr : public MCExpr {
164 VK_TLVP, // Mach-O thread local variable relocation
165 // FIXME: We'd really like to use the generic Kinds listed above for these.
166 VK_ARM_PLT, // ARM-style PLT references. i.e., (PLT) instead of @PLT
167 VK_ARM_TLSGD, // ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
174 VK_PPC_DARWIN_HA16, // ha16(symbol)
175 VK_PPC_DARWIN_LO16, // lo16(symbol)
176 VK_PPC_GAS_HA16, // symbol@ha
177 VK_PPC_GAS_LO16 // symbol@l
181 /// The symbol being referenced.
182 const MCSymbol *Symbol;
184 /// The symbol reference modifier.
185 const VariantKind Kind;
187 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
188 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {}
191 /// @name Construction
194 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
195 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
198 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
200 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
207 const MCSymbol &getSymbol() const { return *Symbol; }
209 VariantKind getKind() const { return Kind; }
212 /// @name Static Utility Functions
215 static StringRef getVariantKindName(VariantKind Kind);
217 static VariantKind getVariantKindForName(StringRef Name);
221 static bool classof(const MCExpr *E) {
222 return E->getKind() == MCExpr::SymbolRef;
224 static bool classof(const MCSymbolRefExpr *) { return true; }
227 /// MCUnaryExpr - Unary assembler expressions.
228 class MCUnaryExpr : public MCExpr {
231 LNot, ///< Logical negation.
232 Minus, ///< Unary minus.
233 Not, ///< Bitwise negation.
234 Plus ///< Unary plus.
241 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
242 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
245 /// @name Construction
248 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
250 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
251 return Create(LNot, Expr, Ctx);
253 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
254 return Create(Minus, Expr, Ctx);
256 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
257 return Create(Not, Expr, Ctx);
259 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
260 return Create(Plus, Expr, Ctx);
267 /// getOpcode - Get the kind of this unary expression.
268 Opcode getOpcode() const { return Op; }
270 /// getSubExpr - Get the child of this unary expression.
271 const MCExpr *getSubExpr() const { return Expr; }
275 static bool classof(const MCExpr *E) {
276 return E->getKind() == MCExpr::Unary;
278 static bool classof(const MCUnaryExpr *) { return true; }
281 /// MCBinaryExpr - Binary assembler expressions.
282 class MCBinaryExpr : public MCExpr {
286 And, ///< Bitwise and.
287 Div, ///< Signed division.
288 EQ, ///< Equality comparison.
289 GT, ///< Signed greater than comparison (result is either 0 or some
290 ///< target-specific non-zero value)
291 GTE, ///< Signed greater than or equal comparison (result is either 0 or
292 ///< some target-specific non-zero value).
293 LAnd, ///< Logical and.
294 LOr, ///< Logical or.
295 LT, ///< Signed less than comparison (result is either 0 or
296 ///< some target-specific non-zero value).
297 LTE, ///< Signed less than or equal comparison (result is either 0 or
298 ///< some target-specific non-zero value).
299 Mod, ///< Signed remainder.
300 Mul, ///< Multiplication.
301 NE, ///< Inequality comparison.
303 Shl, ///< Shift left.
304 Shr, ///< Shift right (arithmetic or logical, depending on target)
305 Sub, ///< Subtraction.
306 Xor ///< Bitwise exclusive or.
311 const MCExpr *LHS, *RHS;
313 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
314 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
317 /// @name Construction
320 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
321 const MCExpr *RHS, MCContext &Ctx);
322 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
324 return Create(Add, LHS, RHS, Ctx);
326 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
328 return Create(And, LHS, RHS, Ctx);
330 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
332 return Create(Div, LHS, RHS, Ctx);
334 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
336 return Create(EQ, LHS, RHS, Ctx);
338 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
340 return Create(GT, LHS, RHS, Ctx);
342 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
344 return Create(GTE, LHS, RHS, Ctx);
346 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
348 return Create(LAnd, LHS, RHS, Ctx);
350 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
352 return Create(LOr, LHS, RHS, Ctx);
354 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
356 return Create(LT, LHS, RHS, Ctx);
358 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
360 return Create(LTE, LHS, RHS, Ctx);
362 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
364 return Create(Mod, LHS, RHS, Ctx);
366 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
368 return Create(Mul, LHS, RHS, Ctx);
370 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
372 return Create(NE, LHS, RHS, Ctx);
374 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
376 return Create(Or, LHS, RHS, Ctx);
378 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
380 return Create(Shl, LHS, RHS, Ctx);
382 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
384 return Create(Shr, LHS, RHS, Ctx);
386 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
388 return Create(Sub, LHS, RHS, Ctx);
390 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
392 return Create(Xor, LHS, RHS, Ctx);
399 /// getOpcode - Get the kind of this binary expression.
400 Opcode getOpcode() const { return Op; }
402 /// getLHS - Get the left-hand side expression of the binary operator.
403 const MCExpr *getLHS() const { return LHS; }
405 /// getRHS - Get the right-hand side expression of the binary operator.
406 const MCExpr *getRHS() const { return RHS; }
410 static bool classof(const MCExpr *E) {
411 return E->getKind() == MCExpr::Binary;
413 static bool classof(const MCBinaryExpr *) { return true; }
416 /// MCTargetExpr - This is an extension point for target-specific MCExpr
417 /// subclasses to implement.
419 /// NOTE: All subclasses are required to have trivial destructors because
420 /// MCExprs are bump pointer allocated and not destructed.
421 class MCTargetExpr : public MCExpr {
422 virtual void Anchor();
424 MCTargetExpr() : MCExpr(Target) {}
425 virtual ~MCTargetExpr() {}
428 virtual void PrintImpl(raw_ostream &OS) const = 0;
429 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
430 const MCAsmLayout *Layout) const = 0;
431 virtual void AddValueSymbols(MCAssembler *) const = 0;
432 virtual const MCSection *FindAssociatedSection() const = 0;
434 static bool classof(const MCExpr *E) {
435 return E->getKind() == MCExpr::Target;
437 static bool classof(const MCTargetExpr *) { return true; }
440 } // end namespace llvm