1 //===- MCExpr.cpp - Assembly Level Expression Implementation --------------===//
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 #define DEBUG_TYPE "mcexpr"
11 #include "llvm/MC/MCExpr.h"
12 #include "llvm/ADT/Statistic.h"
13 #include "llvm/ADT/StringSwitch.h"
14 #include "llvm/MC/MCAsmLayout.h"
15 #include "llvm/MC/MCAssembler.h"
16 #include "llvm/MC/MCContext.h"
17 #include "llvm/MC/MCSymbol.h"
18 #include "llvm/MC/MCValue.h"
19 #include "llvm/Support/Debug.h"
20 #include "llvm/Support/raw_ostream.h"
21 #include "llvm/Target/TargetAsmBackend.h"
26 STATISTIC(MCExprEvaluate, "Number of MCExpr evaluations");
30 void MCExpr::print(raw_ostream &OS) const {
33 return cast<MCTargetExpr>(this)->PrintImpl(OS);
34 case MCExpr::Constant:
35 OS << cast<MCConstantExpr>(*this).getValue();
38 case MCExpr::SymbolRef: {
39 const MCSymbolRefExpr &SRE = cast<MCSymbolRefExpr>(*this);
40 const MCSymbol &Sym = SRE.getSymbol();
42 if (SRE.getKind() == MCSymbolRefExpr::VK_ARM_HI16 ||
43 SRE.getKind() == MCSymbolRefExpr::VK_ARM_LO16)
44 OS << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
46 // Parenthesize names that start with $ so that they don't look like
48 if (Sym.getName()[0] == '$')
49 OS << '(' << Sym << ')';
53 if (SRE.getKind() != MCSymbolRefExpr::VK_None &&
54 SRE.getKind() != MCSymbolRefExpr::VK_ARM_HI16 &&
55 SRE.getKind() != MCSymbolRefExpr::VK_ARM_LO16)
56 OS << '@' << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
62 const MCUnaryExpr &UE = cast<MCUnaryExpr>(*this);
63 switch (UE.getOpcode()) {
64 default: assert(0 && "Invalid opcode!");
65 case MCUnaryExpr::LNot: OS << '!'; break;
66 case MCUnaryExpr::Minus: OS << '-'; break;
67 case MCUnaryExpr::Not: OS << '~'; break;
68 case MCUnaryExpr::Plus: OS << '+'; break;
70 OS << *UE.getSubExpr();
74 case MCExpr::Binary: {
75 const MCBinaryExpr &BE = cast<MCBinaryExpr>(*this);
77 // Only print parens around the LHS if it is non-trivial.
78 if (isa<MCConstantExpr>(BE.getLHS()) || isa<MCSymbolRefExpr>(BE.getLHS())) {
81 OS << '(' << *BE.getLHS() << ')';
84 switch (BE.getOpcode()) {
85 default: assert(0 && "Invalid opcode!");
86 case MCBinaryExpr::Add:
87 // Print "X-42" instead of "X+-42".
88 if (const MCConstantExpr *RHSC = dyn_cast<MCConstantExpr>(BE.getRHS())) {
89 if (RHSC->getValue() < 0) {
90 OS << RHSC->getValue();
97 case MCBinaryExpr::And: OS << '&'; break;
98 case MCBinaryExpr::Div: OS << '/'; break;
99 case MCBinaryExpr::EQ: OS << "=="; break;
100 case MCBinaryExpr::GT: OS << '>'; break;
101 case MCBinaryExpr::GTE: OS << ">="; break;
102 case MCBinaryExpr::LAnd: OS << "&&"; break;
103 case MCBinaryExpr::LOr: OS << "||"; break;
104 case MCBinaryExpr::LT: OS << '<'; break;
105 case MCBinaryExpr::LTE: OS << "<="; break;
106 case MCBinaryExpr::Mod: OS << '%'; break;
107 case MCBinaryExpr::Mul: OS << '*'; break;
108 case MCBinaryExpr::NE: OS << "!="; break;
109 case MCBinaryExpr::Or: OS << '|'; break;
110 case MCBinaryExpr::Shl: OS << "<<"; break;
111 case MCBinaryExpr::Shr: OS << ">>"; break;
112 case MCBinaryExpr::Sub: OS << '-'; break;
113 case MCBinaryExpr::Xor: OS << '^'; break;
116 // Only print parens around the LHS if it is non-trivial.
117 if (isa<MCConstantExpr>(BE.getRHS()) || isa<MCSymbolRefExpr>(BE.getRHS())) {
120 OS << '(' << *BE.getRHS() << ')';
126 assert(0 && "Invalid expression kind!");
129 void MCExpr::dump() const {
136 const MCBinaryExpr *MCBinaryExpr::Create(Opcode Opc, const MCExpr *LHS,
137 const MCExpr *RHS, MCContext &Ctx) {
138 return new (Ctx) MCBinaryExpr(Opc, LHS, RHS);
141 const MCUnaryExpr *MCUnaryExpr::Create(Opcode Opc, const MCExpr *Expr,
143 return new (Ctx) MCUnaryExpr(Opc, Expr);
146 const MCConstantExpr *MCConstantExpr::Create(int64_t Value, MCContext &Ctx) {
147 return new (Ctx) MCConstantExpr(Value);
152 const MCSymbolRefExpr *MCSymbolRefExpr::Create(const MCSymbol *Sym,
155 return new (Ctx) MCSymbolRefExpr(Sym, Kind);
158 const MCSymbolRefExpr *MCSymbolRefExpr::Create(StringRef Name, VariantKind Kind,
160 return Create(Ctx.GetOrCreateSymbol(Name), Kind, Ctx);
163 StringRef MCSymbolRefExpr::getVariantKindName(VariantKind Kind) {
166 case VK_Invalid: return "<<invalid>>";
167 case VK_None: return "<<none>>";
169 case VK_GOT: return "GOT";
170 case VK_GOTOFF: return "GOTOFF";
171 case VK_GOTPCREL: return "GOTPCREL";
172 case VK_GOTTPOFF: return "GOTTPOFF";
173 case VK_INDNTPOFF: return "INDNTPOFF";
174 case VK_NTPOFF: return "NTPOFF";
175 case VK_PLT: return "PLT";
176 case VK_TLSGD: return "TLSGD";
177 case VK_TPOFF: return "TPOFF";
178 case VK_ARM_HI16: return ":upper16:";
179 case VK_ARM_LO16: return ":lower16:";
180 case VK_TLVP: return "TLVP";
184 MCSymbolRefExpr::VariantKind
185 MCSymbolRefExpr::getVariantKindForName(StringRef Name) {
186 return StringSwitch<VariantKind>(Name)
188 .Case("GOTOFF", VK_GOTOFF)
189 .Case("GOTPCREL", VK_GOTPCREL)
190 .Case("GOTTPOFF", VK_GOTTPOFF)
191 .Case("INDNTPOFF", VK_INDNTPOFF)
192 .Case("NTPOFF", VK_NTPOFF)
194 .Case("TLSGD", VK_TLSGD)
195 .Case("TPOFF", VK_TPOFF)
196 .Case("TLVP", VK_TLVP)
197 .Default(VK_Invalid);
202 void MCTargetExpr::Anchor() {}
206 bool MCExpr::EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout *Layout) const {
209 // Fast path constants.
210 if (const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(this)) {
211 Res = CE->getValue();
215 if (!EvaluateAsRelocatable(Value, Layout) || !Value.isAbsolute())
218 Res = Value.getConstant();
222 static bool EvaluateSymbolicAdd(const MCValue &LHS,const MCSymbolRefExpr *RHS_A,
223 const MCSymbolRefExpr *RHS_B, int64_t RHS_Cst,
225 // We can't add or subtract two symbols.
226 if ((LHS.getSymA() && RHS_A) ||
227 (LHS.getSymB() && RHS_B))
230 const MCSymbolRefExpr *A = LHS.getSymA() ? LHS.getSymA() : RHS_A;
231 const MCSymbolRefExpr *B = LHS.getSymB() ? LHS.getSymB() : RHS_B;
233 // If we have a negated symbol, then we must have also have a non-negated
234 // symbol in order to encode the expression. We can do this check later to
235 // permit expressions which eventually fold to a representable form -- such
236 // as (a + (0 - b)) -- if necessary.
240 Res = MCValue::get(A, B, LHS.getConstant() + RHS_Cst);
244 bool MCExpr::EvaluateAsRelocatable(MCValue &Res,
245 const MCAsmLayout *Layout) const {
246 ++stats::MCExprEvaluate;
250 return cast<MCTargetExpr>(this)->EvaluateAsRelocatableImpl(Res, Layout);
253 Res = MCValue::get(cast<MCConstantExpr>(this)->getValue());
257 const MCSymbolRefExpr *SRE = cast<MCSymbolRefExpr>(this);
258 const MCSymbol &Sym = SRE->getSymbol();
260 // Evaluate recursively if this is a variable.
261 if (Sym.isVariable()) {
262 if (!Sym.getVariableValue()->EvaluateAsRelocatable(Res, Layout))
265 // Absolutize symbol differences between defined symbols when we have a
266 // layout object and the target requests it.
267 if (Layout && Res.getSymB() &&
268 Layout->getAssembler().getBackend().hasAbsolutizedSet() &&
269 Res.getSymA()->getSymbol().isDefined() &&
270 Res.getSymB()->getSymbol().isDefined()) {
272 Layout->getAssembler().getSymbolData(Res.getSymA()->getSymbol());
274 Layout->getAssembler().getSymbolData(Res.getSymB()->getSymbol());
275 Res = MCValue::get(+ Layout->getSymbolAddress(&A)
276 - Layout->getSymbolAddress(&B)
277 + Res.getConstant());
283 Res = MCValue::get(SRE, 0, 0);
288 const MCUnaryExpr *AUE = cast<MCUnaryExpr>(this);
291 if (!AUE->getSubExpr()->EvaluateAsRelocatable(Value, Layout))
294 switch (AUE->getOpcode()) {
295 case MCUnaryExpr::LNot:
296 if (!Value.isAbsolute())
298 Res = MCValue::get(!Value.getConstant());
300 case MCUnaryExpr::Minus:
301 /// -(a - b + const) ==> (b - a - const)
302 if (Value.getSymA() && !Value.getSymB())
304 Res = MCValue::get(Value.getSymB(), Value.getSymA(),
305 -Value.getConstant());
307 case MCUnaryExpr::Not:
308 if (!Value.isAbsolute())
310 Res = MCValue::get(~Value.getConstant());
312 case MCUnaryExpr::Plus:
321 const MCBinaryExpr *ABE = cast<MCBinaryExpr>(this);
322 MCValue LHSValue, RHSValue;
324 if (!ABE->getLHS()->EvaluateAsRelocatable(LHSValue, Layout) ||
325 !ABE->getRHS()->EvaluateAsRelocatable(RHSValue, Layout))
328 // We only support a few operations on non-constant expressions, handle
330 if (!LHSValue.isAbsolute() || !RHSValue.isAbsolute()) {
331 switch (ABE->getOpcode()) {
334 case MCBinaryExpr::Sub:
335 // Negate RHS and add.
336 return EvaluateSymbolicAdd(LHSValue,
337 RHSValue.getSymB(), RHSValue.getSymA(),
338 -RHSValue.getConstant(),
341 case MCBinaryExpr::Add:
342 return EvaluateSymbolicAdd(LHSValue,
343 RHSValue.getSymA(), RHSValue.getSymB(),
344 RHSValue.getConstant(),
349 // FIXME: We need target hooks for the evaluation. It may be limited in
350 // width, and gas defines the result of comparisons and right shifts
351 // differently from Apple as.
352 int64_t LHS = LHSValue.getConstant(), RHS = RHSValue.getConstant();
354 switch (ABE->getOpcode()) {
355 case MCBinaryExpr::Add: Result = LHS + RHS; break;
356 case MCBinaryExpr::And: Result = LHS & RHS; break;
357 case MCBinaryExpr::Div: Result = LHS / RHS; break;
358 case MCBinaryExpr::EQ: Result = LHS == RHS; break;
359 case MCBinaryExpr::GT: Result = LHS > RHS; break;
360 case MCBinaryExpr::GTE: Result = LHS >= RHS; break;
361 case MCBinaryExpr::LAnd: Result = LHS && RHS; break;
362 case MCBinaryExpr::LOr: Result = LHS || RHS; break;
363 case MCBinaryExpr::LT: Result = LHS < RHS; break;
364 case MCBinaryExpr::LTE: Result = LHS <= RHS; break;
365 case MCBinaryExpr::Mod: Result = LHS % RHS; break;
366 case MCBinaryExpr::Mul: Result = LHS * RHS; break;
367 case MCBinaryExpr::NE: Result = LHS != RHS; break;
368 case MCBinaryExpr::Or: Result = LHS | RHS; break;
369 case MCBinaryExpr::Shl: Result = LHS << RHS; break;
370 case MCBinaryExpr::Shr: Result = LHS >> RHS; break;
371 case MCBinaryExpr::Sub: Result = LHS - RHS; break;
372 case MCBinaryExpr::Xor: Result = LHS ^ RHS; break;
375 Res = MCValue::get(Result);
380 assert(0 && "Invalid assembly expression kind!");