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) {}
50 ExprKind getKind() const { return Kind; }
53 /// @name Utility Methods
56 void print(raw_ostream &OS) const;
60 /// @name Expression Evaluation
63 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
65 /// @param Res - The absolute value, if evaluation succeeds.
66 /// @param Layout - The assembler layout object to use for evaluating symbol
67 /// values. If not given, then only non-symbolic expressions will be
69 /// @result - True on success.
70 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout *Layout = 0) const;
72 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
73 /// value, i.e. an expression of the fixed form (a - b + constant).
75 /// @param Res - The relocatable value, if evaluation succeeds.
76 /// @param Layout - The assembler layout object to use for evaluating values.
77 /// @result - True on success.
78 bool EvaluateAsRelocatable(MCValue &Res, const MCAsmLayout *Layout = 0) const;
82 static bool classof(const MCExpr *) { return true; }
85 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
90 //// MCConstantExpr - Represent a constant integer expression.
91 class MCConstantExpr : public MCExpr {
94 explicit MCConstantExpr(int64_t _Value)
95 : MCExpr(MCExpr::Constant), Value(_Value) {}
98 /// @name Construction
101 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
107 int64_t getValue() const { return Value; }
111 static bool classof(const MCExpr *E) {
112 return E->getKind() == MCExpr::Constant;
114 static bool classof(const MCConstantExpr *) { return true; }
117 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
120 /// A symbol reference in an expression may be a use of a label, a use of an
121 /// assembler variable (defined constant), or constitute an implicit definition
122 /// of the symbol as external.
123 class MCSymbolRefExpr : public MCExpr {
138 VK_ARM_HI16, // The R_ARM_MOVT_ABS relocation (:upper16: in the asm file)
139 VK_ARM_LO16 // The R_ARM_MOVW_ABS_NC relocation (:lower16: in the asm file)
143 /// The symbol being referenced.
144 const MCSymbol *Symbol;
146 /// The symbol reference modifier.
147 const VariantKind Kind;
149 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
150 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {}
153 /// @name Construction
156 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
157 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
160 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
162 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
169 const MCSymbol &getSymbol() const { return *Symbol; }
171 VariantKind getKind() const { return Kind; }
174 /// @name Static Utility Functions
177 static StringRef getVariantKindName(VariantKind Kind);
179 static VariantKind getVariantKindForName(StringRef Name);
183 static bool classof(const MCExpr *E) {
184 return E->getKind() == MCExpr::SymbolRef;
186 static bool classof(const MCSymbolRefExpr *) { return true; }
189 /// MCUnaryExpr - Unary assembler expressions.
190 class MCUnaryExpr : public MCExpr {
193 LNot, ///< Logical negation.
194 Minus, ///< Unary minus.
195 Not, ///< Bitwise negation.
196 Plus ///< Unary plus.
203 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
204 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
207 /// @name Construction
210 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
212 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
213 return Create(LNot, Expr, Ctx);
215 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
216 return Create(Minus, Expr, Ctx);
218 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
219 return Create(Not, Expr, Ctx);
221 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
222 return Create(Plus, Expr, Ctx);
229 /// getOpcode - Get the kind of this unary expression.
230 Opcode getOpcode() const { return Op; }
232 /// getSubExpr - Get the child of this unary expression.
233 const MCExpr *getSubExpr() const { return Expr; }
237 static bool classof(const MCExpr *E) {
238 return E->getKind() == MCExpr::Unary;
240 static bool classof(const MCUnaryExpr *) { return true; }
243 /// MCBinaryExpr - Binary assembler expressions.
244 class MCBinaryExpr : public MCExpr {
248 And, ///< Bitwise and.
249 Div, ///< Signed division.
250 EQ, ///< Equality comparison.
251 GT, ///< Signed greater than comparison (result is either 0 or some
252 ///< target-specific non-zero value)
253 GTE, ///< Signed greater than or equal comparison (result is either 0 or
254 ///< some target-specific non-zero value).
255 LAnd, ///< Logical and.
256 LOr, ///< Logical or.
257 LT, ///< Signed less than comparison (result is either 0 or
258 ///< some target-specific non-zero value).
259 LTE, ///< Signed less than or equal comparison (result is either 0 or
260 ///< some target-specific non-zero value).
261 Mod, ///< Signed remainder.
262 Mul, ///< Multiplication.
263 NE, ///< Inequality comparison.
265 Shl, ///< Shift left.
266 Shr, ///< Shift right (arithmetic or logical, depending on target)
267 Sub, ///< Subtraction.
268 Xor ///< Bitwise exclusive or.
273 const MCExpr *LHS, *RHS;
275 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
276 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
279 /// @name Construction
282 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
283 const MCExpr *RHS, MCContext &Ctx);
284 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
286 return Create(Add, LHS, RHS, Ctx);
288 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
290 return Create(And, LHS, RHS, Ctx);
292 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
294 return Create(Div, LHS, RHS, Ctx);
296 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
298 return Create(EQ, LHS, RHS, Ctx);
300 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
302 return Create(GT, LHS, RHS, Ctx);
304 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
306 return Create(GTE, LHS, RHS, Ctx);
308 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
310 return Create(LAnd, LHS, RHS, Ctx);
312 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
314 return Create(LOr, LHS, RHS, Ctx);
316 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
318 return Create(LT, LHS, RHS, Ctx);
320 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
322 return Create(LTE, LHS, RHS, Ctx);
324 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
326 return Create(Mod, LHS, RHS, Ctx);
328 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
330 return Create(Mul, LHS, RHS, Ctx);
332 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
334 return Create(NE, LHS, RHS, Ctx);
336 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
338 return Create(Or, LHS, RHS, Ctx);
340 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
342 return Create(Shl, LHS, RHS, Ctx);
344 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
346 return Create(Shr, LHS, RHS, Ctx);
348 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
350 return Create(Sub, LHS, RHS, Ctx);
352 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
354 return Create(Xor, LHS, RHS, Ctx);
361 /// getOpcode - Get the kind of this binary expression.
362 Opcode getOpcode() const { return Op; }
364 /// getLHS - Get the left-hand side expression of the binary operator.
365 const MCExpr *getLHS() const { return LHS; }
367 /// getRHS - Get the right-hand side expression of the binary operator.
368 const MCExpr *getRHS() const { return RHS; }
372 static bool classof(const MCExpr *E) {
373 return E->getKind() == MCExpr::Binary;
375 static bool classof(const MCBinaryExpr *) { return true; }
378 /// MCTargetExpr - This is an extension point for target-specific MCExpr
379 /// subclasses to implement.
381 /// NOTE: All subclasses are required to have trivial destructors because
382 /// MCExprs are bump pointer allocated and not destructed.
383 class MCTargetExpr : public MCExpr {
384 virtual void Anchor();
386 MCTargetExpr() : MCExpr(Target) {}
387 virtual ~MCTargetExpr() {}
390 virtual void PrintImpl(raw_ostream &OS) const = 0;
391 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
392 const MCAsmLayout *Layout) const = 0;
395 static bool classof(const MCExpr *E) {
396 return E->getKind() == MCExpr::Target;
398 static bool classof(const MCTargetExpr *) { return true; }
401 } // end namespace llvm