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 = 0) 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 VK_ARM_HI16, // The R_ARM_MOVT_ABS relocation (:upper16: in the .s file)
159 VK_ARM_LO16, // The R_ARM_MOVW_ABS_NC relocation (:lower16: in the .w file)
160 // FIXME: We'd really like to use the generic Kinds listed above for these.
161 VK_ARM_PLT, // ARM-style PLT references. i.e., (PLT) instead of @PLT
162 VK_ARM_TLSGD, // ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
169 VK_PPC_HA16, // ha16(symbol)
170 VK_PPC_LO16 // lo16(symbol)
174 /// The symbol being referenced.
175 const MCSymbol *Symbol;
177 /// The symbol reference modifier.
178 const VariantKind Kind;
180 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
181 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {}
184 /// @name Construction
187 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
188 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
191 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
193 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
200 const MCSymbol &getSymbol() const { return *Symbol; }
202 VariantKind getKind() const { return Kind; }
205 /// @name Static Utility Functions
208 static StringRef getVariantKindName(VariantKind Kind);
210 static VariantKind getVariantKindForName(StringRef Name);
214 static bool classof(const MCExpr *E) {
215 return E->getKind() == MCExpr::SymbolRef;
217 static bool classof(const MCSymbolRefExpr *) { return true; }
220 /// MCUnaryExpr - Unary assembler expressions.
221 class MCUnaryExpr : public MCExpr {
224 LNot, ///< Logical negation.
225 Minus, ///< Unary minus.
226 Not, ///< Bitwise negation.
227 Plus ///< Unary plus.
234 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
235 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
238 /// @name Construction
241 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
243 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
244 return Create(LNot, Expr, Ctx);
246 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
247 return Create(Minus, Expr, Ctx);
249 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
250 return Create(Not, Expr, Ctx);
252 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
253 return Create(Plus, Expr, Ctx);
260 /// getOpcode - Get the kind of this unary expression.
261 Opcode getOpcode() const { return Op; }
263 /// getSubExpr - Get the child of this unary expression.
264 const MCExpr *getSubExpr() const { return Expr; }
268 static bool classof(const MCExpr *E) {
269 return E->getKind() == MCExpr::Unary;
271 static bool classof(const MCUnaryExpr *) { return true; }
274 /// MCBinaryExpr - Binary assembler expressions.
275 class MCBinaryExpr : public MCExpr {
279 And, ///< Bitwise and.
280 Div, ///< Signed division.
281 EQ, ///< Equality comparison.
282 GT, ///< Signed greater than comparison (result is either 0 or some
283 ///< target-specific non-zero value)
284 GTE, ///< Signed greater than or equal comparison (result is either 0 or
285 ///< some target-specific non-zero value).
286 LAnd, ///< Logical and.
287 LOr, ///< Logical or.
288 LT, ///< Signed less than comparison (result is either 0 or
289 ///< some target-specific non-zero value).
290 LTE, ///< Signed less than or equal comparison (result is either 0 or
291 ///< some target-specific non-zero value).
292 Mod, ///< Signed remainder.
293 Mul, ///< Multiplication.
294 NE, ///< Inequality comparison.
296 Shl, ///< Shift left.
297 Shr, ///< Shift right (arithmetic or logical, depending on target)
298 Sub, ///< Subtraction.
299 Xor ///< Bitwise exclusive or.
304 const MCExpr *LHS, *RHS;
306 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
307 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
310 /// @name Construction
313 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
314 const MCExpr *RHS, MCContext &Ctx);
315 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
317 return Create(Add, LHS, RHS, Ctx);
319 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
321 return Create(And, LHS, RHS, Ctx);
323 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
325 return Create(Div, LHS, RHS, Ctx);
327 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
329 return Create(EQ, LHS, RHS, Ctx);
331 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
333 return Create(GT, LHS, RHS, Ctx);
335 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
337 return Create(GTE, LHS, RHS, Ctx);
339 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
341 return Create(LAnd, LHS, RHS, Ctx);
343 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
345 return Create(LOr, LHS, RHS, Ctx);
347 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
349 return Create(LT, LHS, RHS, Ctx);
351 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
353 return Create(LTE, LHS, RHS, Ctx);
355 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
357 return Create(Mod, LHS, RHS, Ctx);
359 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
361 return Create(Mul, LHS, RHS, Ctx);
363 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
365 return Create(NE, LHS, RHS, Ctx);
367 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
369 return Create(Or, LHS, RHS, Ctx);
371 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
373 return Create(Shl, LHS, RHS, Ctx);
375 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
377 return Create(Shr, LHS, RHS, Ctx);
379 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
381 return Create(Sub, LHS, RHS, Ctx);
383 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
385 return Create(Xor, LHS, RHS, Ctx);
392 /// getOpcode - Get the kind of this binary expression.
393 Opcode getOpcode() const { return Op; }
395 /// getLHS - Get the left-hand side expression of the binary operator.
396 const MCExpr *getLHS() const { return LHS; }
398 /// getRHS - Get the right-hand side expression of the binary operator.
399 const MCExpr *getRHS() const { return RHS; }
403 static bool classof(const MCExpr *E) {
404 return E->getKind() == MCExpr::Binary;
406 static bool classof(const MCBinaryExpr *) { return true; }
409 /// MCTargetExpr - This is an extension point for target-specific MCExpr
410 /// subclasses to implement.
412 /// NOTE: All subclasses are required to have trivial destructors because
413 /// MCExprs are bump pointer allocated and not destructed.
414 class MCTargetExpr : public MCExpr {
415 virtual void Anchor();
417 MCTargetExpr() : MCExpr(Target) {}
418 virtual ~MCTargetExpr() {}
421 virtual void PrintImpl(raw_ostream &OS) const = 0;
422 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
423 const MCAsmLayout *Layout) const = 0;
426 static bool classof(const MCExpr *E) {
427 return E->getKind() == MCExpr::Target;
429 static bool classof(const MCTargetExpr *) { return true; }
432 } // end namespace llvm