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