Add support for lowercase variants.
[oota-llvm.git] / lib / MC / MCExpr.cpp
1 //===- MCExpr.cpp - Assembly Level Expression Implementation --------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
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"
22 using namespace llvm;
23
24 namespace {
25 namespace stats {
26 STATISTIC(MCExprEvaluate, "Number of MCExpr evaluations");
27 }
28 }
29
30 void MCExpr::print(raw_ostream &OS) const {
31   switch (getKind()) {
32   case MCExpr::Target:
33     return cast<MCTargetExpr>(this)->PrintImpl(OS);
34   case MCExpr::Constant:
35     OS << cast<MCConstantExpr>(*this).getValue();
36     return;
37
38   case MCExpr::SymbolRef: {
39     const MCSymbolRefExpr &SRE = cast<MCSymbolRefExpr>(*this);
40     const MCSymbol &Sym = SRE.getSymbol();
41     // Parenthesize names that start with $ so that they don't look like
42     // absolute names.
43     bool UseParens = Sym.getName()[0] == '$';
44
45     if (SRE.getKind() == MCSymbolRefExpr::VK_PPC_HA16 ||
46         SRE.getKind() == MCSymbolRefExpr::VK_PPC_LO16) {
47       OS << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
48       UseParens = true;
49     }
50
51     if (UseParens)
52       OS << '(' << Sym << ')';
53     else
54       OS << Sym;
55
56     if (SRE.getKind() == MCSymbolRefExpr::VK_ARM_PLT ||
57         SRE.getKind() == MCSymbolRefExpr::VK_ARM_TLSGD ||
58         SRE.getKind() == MCSymbolRefExpr::VK_ARM_GOT ||
59         SRE.getKind() == MCSymbolRefExpr::VK_ARM_GOTOFF ||
60         SRE.getKind() == MCSymbolRefExpr::VK_ARM_TPOFF ||
61         SRE.getKind() == MCSymbolRefExpr::VK_ARM_GOTTPOFF)
62       OS << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
63     else if (SRE.getKind() != MCSymbolRefExpr::VK_None &&
64              SRE.getKind() != MCSymbolRefExpr::VK_PPC_HA16 &&
65              SRE.getKind() != MCSymbolRefExpr::VK_PPC_LO16)
66       OS << '@' << MCSymbolRefExpr::getVariantKindName(SRE.getKind());
67
68     return;
69   }
70
71   case MCExpr::Unary: {
72     const MCUnaryExpr &UE = cast<MCUnaryExpr>(*this);
73     switch (UE.getOpcode()) {
74     default: assert(0 && "Invalid opcode!");
75     case MCUnaryExpr::LNot:  OS << '!'; break;
76     case MCUnaryExpr::Minus: OS << '-'; break;
77     case MCUnaryExpr::Not:   OS << '~'; break;
78     case MCUnaryExpr::Plus:  OS << '+'; break;
79     }
80     OS << *UE.getSubExpr();
81     return;
82   }
83
84   case MCExpr::Binary: {
85     const MCBinaryExpr &BE = cast<MCBinaryExpr>(*this);
86
87     // Only print parens around the LHS if it is non-trivial.
88     if (isa<MCConstantExpr>(BE.getLHS()) || isa<MCSymbolRefExpr>(BE.getLHS())) {
89       OS << *BE.getLHS();
90     } else {
91       OS << '(' << *BE.getLHS() << ')';
92     }
93
94     switch (BE.getOpcode()) {
95     default: assert(0 && "Invalid opcode!");
96     case MCBinaryExpr::Add:
97       // Print "X-42" instead of "X+-42".
98       if (const MCConstantExpr *RHSC = dyn_cast<MCConstantExpr>(BE.getRHS())) {
99         if (RHSC->getValue() < 0) {
100           OS << RHSC->getValue();
101           return;
102         }
103       }
104
105       OS <<  '+';
106       break;
107     case MCBinaryExpr::And:  OS <<  '&'; break;
108     case MCBinaryExpr::Div:  OS <<  '/'; break;
109     case MCBinaryExpr::EQ:   OS << "=="; break;
110     case MCBinaryExpr::GT:   OS <<  '>'; break;
111     case MCBinaryExpr::GTE:  OS << ">="; break;
112     case MCBinaryExpr::LAnd: OS << "&&"; break;
113     case MCBinaryExpr::LOr:  OS << "||"; break;
114     case MCBinaryExpr::LT:   OS <<  '<'; break;
115     case MCBinaryExpr::LTE:  OS << "<="; break;
116     case MCBinaryExpr::Mod:  OS <<  '%'; break;
117     case MCBinaryExpr::Mul:  OS <<  '*'; break;
118     case MCBinaryExpr::NE:   OS << "!="; break;
119     case MCBinaryExpr::Or:   OS <<  '|'; break;
120     case MCBinaryExpr::Shl:  OS << "<<"; break;
121     case MCBinaryExpr::Shr:  OS << ">>"; break;
122     case MCBinaryExpr::Sub:  OS <<  '-'; break;
123     case MCBinaryExpr::Xor:  OS <<  '^'; break;
124     }
125
126     // Only print parens around the LHS if it is non-trivial.
127     if (isa<MCConstantExpr>(BE.getRHS()) || isa<MCSymbolRefExpr>(BE.getRHS())) {
128       OS << *BE.getRHS();
129     } else {
130       OS << '(' << *BE.getRHS() << ')';
131     }
132     return;
133   }
134   }
135
136   assert(0 && "Invalid expression kind!");
137 }
138
139 void MCExpr::dump() const {
140   print(dbgs());
141   dbgs() << '\n';
142 }
143
144 /* *** */
145
146 const MCBinaryExpr *MCBinaryExpr::Create(Opcode Opc, const MCExpr *LHS,
147                                          const MCExpr *RHS, MCContext &Ctx) {
148   return new (Ctx) MCBinaryExpr(Opc, LHS, RHS);
149 }
150
151 const MCUnaryExpr *MCUnaryExpr::Create(Opcode Opc, const MCExpr *Expr,
152                                        MCContext &Ctx) {
153   return new (Ctx) MCUnaryExpr(Opc, Expr);
154 }
155
156 const MCConstantExpr *MCConstantExpr::Create(int64_t Value, MCContext &Ctx) {
157   return new (Ctx) MCConstantExpr(Value);
158 }
159
160 /* *** */
161
162 const MCSymbolRefExpr *MCSymbolRefExpr::Create(const MCSymbol *Sym,
163                                                VariantKind Kind,
164                                                MCContext &Ctx) {
165   return new (Ctx) MCSymbolRefExpr(Sym, Kind);
166 }
167
168 const MCSymbolRefExpr *MCSymbolRefExpr::Create(StringRef Name, VariantKind Kind,
169                                                MCContext &Ctx) {
170   return Create(Ctx.GetOrCreateSymbol(Name), Kind, Ctx);
171 }
172
173 StringRef MCSymbolRefExpr::getVariantKindName(VariantKind Kind) {
174   switch (Kind) {
175   default:
176   case VK_Invalid: return "<<invalid>>";
177   case VK_None: return "<<none>>";
178
179   case VK_GOT: return "GOT";
180   case VK_GOTOFF: return "GOTOFF";
181   case VK_GOTPCREL: return "GOTPCREL";
182   case VK_GOTTPOFF: return "GOTTPOFF";
183   case VK_INDNTPOFF: return "INDNTPOFF";
184   case VK_NTPOFF: return "NTPOFF";
185   case VK_GOTNTPOFF: return "GOTNTPOFF";
186   case VK_PLT: return "PLT";
187   case VK_TLSGD: return "TLSGD";
188   case VK_TLSLD: return "TLSLD";
189   case VK_TLSLDM: return "TLSLDM";
190   case VK_TPOFF: return "TPOFF";
191   case VK_DTPOFF: return "DTPOFF";
192   case VK_TLVP: return "TLVP";
193   case VK_ARM_PLT: return "(PLT)";
194   case VK_ARM_GOT: return "(GOT)";
195   case VK_ARM_GOTOFF: return "(GOTOFF)";
196   case VK_ARM_TPOFF: return "(tpoff)";
197   case VK_ARM_GOTTPOFF: return "(gottpoff)";
198   case VK_ARM_TLSGD: return "(tlsgd)";
199   case VK_PPC_TOC: return "toc";
200   case VK_PPC_HA16: return "ha16";
201   case VK_PPC_LO16: return "lo16";
202   }
203 }
204
205 MCSymbolRefExpr::VariantKind
206 MCSymbolRefExpr::getVariantKindForName(StringRef Name) {
207   return StringSwitch<VariantKind>(Name)
208     .Case("GOT", VK_GOT)
209     .Case("got", VK_GOT)
210     .Case("GOTOFF", VK_GOTOFF)
211     .Case("gotoff", VK_GOTOFF)
212     .Case("GOTPCREL", VK_GOTPCREL)
213     .Case("gotpcrel", VK_GOTPCREL)
214     .Case("GOTTPOFF", VK_GOTTPOFF)
215     .Case("gottpoff", VK_GOTTPOFF)
216     .Case("INDNTPOFF", VK_INDNTPOFF)
217     .Case("indntpoff", VK_INDNTPOFF)
218     .Case("NTPOFF", VK_NTPOFF)
219     .Case("ntpoff", VK_NTPOFF)
220     .Case("GOTNTPOFF", VK_GOTNTPOFF)
221     .Case("gotntpoff", VK_GOTNTPOFF)
222     .Case("PLT", VK_PLT)
223     .Case("plt", VK_PLT)
224     .Case("TLSGD", VK_TLSGD)
225     .Case("tlsgd", VK_TLSGD)
226     .Case("TLSLD", VK_TLSLD)
227     .Case("tlsld", VK_TLSLD)
228     .Case("TLSLDM", VK_TLSLDM)
229     .Case("tlsldm", VK_TLSLDM)
230     .Case("TPOFF", VK_TPOFF)
231     .Case("tpoff", VK_TPOFF)
232     .Case("DTPOFF", VK_DTPOFF)
233     .Case("dtpoff", VK_DTPOFF)
234     .Case("TLVP", VK_TLVP)
235     .Case("tlvp", VK_TLVP)
236     .Default(VK_Invalid);
237 }
238
239 /* *** */
240
241 void MCTargetExpr::Anchor() {}
242
243 /* *** */
244
245 bool MCExpr::EvaluateAsAbsolute(int64_t &Res) const {
246   return EvaluateAsAbsolute(Res, 0, 0, 0);
247 }
248
249 bool MCExpr::EvaluateAsAbsolute(int64_t &Res,
250                                 const MCAsmLayout &Layout) const {
251   return EvaluateAsAbsolute(Res, &Layout.getAssembler(), &Layout, 0);
252 }
253
254 bool MCExpr::EvaluateAsAbsolute(int64_t &Res,
255                                 const MCAsmLayout &Layout,
256                                 const SectionAddrMap &Addrs) const {
257   return EvaluateAsAbsolute(Res, &Layout.getAssembler(), &Layout, &Addrs);
258 }
259
260 bool MCExpr::EvaluateAsAbsolute(int64_t &Res, const MCAssembler &Asm) const {
261   return EvaluateAsAbsolute(Res, &Asm, 0, 0);
262 }
263
264 bool MCExpr::EvaluateAsAbsolute(int64_t &Res, const MCAssembler *Asm,
265                                 const MCAsmLayout *Layout,
266                                 const SectionAddrMap *Addrs) const {
267   MCValue Value;
268
269   // Fast path constants.
270   if (const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(this)) {
271     Res = CE->getValue();
272     return true;
273   }
274
275   // FIXME: The use if InSet = Addrs is a hack. Setting InSet causes us
276   // absolutize differences across sections and that is what the MachO writer
277   // uses Addrs for.
278   bool IsRelocatable =
279     EvaluateAsRelocatableImpl(Value, Asm, Layout, Addrs, /*InSet*/ Addrs);
280
281   // Record the current value.
282   Res = Value.getConstant();
283
284   return IsRelocatable && Value.isAbsolute();
285 }
286
287 /// \brief Helper method for \see EvaluateSymbolAdd().
288 static void AttemptToFoldSymbolOffsetDifference(const MCAssembler *Asm,
289                                                 const MCAsmLayout *Layout,
290                                                 const SectionAddrMap *Addrs,
291                                                 bool InSet,
292                                                 const MCSymbolRefExpr *&A,
293                                                 const MCSymbolRefExpr *&B,
294                                                 int64_t &Addend) {
295   if (!A || !B)
296     return;
297
298   const MCSymbol &SA = A->getSymbol();
299   const MCSymbol &SB = B->getSymbol();
300
301   if (SA.isUndefined() || SB.isUndefined())
302     return;
303
304   if (!Asm->getWriter().IsSymbolRefDifferenceFullyResolved(*Asm, A, B, InSet))
305     return;
306
307   MCSymbolData &AD = Asm->getSymbolData(SA);
308   MCSymbolData &BD = Asm->getSymbolData(SB);
309
310   if (AD.getFragment() == BD.getFragment()) {
311     Addend += (AD.getOffset() - BD.getOffset());
312
313     // Clear the symbol expr pointers to indicate we have folded these
314     // operands.
315     A = B = 0;
316     return;
317   }
318
319   if (!Layout)
320     return;
321
322   const MCSectionData &SecA = *AD.getFragment()->getParent();
323   const MCSectionData &SecB = *BD.getFragment()->getParent();
324
325   if ((&SecA != &SecB) && !Addrs)
326     return;
327
328   // Eagerly evaluate.
329   Addend += (Layout->getSymbolOffset(&Asm->getSymbolData(A->getSymbol())) -
330              Layout->getSymbolOffset(&Asm->getSymbolData(B->getSymbol())));
331   if (Addrs && (&SecA != &SecB))
332     Addend += (Addrs->lookup(&SecA) - Addrs->lookup(&SecB));
333
334   // Clear the symbol expr pointers to indicate we have folded these
335   // operands.
336   A = B = 0;
337 }
338
339 /// \brief Evaluate the result of an add between (conceptually) two MCValues.
340 ///
341 /// This routine conceptually attempts to construct an MCValue:
342 ///   Result = (Result_A - Result_B + Result_Cst)
343 /// from two MCValue's LHS and RHS where
344 ///   Result = LHS + RHS
345 /// and
346 ///   Result = (LHS_A - LHS_B + LHS_Cst) + (RHS_A - RHS_B + RHS_Cst).
347 ///
348 /// This routine attempts to aggresively fold the operands such that the result
349 /// is representable in an MCValue, but may not always succeed.
350 ///
351 /// \returns True on success, false if the result is not representable in an
352 /// MCValue.
353
354 /// NOTE: It is really important to have both the Asm and Layout arguments.
355 /// They might look redundant, but this function can be used before layout
356 /// is done (see the object streamer for example) and having the Asm argument
357 /// lets us avoid relaxations early.
358 static bool EvaluateSymbolicAdd(const MCAssembler *Asm,
359                                 const MCAsmLayout *Layout,
360                                 const SectionAddrMap *Addrs,
361                                 bool InSet,
362                                 const MCValue &LHS,const MCSymbolRefExpr *RHS_A,
363                                 const MCSymbolRefExpr *RHS_B, int64_t RHS_Cst,
364                                 MCValue &Res) {
365   // FIXME: This routine (and other evaluation parts) are *incredibly* sloppy
366   // about dealing with modifiers. This will ultimately bite us, one day.
367   const MCSymbolRefExpr *LHS_A = LHS.getSymA();
368   const MCSymbolRefExpr *LHS_B = LHS.getSymB();
369   int64_t LHS_Cst = LHS.getConstant();
370
371   // Fold the result constant immediately.
372   int64_t Result_Cst = LHS_Cst + RHS_Cst;
373
374   assert((!Layout || Asm) &&
375          "Must have an assembler object if layout is given!");
376
377   // If we have a layout, we can fold resolved differences.
378   if (Asm) {
379     // First, fold out any differences which are fully resolved. By
380     // reassociating terms in
381     //   Result = (LHS_A - LHS_B + LHS_Cst) + (RHS_A - RHS_B + RHS_Cst).
382     // we have the four possible differences:
383     //   (LHS_A - LHS_B),
384     //   (LHS_A - RHS_B),
385     //   (RHS_A - LHS_B),
386     //   (RHS_A - RHS_B).
387     // Since we are attempting to be as aggresive as possible about folding, we
388     // attempt to evaluate each possible alternative.
389     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, LHS_A, LHS_B,
390                                         Result_Cst);
391     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, LHS_A, RHS_B,
392                                         Result_Cst);
393     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, RHS_A, LHS_B,
394                                         Result_Cst);
395     AttemptToFoldSymbolOffsetDifference(Asm, Layout, Addrs, InSet, RHS_A, RHS_B,
396                                         Result_Cst);
397   }
398
399   // We can't represent the addition or subtraction of two symbols.
400   if ((LHS_A && RHS_A) || (LHS_B && RHS_B))
401     return false;
402
403   // At this point, we have at most one additive symbol and one subtractive
404   // symbol -- find them.
405   const MCSymbolRefExpr *A = LHS_A ? LHS_A : RHS_A;
406   const MCSymbolRefExpr *B = LHS_B ? LHS_B : RHS_B;
407
408   // If we have a negated symbol, then we must have also have a non-negated
409   // symbol in order to encode the expression.
410   if (B && !A)
411     return false;
412
413   Res = MCValue::get(A, B, Result_Cst);
414   return true;
415 }
416
417 bool MCExpr::EvaluateAsRelocatable(MCValue &Res,
418                                    const MCAsmLayout &Layout) const {
419   return EvaluateAsRelocatableImpl(Res, &Layout.getAssembler(), &Layout,
420                                    0, false);
421 }
422
423 bool MCExpr::EvaluateAsRelocatableImpl(MCValue &Res,
424                                        const MCAssembler *Asm,
425                                        const MCAsmLayout *Layout,
426                                        const SectionAddrMap *Addrs,
427                                        bool InSet) const {
428   ++stats::MCExprEvaluate;
429
430   switch (getKind()) {
431   case Target:
432     return cast<MCTargetExpr>(this)->EvaluateAsRelocatableImpl(Res, Layout);
433
434   case Constant:
435     Res = MCValue::get(cast<MCConstantExpr>(this)->getValue());
436     return true;
437
438   case SymbolRef: {
439     const MCSymbolRefExpr *SRE = cast<MCSymbolRefExpr>(this);
440     const MCSymbol &Sym = SRE->getSymbol();
441
442     // Evaluate recursively if this is a variable.
443     if (Sym.isVariable() && SRE->getKind() == MCSymbolRefExpr::VK_None) {
444       bool Ret = Sym.getVariableValue()->EvaluateAsRelocatableImpl(Res, Asm,
445                                                                    Layout,
446                                                                    Addrs,
447                                                                    true);
448       // If we failed to simplify this to a constant, let the target
449       // handle it.
450       if (Ret && !Res.getSymA() && !Res.getSymB())
451         return true;
452     }
453
454     Res = MCValue::get(SRE, 0, 0);
455     return true;
456   }
457
458   case Unary: {
459     const MCUnaryExpr *AUE = cast<MCUnaryExpr>(this);
460     MCValue Value;
461
462     if (!AUE->getSubExpr()->EvaluateAsRelocatableImpl(Value, Asm, Layout,
463                                                       Addrs, InSet))
464       return false;
465
466     switch (AUE->getOpcode()) {
467     case MCUnaryExpr::LNot:
468       if (!Value.isAbsolute())
469         return false;
470       Res = MCValue::get(!Value.getConstant());
471       break;
472     case MCUnaryExpr::Minus:
473       /// -(a - b + const) ==> (b - a - const)
474       if (Value.getSymA() && !Value.getSymB())
475         return false;
476       Res = MCValue::get(Value.getSymB(), Value.getSymA(),
477                          -Value.getConstant());
478       break;
479     case MCUnaryExpr::Not:
480       if (!Value.isAbsolute())
481         return false;
482       Res = MCValue::get(~Value.getConstant());
483       break;
484     case MCUnaryExpr::Plus:
485       Res = Value;
486       break;
487     }
488
489     return true;
490   }
491
492   case Binary: {
493     const MCBinaryExpr *ABE = cast<MCBinaryExpr>(this);
494     MCValue LHSValue, RHSValue;
495
496     if (!ABE->getLHS()->EvaluateAsRelocatableImpl(LHSValue, Asm, Layout,
497                                                   Addrs, InSet) ||
498         !ABE->getRHS()->EvaluateAsRelocatableImpl(RHSValue, Asm, Layout,
499                                                   Addrs, InSet))
500       return false;
501
502     // We only support a few operations on non-constant expressions, handle
503     // those first.
504     if (!LHSValue.isAbsolute() || !RHSValue.isAbsolute()) {
505       switch (ABE->getOpcode()) {
506       default:
507         return false;
508       case MCBinaryExpr::Sub:
509         // Negate RHS and add.
510         return EvaluateSymbolicAdd(Asm, Layout, Addrs, InSet, LHSValue,
511                                    RHSValue.getSymB(), RHSValue.getSymA(),
512                                    -RHSValue.getConstant(),
513                                    Res);
514
515       case MCBinaryExpr::Add:
516         return EvaluateSymbolicAdd(Asm, Layout, Addrs, InSet, LHSValue,
517                                    RHSValue.getSymA(), RHSValue.getSymB(),
518                                    RHSValue.getConstant(),
519                                    Res);
520       }
521     }
522
523     // FIXME: We need target hooks for the evaluation. It may be limited in
524     // width, and gas defines the result of comparisons and right shifts
525     // differently from Apple as.
526     int64_t LHS = LHSValue.getConstant(), RHS = RHSValue.getConstant();
527     int64_t Result = 0;
528     switch (ABE->getOpcode()) {
529     case MCBinaryExpr::Add:  Result = LHS + RHS; break;
530     case MCBinaryExpr::And:  Result = LHS & RHS; break;
531     case MCBinaryExpr::Div:  Result = LHS / RHS; break;
532     case MCBinaryExpr::EQ:   Result = LHS == RHS; break;
533     case MCBinaryExpr::GT:   Result = LHS > RHS; break;
534     case MCBinaryExpr::GTE:  Result = LHS >= RHS; break;
535     case MCBinaryExpr::LAnd: Result = LHS && RHS; break;
536     case MCBinaryExpr::LOr:  Result = LHS || RHS; break;
537     case MCBinaryExpr::LT:   Result = LHS < RHS; break;
538     case MCBinaryExpr::LTE:  Result = LHS <= RHS; break;
539     case MCBinaryExpr::Mod:  Result = LHS % RHS; break;
540     case MCBinaryExpr::Mul:  Result = LHS * RHS; break;
541     case MCBinaryExpr::NE:   Result = LHS != RHS; break;
542     case MCBinaryExpr::Or:   Result = LHS | RHS; break;
543     case MCBinaryExpr::Shl:  Result = LHS << RHS; break;
544     case MCBinaryExpr::Shr:  Result = LHS >> RHS; break;
545     case MCBinaryExpr::Sub:  Result = LHS - RHS; break;
546     case MCBinaryExpr::Xor:  Result = LHS ^ RHS; break;
547     }
548
549     Res = MCValue::get(Result);
550     return true;
551   }
552   }
553
554   assert(0 && "Invalid assembly expression kind!");
555   return false;
556 }