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&); // DO NOT IMPLEMENT
45 void operator=(const MCExpr&); // DO NOT IMPLEMENT
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;
82 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const;
83 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) const;
84 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout,
85 const SectionAddrMap &Addrs) 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;
97 static bool classof(const MCExpr *) { return true; }
100 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
105 //// MCConstantExpr - Represent a constant integer expression.
106 class MCConstantExpr : public MCExpr {
109 explicit MCConstantExpr(int64_t _Value)
110 : MCExpr(MCExpr::Constant), Value(_Value) {}
113 /// @name Construction
116 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
122 int64_t getValue() const { return Value; }
126 static bool classof(const MCExpr *E) {
127 return E->getKind() == MCExpr::Constant;
129 static bool classof(const MCConstantExpr *) { return true; }
132 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
135 /// A symbol reference in an expression may be a use of a label, a use of an
136 /// assembler variable (defined constant), or constitute an implicit definition
137 /// of the symbol as external.
138 class MCSymbolRefExpr : public MCExpr {
157 VK_TLVP, // Mach-O thread local variable relocation
158 // FIXME: We'd really like to use the generic Kinds listed above for these.
159 VK_ARM_PLT, // ARM-style PLT references. i.e., (PLT) instead of @PLT
160 VK_ARM_TLSGD, // ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
167 VK_PPC_HA16, // ha16(symbol)
168 VK_PPC_LO16 // lo16(symbol)
172 /// The symbol being referenced.
173 const MCSymbol *Symbol;
175 /// The symbol reference modifier.
176 const VariantKind Kind;
178 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
179 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {}
182 /// @name Construction
185 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
186 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
189 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
191 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
198 const MCSymbol &getSymbol() const { return *Symbol; }
200 VariantKind getKind() const { return Kind; }
203 /// @name Static Utility Functions
206 static StringRef getVariantKindName(VariantKind Kind);
208 static VariantKind getVariantKindForName(StringRef Name);
212 static bool classof(const MCExpr *E) {
213 return E->getKind() == MCExpr::SymbolRef;
215 static bool classof(const MCSymbolRefExpr *) { return true; }
218 /// MCUnaryExpr - Unary assembler expressions.
219 class MCUnaryExpr : public MCExpr {
222 LNot, ///< Logical negation.
223 Minus, ///< Unary minus.
224 Not, ///< Bitwise negation.
225 Plus ///< Unary plus.
232 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
233 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
236 /// @name Construction
239 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
241 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
242 return Create(LNot, Expr, Ctx);
244 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
245 return Create(Minus, Expr, Ctx);
247 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
248 return Create(Not, Expr, Ctx);
250 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
251 return Create(Plus, Expr, Ctx);
258 /// getOpcode - Get the kind of this unary expression.
259 Opcode getOpcode() const { return Op; }
261 /// getSubExpr - Get the child of this unary expression.
262 const MCExpr *getSubExpr() const { return Expr; }
266 static bool classof(const MCExpr *E) {
267 return E->getKind() == MCExpr::Unary;
269 static bool classof(const MCUnaryExpr *) { return true; }
272 /// MCBinaryExpr - Binary assembler expressions.
273 class MCBinaryExpr : public MCExpr {
277 And, ///< Bitwise and.
278 Div, ///< Signed division.
279 EQ, ///< Equality comparison.
280 GT, ///< Signed greater than comparison (result is either 0 or some
281 ///< target-specific non-zero value)
282 GTE, ///< Signed greater than or equal comparison (result is either 0 or
283 ///< some target-specific non-zero value).
284 LAnd, ///< Logical and.
285 LOr, ///< Logical or.
286 LT, ///< Signed less than comparison (result is either 0 or
287 ///< some target-specific non-zero value).
288 LTE, ///< Signed less than or equal comparison (result is either 0 or
289 ///< some target-specific non-zero value).
290 Mod, ///< Signed remainder.
291 Mul, ///< Multiplication.
292 NE, ///< Inequality comparison.
294 Shl, ///< Shift left.
295 Shr, ///< Shift right (arithmetic or logical, depending on target)
296 Sub, ///< Subtraction.
297 Xor ///< Bitwise exclusive or.
302 const MCExpr *LHS, *RHS;
304 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
305 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
308 /// @name Construction
311 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
312 const MCExpr *RHS, MCContext &Ctx);
313 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
315 return Create(Add, LHS, RHS, Ctx);
317 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
319 return Create(And, LHS, RHS, Ctx);
321 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
323 return Create(Div, LHS, RHS, Ctx);
325 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
327 return Create(EQ, LHS, RHS, Ctx);
329 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
331 return Create(GT, LHS, RHS, Ctx);
333 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
335 return Create(GTE, LHS, RHS, Ctx);
337 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
339 return Create(LAnd, LHS, RHS, Ctx);
341 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
343 return Create(LOr, LHS, RHS, Ctx);
345 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
347 return Create(LT, LHS, RHS, Ctx);
349 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
351 return Create(LTE, LHS, RHS, Ctx);
353 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
355 return Create(Mod, LHS, RHS, Ctx);
357 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
359 return Create(Mul, LHS, RHS, Ctx);
361 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
363 return Create(NE, LHS, RHS, Ctx);
365 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
367 return Create(Or, LHS, RHS, Ctx);
369 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
371 return Create(Shl, LHS, RHS, Ctx);
373 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
375 return Create(Shr, LHS, RHS, Ctx);
377 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
379 return Create(Sub, LHS, RHS, Ctx);
381 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
383 return Create(Xor, LHS, RHS, Ctx);
390 /// getOpcode - Get the kind of this binary expression.
391 Opcode getOpcode() const { return Op; }
393 /// getLHS - Get the left-hand side expression of the binary operator.
394 const MCExpr *getLHS() const { return LHS; }
396 /// getRHS - Get the right-hand side expression of the binary operator.
397 const MCExpr *getRHS() const { return RHS; }
401 static bool classof(const MCExpr *E) {
402 return E->getKind() == MCExpr::Binary;
404 static bool classof(const MCBinaryExpr *) { return true; }
407 /// MCTargetExpr - This is an extension point for target-specific MCExpr
408 /// subclasses to implement.
410 /// NOTE: All subclasses are required to have trivial destructors because
411 /// MCExprs are bump pointer allocated and not destructed.
412 class MCTargetExpr : public MCExpr {
413 virtual void Anchor();
415 MCTargetExpr() : MCExpr(Target) {}
416 virtual ~MCTargetExpr() {}
419 virtual void PrintImpl(raw_ostream &OS) const = 0;
420 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
421 const MCAsmLayout *Layout) const = 0;
422 virtual void AddValueSymbols(MCAssembler *) const = 0;
424 static bool classof(const MCExpr *E) {
425 return E->getKind() == MCExpr::Target;
427 static bool classof(const MCTargetExpr *) { return true; }
430 } // end namespace llvm