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