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_TLVP, // Mach-O thread local variable relocation
145 VK_ARM_HI16, // The R_ARM_MOVT_ABS relocation (:upper16: in the .s file)
146 VK_ARM_LO16, // The R_ARM_MOVW_ABS_NC relocation (:lower16: in the .w file)
147 // FIXME: We'd really like to use the generic Kinds listed above for these.
148 VK_ARM_PLT, // ARM-style PLT references. i.e., (PLT) instead of @PLT
149 VK_ARM_TLSGD, // ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
159 /// The symbol being referenced.
160 const MCSymbol *Symbol;
162 /// The symbol reference modifier.
163 const VariantKind Kind;
165 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
166 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {}
169 /// @name Construction
172 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
173 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
176 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
178 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
185 const MCSymbol &getSymbol() const { return *Symbol; }
187 VariantKind getKind() const { return Kind; }
190 /// @name Static Utility Functions
193 static StringRef getVariantKindName(VariantKind Kind);
195 static VariantKind getVariantKindForName(StringRef Name);
199 static bool classof(const MCExpr *E) {
200 return E->getKind() == MCExpr::SymbolRef;
202 static bool classof(const MCSymbolRefExpr *) { return true; }
205 /// MCUnaryExpr - Unary assembler expressions.
206 class MCUnaryExpr : public MCExpr {
209 LNot, ///< Logical negation.
210 Minus, ///< Unary minus.
211 Not, ///< Bitwise negation.
212 Plus ///< Unary plus.
219 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
220 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
223 /// @name Construction
226 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
228 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
229 return Create(LNot, Expr, Ctx);
231 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
232 return Create(Minus, Expr, Ctx);
234 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
235 return Create(Not, Expr, Ctx);
237 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
238 return Create(Plus, Expr, Ctx);
245 /// getOpcode - Get the kind of this unary expression.
246 Opcode getOpcode() const { return Op; }
248 /// getSubExpr - Get the child of this unary expression.
249 const MCExpr *getSubExpr() const { return Expr; }
253 static bool classof(const MCExpr *E) {
254 return E->getKind() == MCExpr::Unary;
256 static bool classof(const MCUnaryExpr *) { return true; }
259 /// MCBinaryExpr - Binary assembler expressions.
260 class MCBinaryExpr : public MCExpr {
264 And, ///< Bitwise and.
265 Div, ///< Signed division.
266 EQ, ///< Equality comparison.
267 GT, ///< Signed greater than comparison (result is either 0 or some
268 ///< target-specific non-zero value)
269 GTE, ///< Signed greater than or equal comparison (result is either 0 or
270 ///< some target-specific non-zero value).
271 LAnd, ///< Logical and.
272 LOr, ///< Logical or.
273 LT, ///< Signed less than comparison (result is either 0 or
274 ///< some target-specific non-zero value).
275 LTE, ///< Signed less than or equal comparison (result is either 0 or
276 ///< some target-specific non-zero value).
277 Mod, ///< Signed remainder.
278 Mul, ///< Multiplication.
279 NE, ///< Inequality comparison.
281 Shl, ///< Shift left.
282 Shr, ///< Shift right (arithmetic or logical, depending on target)
283 Sub, ///< Subtraction.
284 Xor ///< Bitwise exclusive or.
289 const MCExpr *LHS, *RHS;
291 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
292 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
295 /// @name Construction
298 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
299 const MCExpr *RHS, MCContext &Ctx);
300 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
302 return Create(Add, LHS, RHS, Ctx);
304 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
306 return Create(And, LHS, RHS, Ctx);
308 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
310 return Create(Div, LHS, RHS, Ctx);
312 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
314 return Create(EQ, LHS, RHS, Ctx);
316 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
318 return Create(GT, LHS, RHS, Ctx);
320 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
322 return Create(GTE, LHS, RHS, Ctx);
324 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
326 return Create(LAnd, LHS, RHS, Ctx);
328 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
330 return Create(LOr, LHS, RHS, Ctx);
332 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
334 return Create(LT, LHS, RHS, Ctx);
336 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
338 return Create(LTE, LHS, RHS, Ctx);
340 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
342 return Create(Mod, LHS, RHS, Ctx);
344 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
346 return Create(Mul, LHS, RHS, Ctx);
348 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
350 return Create(NE, LHS, RHS, Ctx);
352 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
354 return Create(Or, LHS, RHS, Ctx);
356 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
358 return Create(Shl, LHS, RHS, Ctx);
360 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
362 return Create(Shr, LHS, RHS, Ctx);
364 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
366 return Create(Sub, LHS, RHS, Ctx);
368 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
370 return Create(Xor, LHS, RHS, Ctx);
377 /// getOpcode - Get the kind of this binary expression.
378 Opcode getOpcode() const { return Op; }
380 /// getLHS - Get the left-hand side expression of the binary operator.
381 const MCExpr *getLHS() const { return LHS; }
383 /// getRHS - Get the right-hand side expression of the binary operator.
384 const MCExpr *getRHS() const { return RHS; }
388 static bool classof(const MCExpr *E) {
389 return E->getKind() == MCExpr::Binary;
391 static bool classof(const MCBinaryExpr *) { return true; }
394 /// MCTargetExpr - This is an extension point for target-specific MCExpr
395 /// subclasses to implement.
397 /// NOTE: All subclasses are required to have trivial destructors because
398 /// MCExprs are bump pointer allocated and not destructed.
399 class MCTargetExpr : public MCExpr {
400 virtual void Anchor();
402 MCTargetExpr() : MCExpr(Target) {}
403 virtual ~MCTargetExpr() {}
406 virtual void PrintImpl(raw_ostream &OS) const = 0;
407 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
408 const MCAsmLayout *Layout) const = 0;
411 static bool classof(const MCExpr *E) {
412 return E->getKind() == MCExpr::Target;
414 static bool classof(const MCTargetExpr *) { return true; }
417 } // end namespace llvm