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/Support/Casting.h"
14 #include "llvm/System/DataTypes.h"
25 /// MCExpr - Base class for the full range of assembler expressions which are
26 /// needed for parsing.
30 Binary, ///< Binary expressions.
31 Constant, ///< Constant expressions.
32 SymbolRef, ///< References to labels and assigned expressions.
33 Unary, ///< Unary expressions.
34 Target ///< Target specific expression.
40 MCExpr(const MCExpr&); // DO NOT IMPLEMENT
41 void operator=(const MCExpr&); // DO NOT IMPLEMENT
44 explicit MCExpr(ExprKind _Kind) : Kind(_Kind) {}
46 bool EvaluateAsRelocatableImpl(MCValue &Res, const MCAsmLayout *Layout,
52 ExprKind getKind() const { return Kind; }
55 /// @name Utility Methods
58 void print(raw_ostream &OS) const;
62 /// @name Expression Evaluation
65 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
67 /// @param Res - The absolute value, if evaluation succeeds.
68 /// @param Layout - The assembler layout object to use for evaluating symbol
69 /// values. If not given, then only non-symbolic expressions will be
71 /// @result - True on success.
72 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout *Layout = 0) const;
74 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
75 /// value, i.e. an expression of the fixed form (a - b + constant).
77 /// @param Res - The relocatable value, if evaluation succeeds.
78 /// @param Layout - The assembler layout object to use for evaluating values.
79 /// @result - True on success.
80 bool EvaluateAsRelocatable(MCValue &Res, const MCAsmLayout *Layout = 0) const;
84 static bool classof(const MCExpr *) { return true; }
87 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
92 //// MCConstantExpr - Represent a constant integer expression.
93 class MCConstantExpr : public MCExpr {
96 explicit MCConstantExpr(int64_t _Value)
97 : MCExpr(MCExpr::Constant), Value(_Value) {}
100 /// @name Construction
103 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
109 int64_t getValue() const { return Value; }
113 static bool classof(const MCExpr *E) {
114 return E->getKind() == MCExpr::Constant;
116 static bool classof(const MCConstantExpr *) { return true; }
119 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
122 /// A symbol reference in an expression may be a use of a label, a use of an
123 /// assembler variable (defined constant), or constitute an implicit definition
124 /// of the symbol as external.
125 class MCSymbolRefExpr : public MCExpr {
144 VK_ARM_HI16, // The R_ARM_MOVT_ABS relocation (:upper16: in the .s file)
145 VK_ARM_LO16, // The R_ARM_MOVW_ABS_NC relocation (:lower16: in the .w file)
146 // FIXME: We'd really like to use the generic Kinds listed above for these.
147 VK_ARM_PLT, // ARM-style PLT references. i.e., (PLT) instead of @PLT
148 VK_ARM_TLSGD, // ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
153 VK_TLVP // Mach-O thread local variable relocation
157 /// The symbol being referenced.
158 const MCSymbol *Symbol;
160 /// The symbol reference modifier.
161 const VariantKind Kind;
163 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
164 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {}
167 /// @name Construction
170 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
171 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
174 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
176 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
183 const MCSymbol &getSymbol() const { return *Symbol; }
185 VariantKind getKind() const { return Kind; }
188 /// @name Static Utility Functions
191 static StringRef getVariantKindName(VariantKind Kind);
193 static VariantKind getVariantKindForName(StringRef Name);
197 static bool classof(const MCExpr *E) {
198 return E->getKind() == MCExpr::SymbolRef;
200 static bool classof(const MCSymbolRefExpr *) { return true; }
203 /// MCUnaryExpr - Unary assembler expressions.
204 class MCUnaryExpr : public MCExpr {
207 LNot, ///< Logical negation.
208 Minus, ///< Unary minus.
209 Not, ///< Bitwise negation.
210 Plus ///< Unary plus.
217 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
218 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
221 /// @name Construction
224 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
226 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
227 return Create(LNot, Expr, Ctx);
229 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
230 return Create(Minus, Expr, Ctx);
232 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
233 return Create(Not, Expr, Ctx);
235 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
236 return Create(Plus, Expr, Ctx);
243 /// getOpcode - Get the kind of this unary expression.
244 Opcode getOpcode() const { return Op; }
246 /// getSubExpr - Get the child of this unary expression.
247 const MCExpr *getSubExpr() const { return Expr; }
251 static bool classof(const MCExpr *E) {
252 return E->getKind() == MCExpr::Unary;
254 static bool classof(const MCUnaryExpr *) { return true; }
257 /// MCBinaryExpr - Binary assembler expressions.
258 class MCBinaryExpr : public MCExpr {
262 And, ///< Bitwise and.
263 Div, ///< Signed division.
264 EQ, ///< Equality comparison.
265 GT, ///< Signed greater than comparison (result is either 0 or some
266 ///< target-specific non-zero value)
267 GTE, ///< Signed greater than or equal comparison (result is either 0 or
268 ///< some target-specific non-zero value).
269 LAnd, ///< Logical and.
270 LOr, ///< Logical or.
271 LT, ///< Signed less than comparison (result is either 0 or
272 ///< some target-specific non-zero value).
273 LTE, ///< Signed less than or equal comparison (result is either 0 or
274 ///< some target-specific non-zero value).
275 Mod, ///< Signed remainder.
276 Mul, ///< Multiplication.
277 NE, ///< Inequality comparison.
279 Shl, ///< Shift left.
280 Shr, ///< Shift right (arithmetic or logical, depending on target)
281 Sub, ///< Subtraction.
282 Xor ///< Bitwise exclusive or.
287 const MCExpr *LHS, *RHS;
289 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
290 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
293 /// @name Construction
296 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
297 const MCExpr *RHS, MCContext &Ctx);
298 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
300 return Create(Add, LHS, RHS, Ctx);
302 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
304 return Create(And, LHS, RHS, Ctx);
306 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
308 return Create(Div, LHS, RHS, Ctx);
310 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
312 return Create(EQ, LHS, RHS, Ctx);
314 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
316 return Create(GT, LHS, RHS, Ctx);
318 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
320 return Create(GTE, LHS, RHS, Ctx);
322 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
324 return Create(LAnd, LHS, RHS, Ctx);
326 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
328 return Create(LOr, LHS, RHS, Ctx);
330 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
332 return Create(LT, LHS, RHS, Ctx);
334 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
336 return Create(LTE, LHS, RHS, Ctx);
338 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
340 return Create(Mod, LHS, RHS, Ctx);
342 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
344 return Create(Mul, LHS, RHS, Ctx);
346 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
348 return Create(NE, LHS, RHS, Ctx);
350 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
352 return Create(Or, LHS, RHS, Ctx);
354 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
356 return Create(Shl, LHS, RHS, Ctx);
358 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
360 return Create(Shr, LHS, RHS, Ctx);
362 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
364 return Create(Sub, LHS, RHS, Ctx);
366 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
368 return Create(Xor, LHS, RHS, Ctx);
375 /// getOpcode - Get the kind of this binary expression.
376 Opcode getOpcode() const { return Op; }
378 /// getLHS - Get the left-hand side expression of the binary operator.
379 const MCExpr *getLHS() const { return LHS; }
381 /// getRHS - Get the right-hand side expression of the binary operator.
382 const MCExpr *getRHS() const { return RHS; }
386 static bool classof(const MCExpr *E) {
387 return E->getKind() == MCExpr::Binary;
389 static bool classof(const MCBinaryExpr *) { return true; }
392 /// MCTargetExpr - This is an extension point for target-specific MCExpr
393 /// subclasses to implement.
395 /// NOTE: All subclasses are required to have trivial destructors because
396 /// MCExprs are bump pointer allocated and not destructed.
397 class MCTargetExpr : public MCExpr {
398 virtual void Anchor();
400 MCTargetExpr() : MCExpr(Target) {}
401 virtual ~MCTargetExpr() {}
404 virtual void PrintImpl(raw_ostream &OS) const = 0;
405 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
406 const MCAsmLayout *Layout) const = 0;
409 static bool classof(const MCExpr *E) {
410 return E->getKind() == MCExpr::Target;
412 static bool classof(const MCTargetExpr *) { return true; }
415 } // end namespace llvm