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/Support/DataTypes.h"
26 /// MCExpr - Base class for the full range of assembler expressions which are
27 /// needed for parsing.
31 Binary, ///< Binary expressions.
32 Constant, ///< Constant expressions.
33 SymbolRef, ///< References to labels and assigned expressions.
34 Unary, ///< Unary expressions.
35 Target ///< Target specific expression.
41 MCExpr(const MCExpr&); // DO NOT IMPLEMENT
42 void operator=(const MCExpr&); // DO NOT IMPLEMENT
45 explicit MCExpr(ExprKind _Kind) : Kind(_Kind) {}
47 bool EvaluateAsRelocatableImpl(MCValue &Res, const MCAssembler *Asm,
48 const MCAsmLayout *Layout,
54 ExprKind getKind() const { return Kind; }
57 /// @name Utility Methods
60 void print(raw_ostream &OS) const;
64 /// @name Expression Evaluation
67 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
69 /// @param Res - The absolute value, if evaluation succeeds.
70 /// @param Layout - The assembler layout object to use for evaluating symbol
71 /// values. If not given, then only non-symbolic expressions will be
73 /// @result - True on success.
74 bool EvaluateAsAbsolute(int64_t &Res) const;
75 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm) const;
76 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout *Layout) const;
77 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
78 const MCAsmLayout *Layout) const;
80 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
81 /// value, i.e. an expression of the fixed form (a - b + constant).
83 /// @param Res - The relocatable value, if evaluation succeeds.
84 /// @param Layout - The assembler layout object to use for evaluating values.
85 /// @result - True on success.
86 bool EvaluateAsRelocatable(MCValue &Res, const MCAsmLayout *Layout = 0) const;
90 static bool classof(const MCExpr *) { return true; }
93 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
98 //// MCConstantExpr - Represent a constant integer expression.
99 class MCConstantExpr : public MCExpr {
102 explicit MCConstantExpr(int64_t _Value)
103 : MCExpr(MCExpr::Constant), Value(_Value) {}
106 /// @name Construction
109 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
115 int64_t getValue() const { return Value; }
119 static bool classof(const MCExpr *E) {
120 return E->getKind() == MCExpr::Constant;
122 static bool classof(const MCConstantExpr *) { return true; }
125 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
128 /// A symbol reference in an expression may be a use of a label, a use of an
129 /// assembler variable (defined constant), or constitute an implicit definition
130 /// of the symbol as external.
131 class MCSymbolRefExpr : public MCExpr {
150 VK_TLVP, // Mach-O thread local variable relocation
151 VK_ARM_HI16, // The R_ARM_MOVT_ABS relocation (:upper16: in the .s file)
152 VK_ARM_LO16, // The R_ARM_MOVW_ABS_NC relocation (:lower16: in the .w file)
153 // FIXME: We'd really like to use the generic Kinds listed above for these.
154 VK_ARM_PLT, // ARM-style PLT references. i.e., (PLT) instead of @PLT
155 VK_ARM_TLSGD, // ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
162 VK_PPC_HA16, // ha16(symbol)
163 VK_PPC_LO16 // lo16(symbol)
167 /// The symbol being referenced.
168 const MCSymbol *Symbol;
170 /// The symbol reference modifier.
171 const VariantKind Kind;
173 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
174 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {}
177 /// @name Construction
180 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
181 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
184 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
186 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
193 const MCSymbol &getSymbol() const { return *Symbol; }
195 VariantKind getKind() const { return Kind; }
198 /// @name Static Utility Functions
201 static StringRef getVariantKindName(VariantKind Kind);
203 static VariantKind getVariantKindForName(StringRef Name);
207 static bool classof(const MCExpr *E) {
208 return E->getKind() == MCExpr::SymbolRef;
210 static bool classof(const MCSymbolRefExpr *) { return true; }
213 /// MCUnaryExpr - Unary assembler expressions.
214 class MCUnaryExpr : public MCExpr {
217 LNot, ///< Logical negation.
218 Minus, ///< Unary minus.
219 Not, ///< Bitwise negation.
220 Plus ///< Unary plus.
227 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
228 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
231 /// @name Construction
234 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
236 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
237 return Create(LNot, Expr, Ctx);
239 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
240 return Create(Minus, Expr, Ctx);
242 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
243 return Create(Not, Expr, Ctx);
245 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
246 return Create(Plus, Expr, Ctx);
253 /// getOpcode - Get the kind of this unary expression.
254 Opcode getOpcode() const { return Op; }
256 /// getSubExpr - Get the child of this unary expression.
257 const MCExpr *getSubExpr() const { return Expr; }
261 static bool classof(const MCExpr *E) {
262 return E->getKind() == MCExpr::Unary;
264 static bool classof(const MCUnaryExpr *) { return true; }
267 /// MCBinaryExpr - Binary assembler expressions.
268 class MCBinaryExpr : public MCExpr {
272 And, ///< Bitwise and.
273 Div, ///< Signed division.
274 EQ, ///< Equality comparison.
275 GT, ///< Signed greater than comparison (result is either 0 or some
276 ///< target-specific non-zero value)
277 GTE, ///< Signed greater than or equal comparison (result is either 0 or
278 ///< some target-specific non-zero value).
279 LAnd, ///< Logical and.
280 LOr, ///< Logical or.
281 LT, ///< Signed less than comparison (result is either 0 or
282 ///< some target-specific non-zero value).
283 LTE, ///< Signed less than or equal comparison (result is either 0 or
284 ///< some target-specific non-zero value).
285 Mod, ///< Signed remainder.
286 Mul, ///< Multiplication.
287 NE, ///< Inequality comparison.
289 Shl, ///< Shift left.
290 Shr, ///< Shift right (arithmetic or logical, depending on target)
291 Sub, ///< Subtraction.
292 Xor ///< Bitwise exclusive or.
297 const MCExpr *LHS, *RHS;
299 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
300 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
303 /// @name Construction
306 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
307 const MCExpr *RHS, MCContext &Ctx);
308 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
310 return Create(Add, LHS, RHS, Ctx);
312 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
314 return Create(And, LHS, RHS, Ctx);
316 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
318 return Create(Div, LHS, RHS, Ctx);
320 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
322 return Create(EQ, LHS, RHS, Ctx);
324 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
326 return Create(GT, LHS, RHS, Ctx);
328 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
330 return Create(GTE, LHS, RHS, Ctx);
332 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
334 return Create(LAnd, LHS, RHS, Ctx);
336 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
338 return Create(LOr, LHS, RHS, Ctx);
340 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
342 return Create(LT, LHS, RHS, Ctx);
344 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
346 return Create(LTE, LHS, RHS, Ctx);
348 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
350 return Create(Mod, LHS, RHS, Ctx);
352 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
354 return Create(Mul, LHS, RHS, Ctx);
356 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
358 return Create(NE, LHS, RHS, Ctx);
360 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
362 return Create(Or, LHS, RHS, Ctx);
364 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
366 return Create(Shl, LHS, RHS, Ctx);
368 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
370 return Create(Shr, LHS, RHS, Ctx);
372 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
374 return Create(Sub, LHS, RHS, Ctx);
376 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
378 return Create(Xor, LHS, RHS, Ctx);
385 /// getOpcode - Get the kind of this binary expression.
386 Opcode getOpcode() const { return Op; }
388 /// getLHS - Get the left-hand side expression of the binary operator.
389 const MCExpr *getLHS() const { return LHS; }
391 /// getRHS - Get the right-hand side expression of the binary operator.
392 const MCExpr *getRHS() const { return RHS; }
396 static bool classof(const MCExpr *E) {
397 return E->getKind() == MCExpr::Binary;
399 static bool classof(const MCBinaryExpr *) { return true; }
402 /// MCTargetExpr - This is an extension point for target-specific MCExpr
403 /// subclasses to implement.
405 /// NOTE: All subclasses are required to have trivial destructors because
406 /// MCExprs are bump pointer allocated and not destructed.
407 class MCTargetExpr : public MCExpr {
408 virtual void Anchor();
410 MCTargetExpr() : MCExpr(Target) {}
411 virtual ~MCTargetExpr() {}
414 virtual void PrintImpl(raw_ostream &OS) const = 0;
415 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
416 const MCAsmLayout *Layout) const = 0;
419 static bool classof(const MCExpr *E) {
420 return E->getKind() == MCExpr::Target;
422 static bool classof(const MCTargetExpr *) { return true; }
425 } // end namespace llvm