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/MCObjectFormat.h"
18 #include "llvm/MC/MCSymbol.h"
19 #include "llvm/MC/MCValue.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/raw_ostream.h"
22 #include "llvm/Target/TargetAsmBackend.h"
27 STATISTIC(MCExprEvaluate, "Number of MCExpr evaluations");
31 void MCExpr::print(raw_ostream &OS) const {
34 return cast<MCTargetExpr>(this)->PrintImpl(OS);
35 case MCExpr::Constant:
36 OS << cast<MCConstantExpr>(*this).getValue();
39 case MCExpr::SymbolRef: {
40 const MCSymbolRefExpr &SRE = cast<MCSymbolRefExpr>(*this);
41 const MCSymbol &Sym = SRE.getSymbol();
42 // Parenthesize names that start with $ so that they don't look like
44 bool UseParens = Sym.getName()[0] == '$';
46 if (SRE.getKind() == MCSymbolRefExpr::VK_ARM_HI16 ||
47 SRE.getKind() == MCSymbolRefExpr::VK_ARM_LO16)
48 OS << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
50 if (SRE.getKind() == MCSymbolRefExpr::VK_PPC_HA16 ||
51 SRE.getKind() == MCSymbolRefExpr::VK_PPC_LO16) {
52 OS << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
57 OS << '(' << Sym << ')';
61 if (SRE.getKind() == MCSymbolRefExpr::VK_ARM_PLT ||
62 SRE.getKind() == MCSymbolRefExpr::VK_ARM_TLSGD ||
63 SRE.getKind() == MCSymbolRefExpr::VK_ARM_GOT ||
64 SRE.getKind() == MCSymbolRefExpr::VK_ARM_GOTOFF ||
65 SRE.getKind() == MCSymbolRefExpr::VK_ARM_TPOFF ||
66 SRE.getKind() == MCSymbolRefExpr::VK_ARM_GOTTPOFF)
67 OS << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
68 else if (SRE.getKind() != MCSymbolRefExpr::VK_None &&
69 SRE.getKind() != MCSymbolRefExpr::VK_ARM_HI16 &&
70 SRE.getKind() != MCSymbolRefExpr::VK_ARM_LO16 &&
71 SRE.getKind() != MCSymbolRefExpr::VK_PPC_HA16 &&
72 SRE.getKind() != MCSymbolRefExpr::VK_PPC_LO16)
73 OS << '@' << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
79 const MCUnaryExpr &UE = cast<MCUnaryExpr>(*this);
80 switch (UE.getOpcode()) {
81 default: assert(0 && "Invalid opcode!");
82 case MCUnaryExpr::LNot: OS << '!'; break;
83 case MCUnaryExpr::Minus: OS << '-'; break;
84 case MCUnaryExpr::Not: OS << '~'; break;
85 case MCUnaryExpr::Plus: OS << '+'; break;
87 OS << *UE.getSubExpr();
91 case MCExpr::Binary: {
92 const MCBinaryExpr &BE = cast<MCBinaryExpr>(*this);
94 // Only print parens around the LHS if it is non-trivial.
95 if (isa<MCConstantExpr>(BE.getLHS()) || isa<MCSymbolRefExpr>(BE.getLHS())) {
98 OS << '(' << *BE.getLHS() << ')';
101 switch (BE.getOpcode()) {
102 default: assert(0 && "Invalid opcode!");
103 case MCBinaryExpr::Add:
104 // Print "X-42" instead of "X+-42".
105 if (const MCConstantExpr *RHSC = dyn_cast<MCConstantExpr>(BE.getRHS())) {
106 if (RHSC->getValue() < 0) {
107 OS << RHSC->getValue();
114 case MCBinaryExpr::And: OS << '&'; break;
115 case MCBinaryExpr::Div: OS << '/'; break;
116 case MCBinaryExpr::EQ: OS << "=="; break;
117 case MCBinaryExpr::GT: OS << '>'; break;
118 case MCBinaryExpr::GTE: OS << ">="; break;
119 case MCBinaryExpr::LAnd: OS << "&&"; break;
120 case MCBinaryExpr::LOr: OS << "||"; break;
121 case MCBinaryExpr::LT: OS << '<'; break;
122 case MCBinaryExpr::LTE: OS << "<="; break;
123 case MCBinaryExpr::Mod: OS << '%'; break;
124 case MCBinaryExpr::Mul: OS << '*'; break;
125 case MCBinaryExpr::NE: OS << "!="; break;
126 case MCBinaryExpr::Or: OS << '|'; break;
127 case MCBinaryExpr::Shl: OS << "<<"; break;
128 case MCBinaryExpr::Shr: OS << ">>"; break;
129 case MCBinaryExpr::Sub: OS << '-'; break;
130 case MCBinaryExpr::Xor: OS << '^'; break;
133 // Only print parens around the LHS if it is non-trivial.
134 if (isa<MCConstantExpr>(BE.getRHS()) || isa<MCSymbolRefExpr>(BE.getRHS())) {
137 OS << '(' << *BE.getRHS() << ')';
143 assert(0 && "Invalid expression kind!");
146 void MCExpr::dump() const {
153 const MCBinaryExpr *MCBinaryExpr::Create(Opcode Opc, const MCExpr *LHS,
154 const MCExpr *RHS, MCContext &Ctx) {
155 return new (Ctx) MCBinaryExpr(Opc, LHS, RHS);
158 const MCUnaryExpr *MCUnaryExpr::Create(Opcode Opc, const MCExpr *Expr,
160 return new (Ctx) MCUnaryExpr(Opc, Expr);
163 const MCConstantExpr *MCConstantExpr::Create(int64_t Value, MCContext &Ctx) {
164 return new (Ctx) MCConstantExpr(Value);
169 const MCSymbolRefExpr *MCSymbolRefExpr::Create(const MCSymbol *Sym,
172 return new (Ctx) MCSymbolRefExpr(Sym, Kind);
175 const MCSymbolRefExpr *MCSymbolRefExpr::Create(StringRef Name, VariantKind Kind,
177 return Create(Ctx.GetOrCreateSymbol(Name), Kind, Ctx);
180 StringRef MCSymbolRefExpr::getVariantKindName(VariantKind Kind) {
183 case VK_Invalid: return "<<invalid>>";
184 case VK_None: return "<<none>>";
186 case VK_GOT: return "GOT";
187 case VK_GOTOFF: return "GOTOFF";
188 case VK_GOTPCREL: return "GOTPCREL";
189 case VK_GOTTPOFF: return "GOTTPOFF";
190 case VK_INDNTPOFF: return "INDNTPOFF";
191 case VK_NTPOFF: return "NTPOFF";
192 case VK_GOTNTPOFF: return "GOTNTPOFF";
193 case VK_PLT: return "PLT";
194 case VK_TLSGD: return "TLSGD";
195 case VK_TLSLD: return "TLSLD";
196 case VK_TLSLDM: return "TLSLDM";
197 case VK_TPOFF: return "TPOFF";
198 case VK_DTPOFF: return "DTPOFF";
199 case VK_TLVP: return "TLVP";
200 case VK_ARM_HI16: return ":upper16:";
201 case VK_ARM_LO16: return ":lower16:";
202 case VK_ARM_PLT: return "(PLT)";
203 case VK_ARM_GOT: return "(GOT)";
204 case VK_ARM_GOTOFF: return "(GOTOFF)";
205 case VK_ARM_TPOFF: return "(tpoff)";
206 case VK_ARM_GOTTPOFF: return "(gottpoff)";
207 case VK_ARM_TLSGD: return "(tlsgd)";
208 case VK_PPC_TOC: return "toc";
209 case VK_PPC_HA16: return "ha16";
210 case VK_PPC_LO16: return "lo16";
214 MCSymbolRefExpr::VariantKind
215 MCSymbolRefExpr::getVariantKindForName(StringRef Name) {
216 return StringSwitch<VariantKind>(Name)
218 .Case("GOTOFF", VK_GOTOFF)
219 .Case("GOTPCREL", VK_GOTPCREL)
220 .Case("GOTTPOFF", VK_GOTTPOFF)
221 .Case("INDNTPOFF", VK_INDNTPOFF)
222 .Case("NTPOFF", VK_NTPOFF)
223 .Case("GOTNTPOFF", VK_GOTNTPOFF)
225 .Case("TLSGD", VK_TLSGD)
226 .Case("TLSLD", VK_TLSLD)
227 .Case("TLSLDM", VK_TLSLDM)
228 .Case("TPOFF", VK_TPOFF)
229 .Case("DTPOFF", VK_DTPOFF)
230 .Case("TLVP", VK_TLVP)
231 .Default(VK_Invalid);
236 void MCTargetExpr::Anchor() {}
240 bool MCExpr::EvaluateAsAbsolute(int64_t &Res, const MCAsmLayout *Layout) const {
243 // Fast path constants.
244 if (const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(this)) {
245 Res = CE->getValue();
249 if (!EvaluateAsRelocatable(Value, Layout) || !Value.isAbsolute()) {
250 // EvaluateAsAbsolute is defined to return the "current value" of
251 // the expression if we are given a Layout object, even in cases
252 // when the value is not fixed.
254 Res = Value.getConstant();
255 if (Value.getSymA()) {
256 Res += Layout->getSymbolAddress(
257 &Layout->getAssembler().getSymbolData(Value.getSymA()->getSymbol()));
259 if (Value.getSymB()) {
260 Res -= Layout->getSymbolAddress(
261 &Layout->getAssembler().getSymbolData(Value.getSymB()->getSymbol()));
267 Res = Value.getConstant();
271 static bool EvaluateSymbolicAdd(const MCAsmLayout *Layout, bool InSet,
272 const MCValue &LHS,const MCSymbolRefExpr *RHS_A,
273 const MCSymbolRefExpr *RHS_B, int64_t RHS_Cst,
275 // We can't add or subtract two symbols.
276 if ((LHS.getSymA() && RHS_A) ||
277 (LHS.getSymB() && RHS_B))
280 const MCSymbolRefExpr *A = LHS.getSymA() ? LHS.getSymA() : RHS_A;
281 const MCSymbolRefExpr *B = LHS.getSymB() ? LHS.getSymB() : RHS_B;
283 // If we have a negated symbol, then we must have also have a non-negated
284 // symbol in order to encode the expression. We can do this check later to
285 // permit expressions which eventually fold to a representable form -- such
286 // as (a + (0 - b)) -- if necessary.
291 // Absolutize symbol differences between defined symbols when we have a
292 // layout object and the target requests it.
294 if (Layout && A && B) {
295 const MCSymbol &SA = A->getSymbol();
296 const MCSymbol &SB = B->getSymbol();
297 const MCObjectFormat &F =
298 Layout->getAssembler().getBackend().getObjectFormat();
299 if (SA.isDefined() && SB.isDefined() && F.isAbsolute(InSet, SA, SB)) {
300 const MCAssembler &Asm = Layout->getAssembler();
301 MCSymbolData &AD = Asm.getSymbolData(A->getSymbol());
302 MCSymbolData &BD = Asm.getSymbolData(B->getSymbol());
303 Res = MCValue::get(+ Layout->getSymbolAddress(&AD)
304 - Layout->getSymbolAddress(&BD)
312 Res = MCValue::get(A, B, LHS.getConstant() + RHS_Cst);
316 bool MCExpr::EvaluateAsRelocatable(MCValue &Res,
317 const MCAsmLayout *Layout) const {
318 return EvaluateAsRelocatableImpl(Res, Layout, false);
321 bool MCExpr::EvaluateAsRelocatableImpl(MCValue &Res,
322 const MCAsmLayout *Layout,
324 ++stats::MCExprEvaluate;
328 return cast<MCTargetExpr>(this)->EvaluateAsRelocatableImpl(Res, Layout);
331 Res = MCValue::get(cast<MCConstantExpr>(this)->getValue());
335 const MCSymbolRefExpr *SRE = cast<MCSymbolRefExpr>(this);
336 const MCSymbol &Sym = SRE->getSymbol();
338 // Evaluate recursively if this is a variable.
339 if (Sym.isVariable() && SRE->getKind() == MCSymbolRefExpr::VK_None) {
340 bool Ret = Sym.getVariableValue()->EvaluateAsRelocatableImpl(Res, Layout,
342 // If we failed to simplify this to a constant, let the target
344 if (Ret && !Res.getSymA() && !Res.getSymB())
348 Res = MCValue::get(SRE, 0, 0);
353 const MCUnaryExpr *AUE = cast<MCUnaryExpr>(this);
356 if (!AUE->getSubExpr()->EvaluateAsRelocatableImpl(Value, Layout, InSet))
359 switch (AUE->getOpcode()) {
360 case MCUnaryExpr::LNot:
361 if (!Value.isAbsolute())
363 Res = MCValue::get(!Value.getConstant());
365 case MCUnaryExpr::Minus:
366 /// -(a - b + const) ==> (b - a - const)
367 if (Value.getSymA() && !Value.getSymB())
369 Res = MCValue::get(Value.getSymB(), Value.getSymA(),
370 -Value.getConstant());
372 case MCUnaryExpr::Not:
373 if (!Value.isAbsolute())
375 Res = MCValue::get(~Value.getConstant());
377 case MCUnaryExpr::Plus:
386 const MCBinaryExpr *ABE = cast<MCBinaryExpr>(this);
387 MCValue LHSValue, RHSValue;
389 if (!ABE->getLHS()->EvaluateAsRelocatableImpl(LHSValue, Layout, InSet) ||
390 !ABE->getRHS()->EvaluateAsRelocatableImpl(RHSValue, Layout, InSet))
393 // We only support a few operations on non-constant expressions, handle
395 if (!LHSValue.isAbsolute() || !RHSValue.isAbsolute()) {
396 switch (ABE->getOpcode()) {
399 case MCBinaryExpr::Sub:
400 // Negate RHS and add.
401 return EvaluateSymbolicAdd(Layout, InSet, LHSValue,
402 RHSValue.getSymB(), RHSValue.getSymA(),
403 -RHSValue.getConstant(),
406 case MCBinaryExpr::Add:
407 return EvaluateSymbolicAdd(Layout, InSet, LHSValue,
408 RHSValue.getSymA(), RHSValue.getSymB(),
409 RHSValue.getConstant(),
414 // FIXME: We need target hooks for the evaluation. It may be limited in
415 // width, and gas defines the result of comparisons and right shifts
416 // differently from Apple as.
417 int64_t LHS = LHSValue.getConstant(), RHS = RHSValue.getConstant();
419 switch (ABE->getOpcode()) {
420 case MCBinaryExpr::Add: Result = LHS + RHS; break;
421 case MCBinaryExpr::And: Result = LHS & RHS; break;
422 case MCBinaryExpr::Div: Result = LHS / RHS; break;
423 case MCBinaryExpr::EQ: Result = LHS == RHS; break;
424 case MCBinaryExpr::GT: Result = LHS > RHS; break;
425 case MCBinaryExpr::GTE: Result = LHS >= RHS; break;
426 case MCBinaryExpr::LAnd: Result = LHS && RHS; break;
427 case MCBinaryExpr::LOr: Result = LHS || RHS; break;
428 case MCBinaryExpr::LT: Result = LHS < RHS; break;
429 case MCBinaryExpr::LTE: Result = LHS <= RHS; break;
430 case MCBinaryExpr::Mod: Result = LHS % RHS; break;
431 case MCBinaryExpr::Mul: Result = LHS * RHS; break;
432 case MCBinaryExpr::NE: Result = LHS != RHS; break;
433 case MCBinaryExpr::Or: Result = LHS | RHS; break;
434 case MCBinaryExpr::Shl: Result = LHS << RHS; break;
435 case MCBinaryExpr::Shr: Result = LHS >> RHS; break;
436 case MCBinaryExpr::Sub: Result = LHS - RHS; break;
437 case MCBinaryExpr::Xor: Result = LHS ^ RHS; break;
440 Res = MCValue::get(Result);
445 assert(0 && "Invalid assembly expression kind!");