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