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&) LLVM_DELETED_FUNCTION;
45 void operator=(const MCExpr&) LLVM_DELETED_FUNCTION;
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 MCAsmLayout &Layout,
82 const SectionAddrMap &Addrs) const;
83 bool EvaluateAsAbsolute(int64_t &Res) const;
84 bool EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const;
85 bool EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout &Layout) 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) const;
95 /// FindAssociatedSection - Find the "associated section" for this expression,
96 /// which is currently defined as the absolute section for constants, or
97 /// otherwise the section associated with the first defined symbol in the
99 const MCSection *FindAssociatedSection() const;
103 static bool classof(const MCExpr *) { return true; }
106 inline raw_ostream &operator<<(raw_ostream &OS, const MCExpr &E) {
111 //// MCConstantExpr - Represent a constant integer expression.
112 class MCConstantExpr : public MCExpr {
115 explicit MCConstantExpr(int64_t _Value)
116 : MCExpr(MCExpr::Constant), Value(_Value) {}
119 /// @name Construction
122 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
128 int64_t getValue() const { return Value; }
132 static bool classof(const MCExpr *E) {
133 return E->getKind() == MCExpr::Constant;
135 static bool classof(const MCConstantExpr *) { return true; }
138 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
141 /// A symbol reference in an expression may be a use of a label, a use of an
142 /// assembler variable (defined constant), or constitute an implicit definition
143 /// of the symbol as external.
144 class MCSymbolRefExpr : public MCExpr {
163 VK_TLVP, // Mach-O thread local variable relocation
165 // FIXME: We'd really like to use the generic Kinds listed above for these.
166 VK_ARM_PLT, // ARM-style PLT references. i.e., (PLT) instead of @PLT
167 VK_ARM_TLSGD, // ditto for TLSGD, GOT, GOTOFF, TPOFF and GOTTPOFF
174 VK_PPC_TOC, // TOC base
175 VK_PPC_TOC_ENTRY, // TOC entry
176 VK_PPC_DARWIN_HA16, // ha16(symbol)
177 VK_PPC_DARWIN_LO16, // lo16(symbol)
178 VK_PPC_GAS_HA16, // symbol@ha
179 VK_PPC_GAS_LO16, // symbol@l
180 VK_PPC_TPREL16_HA, // symbol@tprel@ha
181 VK_PPC_TPREL16_LO, // symbol@tprel@l
206 /// The symbol being referenced.
207 const MCSymbol *Symbol;
209 /// The symbol reference modifier.
210 const VariantKind Kind;
212 explicit MCSymbolRefExpr(const MCSymbol *_Symbol, VariantKind _Kind)
213 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol), Kind(_Kind) {
218 /// @name Construction
221 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx) {
222 return MCSymbolRefExpr::Create(Symbol, VK_None, Ctx);
225 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, VariantKind Kind,
227 static const MCSymbolRefExpr *Create(StringRef Name, VariantKind Kind,
234 const MCSymbol &getSymbol() const { return *Symbol; }
236 VariantKind getKind() const { return Kind; }
239 /// @name Static Utility Functions
242 static StringRef getVariantKindName(VariantKind Kind);
244 static VariantKind getVariantKindForName(StringRef Name);
248 static bool classof(const MCExpr *E) {
249 return E->getKind() == MCExpr::SymbolRef;
251 static bool classof(const MCSymbolRefExpr *) { return true; }
254 /// MCUnaryExpr - Unary assembler expressions.
255 class MCUnaryExpr : public MCExpr {
258 LNot, ///< Logical negation.
259 Minus, ///< Unary minus.
260 Not, ///< Bitwise negation.
261 Plus ///< Unary plus.
268 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
269 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
272 /// @name Construction
275 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
277 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
278 return Create(LNot, Expr, Ctx);
280 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
281 return Create(Minus, Expr, Ctx);
283 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
284 return Create(Not, Expr, Ctx);
286 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
287 return Create(Plus, Expr, Ctx);
294 /// getOpcode - Get the kind of this unary expression.
295 Opcode getOpcode() const { return Op; }
297 /// getSubExpr - Get the child of this unary expression.
298 const MCExpr *getSubExpr() const { return Expr; }
302 static bool classof(const MCExpr *E) {
303 return E->getKind() == MCExpr::Unary;
305 static bool classof(const MCUnaryExpr *) { return true; }
308 /// MCBinaryExpr - Binary assembler expressions.
309 class MCBinaryExpr : public MCExpr {
313 And, ///< Bitwise and.
314 Div, ///< Signed division.
315 EQ, ///< Equality comparison.
316 GT, ///< Signed greater than comparison (result is either 0 or some
317 ///< target-specific non-zero value)
318 GTE, ///< Signed greater than or equal comparison (result is either 0 or
319 ///< some target-specific non-zero value).
320 LAnd, ///< Logical and.
321 LOr, ///< Logical or.
322 LT, ///< Signed less than comparison (result is either 0 or
323 ///< some target-specific non-zero value).
324 LTE, ///< Signed less than or equal comparison (result is either 0 or
325 ///< some target-specific non-zero value).
326 Mod, ///< Signed remainder.
327 Mul, ///< Multiplication.
328 NE, ///< Inequality comparison.
330 Shl, ///< Shift left.
331 Shr, ///< Shift right (arithmetic or logical, depending on target)
332 Sub, ///< Subtraction.
333 Xor ///< Bitwise exclusive or.
338 const MCExpr *LHS, *RHS;
340 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
341 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
344 /// @name Construction
347 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
348 const MCExpr *RHS, MCContext &Ctx);
349 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
351 return Create(Add, LHS, RHS, Ctx);
353 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
355 return Create(And, LHS, RHS, Ctx);
357 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
359 return Create(Div, LHS, RHS, Ctx);
361 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
363 return Create(EQ, LHS, RHS, Ctx);
365 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
367 return Create(GT, LHS, RHS, Ctx);
369 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
371 return Create(GTE, LHS, RHS, Ctx);
373 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
375 return Create(LAnd, LHS, RHS, Ctx);
377 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
379 return Create(LOr, LHS, RHS, Ctx);
381 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
383 return Create(LT, LHS, RHS, Ctx);
385 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
387 return Create(LTE, LHS, RHS, Ctx);
389 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
391 return Create(Mod, LHS, RHS, Ctx);
393 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
395 return Create(Mul, LHS, RHS, Ctx);
397 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
399 return Create(NE, LHS, RHS, Ctx);
401 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
403 return Create(Or, LHS, RHS, Ctx);
405 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
407 return Create(Shl, LHS, RHS, Ctx);
409 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
411 return Create(Shr, LHS, RHS, Ctx);
413 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
415 return Create(Sub, LHS, RHS, Ctx);
417 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
419 return Create(Xor, LHS, RHS, Ctx);
426 /// getOpcode - Get the kind of this binary expression.
427 Opcode getOpcode() const { return Op; }
429 /// getLHS - Get the left-hand side expression of the binary operator.
430 const MCExpr *getLHS() const { return LHS; }
432 /// getRHS - Get the right-hand side expression of the binary operator.
433 const MCExpr *getRHS() const { return RHS; }
437 static bool classof(const MCExpr *E) {
438 return E->getKind() == MCExpr::Binary;
440 static bool classof(const MCBinaryExpr *) { return true; }
443 /// MCTargetExpr - This is an extension point for target-specific MCExpr
444 /// subclasses to implement.
446 /// NOTE: All subclasses are required to have trivial destructors because
447 /// MCExprs are bump pointer allocated and not destructed.
448 class MCTargetExpr : public MCExpr {
449 virtual void Anchor();
451 MCTargetExpr() : MCExpr(Target) {}
452 virtual ~MCTargetExpr() {}
455 virtual void PrintImpl(raw_ostream &OS) const = 0;
456 virtual bool EvaluateAsRelocatableImpl(MCValue &Res,
457 const MCAsmLayout *Layout) const = 0;
458 virtual void AddValueSymbols(MCAssembler *) const = 0;
459 virtual const MCSection *FindAssociatedSection() const = 0;
461 static bool classof(const MCExpr *E) {
462 return E->getKind() == MCExpr::Target;
464 static bool classof(const MCTargetExpr *) { return true; }
467 } // end namespace llvm