factor MBB label lowering better
[oota-llvm.git] / lib / Target / X86 / AsmPrinter / X86MCInstLower.cpp
1 //===-- X86MCInstLower.cpp - Convert X86 MachineInstr to an MCInst --------===//
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 // This file contains code to lower X86 MachineInstrs to their corresponding
11 // MCInst records.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "X86MCInstLower.h"
16 #include "X86ATTAsmPrinter.h"
17 #include "X86MCAsmInfo.h"
18 #include "llvm/MC/MCContext.h"
19 #include "llvm/MC/MCExpr.h"
20 #include "llvm/MC/MCInst.h"
21 #include "llvm/MC/MCStreamer.h"
22 #include "llvm/Support/FormattedStream.h"
23 #include "llvm/Support/Mangler.h"
24 #include "llvm/ADT/SmallString.h"
25 using namespace llvm;
26
27
28 const X86Subtarget &X86MCInstLower::getSubtarget() const {
29   return AsmPrinter.getSubtarget();
30 }
31
32
33 MCSymbol *X86MCInstLower::GetPICBaseSymbol() const {
34   // FIXME: the actual label generated doesn't matter here!  Just mangle in
35   // something unique (the function number) with Private prefix.
36   SmallString<60> Name;
37   
38   if (getSubtarget().isTargetDarwin()) {
39     raw_svector_ostream(Name) << 'L' << AsmPrinter.getFunctionNumber() << "$pb";
40   } else {
41     assert(getSubtarget().isTargetELF() && "Don't know how to print PIC label!");
42     raw_svector_ostream(Name) << ".Lllvm$" << AsmPrinter.getFunctionNumber()
43        << ".$piclabel";
44   }
45   return Ctx.GetOrCreateSymbol(Name.str());
46 }
47
48 MCSymbol *X86MCInstLower::GetMBBSymbol(unsigned MBBID) const {
49   SmallString<60> Name;
50   raw_svector_ostream(Name) << AsmPrinter.MAI->getPrivateGlobalPrefix() << "BB"
51       << AsmPrinter.getFunctionNumber() << '_' << MBBID;
52
53   return Ctx.GetOrCreateSymbol(Name.str());
54 }
55
56
57
58 /// LowerGlobalAddressOperand - Lower an MO_GlobalAddress operand to an
59 /// MCOperand.
60 MCSymbol *X86MCInstLower::
61 GetGlobalAddressSymbol(const MachineOperand &MO) const {
62   const GlobalValue *GV = MO.getGlobal();
63   
64   bool isImplicitlyPrivate = false;
65   if (MO.getTargetFlags() == X86II::MO_DARWIN_STUB ||
66       MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY ||
67       MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY_PIC_BASE ||
68       MO.getTargetFlags() == X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE)
69     isImplicitlyPrivate = true;
70   
71   SmallString<128> Name;
72   Mang->getNameWithPrefix(Name, GV, isImplicitlyPrivate);
73   
74   if (getSubtarget().isTargetCygMing())
75     AsmPrinter.DecorateCygMingName(Name, GV);
76   
77   switch (MO.getTargetFlags()) {
78   default: llvm_unreachable("Unknown target flag on GV operand");
79   case X86II::MO_NO_FLAG:                // No flag.
80   case X86II::MO_PIC_BASE_OFFSET:        // Doesn't modify symbol name.
81     break;
82   case X86II::MO_DLLIMPORT: {
83     // Handle dllimport linkage.
84     const char *Prefix = "__imp_";
85     Name.insert(Name.begin(), Prefix, Prefix+strlen(Prefix));
86     break;
87   }
88   case X86II::MO_DARWIN_NONLAZY:
89   case X86II::MO_DARWIN_NONLAZY_PIC_BASE: {
90     Name += "$non_lazy_ptr";
91     MCSymbol *Sym = Ctx.GetOrCreateSymbol(Name.str());
92     MCSymbol *&StubSym = AsmPrinter.GVStubs[Sym];
93     if (StubSym == 0) {
94       Name.clear();
95       Mang->getNameWithPrefix(Name, GV, false);
96       StubSym = Ctx.GetOrCreateSymbol(Name.str());
97     }
98     return Sym;
99   }
100   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE: {
101     Name += "$non_lazy_ptr";
102     MCSymbol *Sym = Ctx.GetOrCreateSymbol(Name.str());
103     MCSymbol *&StubSym = AsmPrinter.HiddenGVStubs[Sym];
104     if (StubSym == 0) {
105       Name.clear();
106       Mang->getNameWithPrefix(Name, GV, false);
107       StubSym = Ctx.GetOrCreateSymbol(Name.str());
108     }
109     return Sym;
110   }
111   case X86II::MO_DARWIN_STUB: {
112     Name += "$stub";
113     MCSymbol *Sym = Ctx.GetOrCreateSymbol(Name.str());
114     MCSymbol *&StubSym = AsmPrinter.FnStubs[Sym];
115     if (StubSym == 0) {
116       Name.clear();
117       Mang->getNameWithPrefix(Name, GV, false);
118       StubSym = Ctx.GetOrCreateSymbol(Name.str());
119     }
120     return Sym;
121   }
122   // FIXME: These probably should be a modifier on the symbol or something??
123   case X86II::MO_TLSGD:     Name += "@TLSGD";     break;
124   case X86II::MO_GOTTPOFF:  Name += "@GOTTPOFF";  break;
125   case X86II::MO_INDNTPOFF: Name += "@INDNTPOFF"; break;
126   case X86II::MO_TPOFF:     Name += "@TPOFF";     break;
127   case X86II::MO_NTPOFF:    Name += "@NTPOFF";    break;
128   case X86II::MO_GOTPCREL:  Name += "@GOTPCREL";  break;
129   case X86II::MO_GOT:       Name += "@GOT";       break;
130   case X86II::MO_GOTOFF:    Name += "@GOTOFF";    break;
131   case X86II::MO_PLT:       Name += "@PLT";       break;
132   }
133   
134   return Ctx.GetOrCreateSymbol(Name.str());
135 }
136
137 MCSymbol *X86MCInstLower::
138 GetExternalSymbolSymbol(const MachineOperand &MO) const {
139   SmallString<128> Name;
140   Name += AsmPrinter.MAI->getGlobalPrefix();
141   Name += MO.getSymbolName();
142   
143   switch (MO.getTargetFlags()) {
144   default: llvm_unreachable("Unknown target flag on GV operand");
145   case X86II::MO_NO_FLAG:                // No flag.
146   case X86II::MO_GOT_ABSOLUTE_ADDRESS:   // Doesn't modify symbol name.
147   case X86II::MO_PIC_BASE_OFFSET:        // Doesn't modify symbol name.
148     break;
149   case X86II::MO_DLLIMPORT: {
150     // Handle dllimport linkage.
151     const char *Prefix = "__imp_";
152     Name.insert(Name.begin(), Prefix, Prefix+strlen(Prefix));
153     break;
154   }
155   case X86II::MO_DARWIN_STUB: {
156     Name += "$stub";
157     MCSymbol *Sym = Ctx.GetOrCreateSymbol(Name.str());
158     MCSymbol *&StubSym = AsmPrinter.FnStubs[Sym];
159     if (StubSym == 0) {
160       Name.erase(Name.end()-5, Name.end());
161       StubSym = Ctx.GetOrCreateSymbol(Name.str());
162     }
163     return Sym;
164   }
165   // FIXME: These probably should be a modifier on the symbol or something??
166   case X86II::MO_TLSGD:     Name += "@TLSGD";     break;
167   case X86II::MO_GOTTPOFF:  Name += "@GOTTPOFF";  break;
168   case X86II::MO_INDNTPOFF: Name += "@INDNTPOFF"; break;
169   case X86II::MO_TPOFF:     Name += "@TPOFF";     break;
170   case X86II::MO_NTPOFF:    Name += "@NTPOFF";    break;
171   case X86II::MO_GOTPCREL:  Name += "@GOTPCREL";  break;
172   case X86II::MO_GOT:       Name += "@GOT";       break;
173   case X86II::MO_GOTOFF:    Name += "@GOTOFF";    break;
174   case X86II::MO_PLT:       Name += "@PLT";       break;
175   }
176   
177   return Ctx.GetOrCreateSymbol(Name.str());
178 }
179
180 MCSymbol *X86MCInstLower::GetJumpTableSymbol(const MachineOperand &MO) const {
181   SmallString<256> Name;
182   raw_svector_ostream(Name) << AsmPrinter.MAI->getPrivateGlobalPrefix() << "JTI"
183     << AsmPrinter.getFunctionNumber() << '_' << MO.getIndex();
184   
185   switch (MO.getTargetFlags()) {
186   default:
187     llvm_unreachable("Unknown target flag on GV operand");
188   case X86II::MO_NO_FLAG:    // No flag.
189   case X86II::MO_PIC_BASE_OFFSET:
190   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
191   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE:
192     break;
193     // FIXME: These probably should be a modifier on the symbol or something??
194   case X86II::MO_TLSGD:     Name += "@TLSGD";     break;
195   case X86II::MO_GOTTPOFF:  Name += "@GOTTPOFF";  break;
196   case X86II::MO_INDNTPOFF: Name += "@INDNTPOFF"; break;
197   case X86II::MO_TPOFF:     Name += "@TPOFF";     break;
198   case X86II::MO_NTPOFF:    Name += "@NTPOFF";    break;
199   case X86II::MO_GOTPCREL:  Name += "@GOTPCREL";  break;
200   case X86II::MO_GOT:       Name += "@GOT";       break;
201   case X86II::MO_GOTOFF:    Name += "@GOTOFF";    break;
202   case X86II::MO_PLT:       Name += "@PLT";       break;
203   }
204   
205   // Create a symbol for the name.
206   return Ctx.GetOrCreateSymbol(Name.str());
207 }
208
209
210 MCSymbol *X86MCInstLower::
211 GetConstantPoolIndexSymbol(const MachineOperand &MO) const {
212   SmallString<256> Name;
213   raw_svector_ostream(Name) << AsmPrinter.MAI->getPrivateGlobalPrefix() << "CPI"
214     << AsmPrinter.getFunctionNumber() << '_' << MO.getIndex();
215   
216   switch (MO.getTargetFlags()) {
217   default:
218     llvm_unreachable("Unknown target flag on GV operand");
219   case X86II::MO_NO_FLAG:    // No flag.
220   case X86II::MO_PIC_BASE_OFFSET:
221   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
222   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE:
223     break;
224     // FIXME: These probably should be a modifier on the symbol or something??
225   case X86II::MO_TLSGD:     Name += "@TLSGD";     break;
226   case X86II::MO_GOTTPOFF:  Name += "@GOTTPOFF";  break;
227   case X86II::MO_INDNTPOFF: Name += "@INDNTPOFF"; break;
228   case X86II::MO_TPOFF:     Name += "@TPOFF";     break;
229   case X86II::MO_NTPOFF:    Name += "@NTPOFF";    break;
230   case X86II::MO_GOTPCREL:  Name += "@GOTPCREL";  break;
231   case X86II::MO_GOT:       Name += "@GOT";       break;
232   case X86II::MO_GOTOFF:    Name += "@GOTOFF";    break;
233   case X86II::MO_PLT:       Name += "@PLT";       break;
234   }
235   
236   // Create a symbol for the name.
237   return Ctx.GetOrCreateSymbol(Name.str());
238 }
239
240 MCOperand X86MCInstLower::LowerSymbolOperand(const MachineOperand &MO,
241                                              MCSymbol *Sym) const {
242   // FIXME: We would like an efficient form for this, so we don't have to do a
243   // lot of extra uniquing.
244   const MCExpr *Expr = MCSymbolRefExpr::Create(Sym, Ctx);
245   
246   switch (MO.getTargetFlags()) {
247   default: llvm_unreachable("Unknown target flag on GV operand");
248   case X86II::MO_NO_FLAG:    // No flag.
249       
250   // These affect the name of the symbol, not any suffix.
251   case X86II::MO_DARWIN_NONLAZY:
252   case X86II::MO_DLLIMPORT:
253   case X86II::MO_DARWIN_STUB:
254   case X86II::MO_TLSGD:
255   case X86II::MO_GOTTPOFF:
256   case X86II::MO_INDNTPOFF:
257   case X86II::MO_TPOFF:
258   case X86II::MO_NTPOFF:
259   case X86II::MO_GOTPCREL:
260   case X86II::MO_GOT:
261   case X86II::MO_GOTOFF:
262   case X86II::MO_PLT:
263     break;
264   case X86II::MO_PIC_BASE_OFFSET:
265   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
266   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE:
267     // Subtract the pic base.
268     Expr = MCBinaryExpr::CreateSub(Expr, 
269                                MCSymbolRefExpr::Create(GetPICBaseSymbol(), Ctx),
270                                    Ctx);
271     break;
272   }
273   
274   if (!MO.isJTI() && MO.getOffset())
275     Expr = MCBinaryExpr::CreateAdd(Expr,
276                                    MCConstantExpr::Create(MO.getOffset(), Ctx),
277                                    Ctx);
278   return MCOperand::CreateExpr(Expr);
279 }
280
281
282
283 static void lower_subreg32(MCInst *MI, unsigned OpNo) {
284   // Convert registers in the addr mode according to subreg32.
285   unsigned Reg = MI->getOperand(OpNo).getReg();
286   if (Reg != 0)
287     MI->getOperand(OpNo).setReg(getX86SubSuperRegister(Reg, MVT::i32));
288 }
289
290 static void lower_lea64_32mem(MCInst *MI, unsigned OpNo) {
291   // Convert registers in the addr mode according to subreg64.
292   for (unsigned i = 0; i != 4; ++i) {
293     if (!MI->getOperand(OpNo+i).isReg()) continue;
294     
295     unsigned Reg = MI->getOperand(OpNo+i).getReg();
296     if (Reg == 0) continue;
297     
298     MI->getOperand(OpNo+i).setReg(getX86SubSuperRegister(Reg, MVT::i64));
299   }
300 }
301
302
303
304 void X86MCInstLower::Lower(const MachineInstr *MI, MCInst &OutMI) const {
305   OutMI.setOpcode(MI->getOpcode());
306   
307   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
308     const MachineOperand &MO = MI->getOperand(i);
309     
310     MCOperand MCOp;
311     switch (MO.getType()) {
312     default:
313       MI->dump();
314       llvm_unreachable("unknown operand type");
315     case MachineOperand::MO_Register:
316       MCOp = MCOperand::CreateReg(MO.getReg());
317       break;
318     case MachineOperand::MO_Immediate:
319       MCOp = MCOperand::CreateImm(MO.getImm());
320       break;
321     case MachineOperand::MO_MachineBasicBlock:
322       MCOp = MCOperand::CreateExpr(MCSymbolRefExpr::Create(
323                               GetMBBSymbol(MO.getMBB()->getNumber()), Ctx));
324       break;
325     case MachineOperand::MO_GlobalAddress:
326       MCOp = LowerSymbolOperand(MO, GetGlobalAddressSymbol(MO));
327       break;
328     case MachineOperand::MO_ExternalSymbol:
329       MCOp = LowerSymbolOperand(MO, GetExternalSymbolSymbol(MO));
330       break;
331     case MachineOperand::MO_JumpTableIndex:
332       MCOp = LowerSymbolOperand(MO, GetJumpTableSymbol(MO));
333       break;
334     case MachineOperand::MO_ConstantPoolIndex:
335       MCOp = LowerSymbolOperand(MO, GetConstantPoolIndexSymbol(MO));
336       break;
337     }
338     
339     OutMI.addOperand(MCOp);
340   }
341   
342   // Handle a few special cases to eliminate operand modifiers.
343   switch (OutMI.getOpcode()) {
344   case X86::LEA64_32r: // Handle 'subreg rewriting' for the lea64_32mem operand.
345     lower_lea64_32mem(&OutMI, 1);
346     break;
347   case X86::MOV16r0:
348     OutMI.setOpcode(X86::MOV32r0);
349     lower_subreg32(&OutMI, 0);
350     break;
351   case X86::MOVZX16rr8:
352     OutMI.setOpcode(X86::MOVZX32rr8);
353     lower_subreg32(&OutMI, 0);
354     break;
355   case X86::MOVZX16rm8:
356     OutMI.setOpcode(X86::MOVZX32rm8);
357     lower_subreg32(&OutMI, 0);
358     break;
359   case X86::MOVSX16rr8:
360     OutMI.setOpcode(X86::MOVSX32rr8);
361     lower_subreg32(&OutMI, 0);
362     break;
363   case X86::MOVSX16rm8:
364     OutMI.setOpcode(X86::MOVSX32rm8);
365     lower_subreg32(&OutMI, 0);
366     break;
367   case X86::MOVZX64rr32:
368     OutMI.setOpcode(X86::MOV32rr);
369     lower_subreg32(&OutMI, 0);
370     break;
371   case X86::MOVZX64rm32:
372     OutMI.setOpcode(X86::MOV32rm);
373     lower_subreg32(&OutMI, 0);
374     break;
375   case X86::MOV64ri64i32:
376     OutMI.setOpcode(X86::MOV32ri);
377     lower_subreg32(&OutMI, 0);
378     break;
379   case X86::MOVZX64rr8:
380     OutMI.setOpcode(X86::MOVZX32rr8);
381     lower_subreg32(&OutMI, 0);
382     break;
383   case X86::MOVZX64rm8:
384     OutMI.setOpcode(X86::MOVZX32rm8);
385     lower_subreg32(&OutMI, 0);
386     break;
387   case X86::MOVZX64rr16:
388     OutMI.setOpcode(X86::MOVZX32rr16);
389     lower_subreg32(&OutMI, 0);
390     break;
391   case X86::MOVZX64rm16:
392     OutMI.setOpcode(X86::MOVZX32rm16);
393     lower_subreg32(&OutMI, 0);
394     break;
395   }
396 }
397
398
399
400 void X86ATTAsmPrinter::
401 printInstructionThroughMCStreamer(const MachineInstr *MI) {
402   X86MCInstLower MCInstLowering(OutContext, Mang, *this);
403   switch (MI->getOpcode()) {
404   case TargetInstrInfo::DBG_LABEL:
405   case TargetInstrInfo::EH_LABEL:
406   case TargetInstrInfo::GC_LABEL:
407     printLabel(MI);
408     return;
409   case TargetInstrInfo::INLINEASM:
410     O << '\t';
411     printInlineAsm(MI);
412     return;
413   case TargetInstrInfo::IMPLICIT_DEF:
414     printImplicitDef(MI);
415     return;
416   case X86::MOVPC32r: {
417     MCInst TmpInst;
418     // This is a pseudo op for a two instruction sequence with a label, which
419     // looks like:
420     //     call "L1$pb"
421     // "L1$pb":
422     //     popl %esi
423     
424     // Emit the call.
425     MCSymbol *PICBase = MCInstLowering.GetPICBaseSymbol();
426     TmpInst.setOpcode(X86::CALLpcrel32);
427     // FIXME: We would like an efficient form for this, so we don't have to do a
428     // lot of extra uniquing.
429     TmpInst.addOperand(MCOperand::CreateExpr(MCSymbolRefExpr::Create(PICBase,
430                                                                  OutContext)));
431     printInstruction(&TmpInst);
432     O << '\n';
433     
434     // Emit the label.
435     OutStreamer.EmitLabel(PICBase);
436     
437     // popl $reg
438     TmpInst.setOpcode(X86::POP32r);
439     TmpInst.getOperand(0) = MCOperand::CreateReg(MI->getOperand(0).getReg());
440     printInstruction(&TmpInst);
441     return;
442   }
443       
444   case X86::ADD32ri: {
445     // Lower the MO_GOT_ABSOLUTE_ADDRESS form of ADD32ri.
446     if (MI->getOperand(2).getTargetFlags() != X86II::MO_GOT_ABSOLUTE_ADDRESS)
447       break;
448     
449     // Okay, we have something like:
450     //  EAX = ADD32ri EAX, MO_GOT_ABSOLUTE_ADDRESS(@MYGLOBAL)
451     
452     // For this, we want to print something like:
453     //   MYGLOBAL + (. - PICBASE)
454     // However, we can't generate a ".", so just emit a new label here and refer
455     // to it.  We know that this operand flag occurs at most once per function.
456     SmallString<64> Name;
457     raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix()
458       << "picbaseref" << getFunctionNumber();
459     MCSymbol *DotSym = OutContext.GetOrCreateSymbol(Name.str());
460     OutStreamer.EmitLabel(DotSym);
461     
462     // Now that we have emitted the label, lower the complex operand expression.
463     MCSymbol *OpSym = MCInstLowering.GetExternalSymbolSymbol(MI->getOperand(2));
464     
465     const MCExpr *DotExpr = MCSymbolRefExpr::Create(DotSym, OutContext);
466     const MCExpr *PICBase =
467       MCSymbolRefExpr::Create(MCInstLowering.GetPICBaseSymbol(), OutContext);
468     DotExpr = MCBinaryExpr::CreateSub(DotExpr, PICBase, OutContext);
469     
470     DotExpr = MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(OpSym,OutContext), 
471                                       DotExpr, OutContext);
472     
473     MCInst TmpInst;
474     TmpInst.setOpcode(X86::ADD32ri);
475     TmpInst.addOperand(MCOperand::CreateReg(MI->getOperand(0).getReg()));
476     TmpInst.addOperand(MCOperand::CreateReg(MI->getOperand(1).getReg()));
477     TmpInst.addOperand(MCOperand::CreateExpr(DotExpr));
478     printInstruction(&TmpInst);
479     return;
480   }
481   }
482   
483   MCInst TmpInst;
484   MCInstLowering.Lower(MI, TmpInst);
485   
486   
487   printInstruction(&TmpInst);
488 }