Initial x86 support for BlockAddresses.
[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/FormattedStream.h"
25 #include "llvm/Support/Mangler.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
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       Name.clear();
87       Mang->getNameWithPrefix(Name, GV, false);
88       StubSym = Ctx.GetOrCreateSymbol(Name.str());
89     }
90     return Sym;
91   }
92   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE: {
93     Name += "$non_lazy_ptr";
94     MCSymbol *Sym = Ctx.GetOrCreateSymbol(Name.str());
95     const MCSymbol *&StubSym = getMachOMMI().getHiddenGVStubEntry(Sym);
96     if (StubSym == 0) {
97       Name.clear();
98       Mang->getNameWithPrefix(Name, GV, false);
99       StubSym = Ctx.GetOrCreateSymbol(Name.str());
100     }
101     return Sym;
102   }
103   case X86II::MO_DARWIN_STUB: {
104     Name += "$stub";
105     MCSymbol *Sym = Ctx.GetOrCreateSymbol(Name.str());
106     const MCSymbol *&StubSym = getMachOMMI().getFnStubEntry(Sym);
107     if (StubSym == 0) {
108       Name.clear();
109       Mang->getNameWithPrefix(Name, GV, false);
110       StubSym = Ctx.GetOrCreateSymbol(Name.str());
111     }
112     return Sym;
113   }
114   // FIXME: These probably should be a modifier on the symbol or something??
115   case X86II::MO_TLSGD:     Name += "@TLSGD";     break;
116   case X86II::MO_GOTTPOFF:  Name += "@GOTTPOFF";  break;
117   case X86II::MO_INDNTPOFF: Name += "@INDNTPOFF"; break;
118   case X86II::MO_TPOFF:     Name += "@TPOFF";     break;
119   case X86II::MO_NTPOFF:    Name += "@NTPOFF";    break;
120   case X86II::MO_GOTPCREL:  Name += "@GOTPCREL";  break;
121   case X86II::MO_GOT:       Name += "@GOT";       break;
122   case X86II::MO_GOTOFF:    Name += "@GOTOFF";    break;
123   case X86II::MO_PLT:       Name += "@PLT";       break;
124   }
125   
126   return Ctx.GetOrCreateSymbol(Name.str());
127 }
128
129 MCSymbol *X86MCInstLower::
130 GetExternalSymbolSymbol(const MachineOperand &MO) const {
131   SmallString<128> Name;
132   Name += AsmPrinter.MAI->getGlobalPrefix();
133   Name += MO.getSymbolName();
134   
135   switch (MO.getTargetFlags()) {
136   default: llvm_unreachable("Unknown target flag on GV operand");
137   case X86II::MO_NO_FLAG:                // No flag.
138   case X86II::MO_GOT_ABSOLUTE_ADDRESS:   // Doesn't modify symbol name.
139   case X86II::MO_PIC_BASE_OFFSET:        // Doesn't modify symbol name.
140     break;
141   case X86II::MO_DLLIMPORT: {
142     // Handle dllimport linkage.
143     const char *Prefix = "__imp_";
144     Name.insert(Name.begin(), Prefix, Prefix+strlen(Prefix));
145     break;
146   }
147   case X86II::MO_DARWIN_STUB: {
148     Name += "$stub";
149     MCSymbol *Sym = Ctx.GetOrCreateSymbol(Name.str());
150     const MCSymbol *&StubSym = getMachOMMI().getFnStubEntry(Sym);
151
152     if (StubSym == 0) {
153       Name.erase(Name.end()-5, Name.end());
154       StubSym = Ctx.GetOrCreateSymbol(Name.str());
155     }
156     return Sym;
157   }
158   // FIXME: These probably should be a modifier on the symbol or something??
159   case X86II::MO_TLSGD:     Name += "@TLSGD";     break;
160   case X86II::MO_GOTTPOFF:  Name += "@GOTTPOFF";  break;
161   case X86II::MO_INDNTPOFF: Name += "@INDNTPOFF"; break;
162   case X86II::MO_TPOFF:     Name += "@TPOFF";     break;
163   case X86II::MO_NTPOFF:    Name += "@NTPOFF";    break;
164   case X86II::MO_GOTPCREL:  Name += "@GOTPCREL";  break;
165   case X86II::MO_GOT:       Name += "@GOT";       break;
166   case X86II::MO_GOTOFF:    Name += "@GOTOFF";    break;
167   case X86II::MO_PLT:       Name += "@PLT";       break;
168   }
169   
170   return Ctx.GetOrCreateSymbol(Name.str());
171 }
172
173 MCSymbol *X86MCInstLower::GetJumpTableSymbol(const MachineOperand &MO) const {
174   SmallString<256> Name;
175   raw_svector_ostream(Name) << AsmPrinter.MAI->getPrivateGlobalPrefix() << "JTI"
176     << AsmPrinter.getFunctionNumber() << '_' << MO.getIndex();
177   
178   switch (MO.getTargetFlags()) {
179   default:
180     llvm_unreachable("Unknown target flag on GV operand");
181   case X86II::MO_NO_FLAG:    // No flag.
182   case X86II::MO_PIC_BASE_OFFSET:
183   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
184   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE:
185     break;
186     // FIXME: These probably should be a modifier on the symbol or something??
187   case X86II::MO_TLSGD:     Name += "@TLSGD";     break;
188   case X86II::MO_GOTTPOFF:  Name += "@GOTTPOFF";  break;
189   case X86II::MO_INDNTPOFF: Name += "@INDNTPOFF"; break;
190   case X86II::MO_TPOFF:     Name += "@TPOFF";     break;
191   case X86II::MO_NTPOFF:    Name += "@NTPOFF";    break;
192   case X86II::MO_GOTPCREL:  Name += "@GOTPCREL";  break;
193   case X86II::MO_GOT:       Name += "@GOT";       break;
194   case X86II::MO_GOTOFF:    Name += "@GOTOFF";    break;
195   case X86II::MO_PLT:       Name += "@PLT";       break;
196   }
197   
198   // Create a symbol for the name.
199   return Ctx.GetOrCreateSymbol(Name.str());
200 }
201
202
203 MCSymbol *X86MCInstLower::
204 GetConstantPoolIndexSymbol(const MachineOperand &MO) const {
205   SmallString<256> Name;
206   raw_svector_ostream(Name) << AsmPrinter.MAI->getPrivateGlobalPrefix() << "CPI"
207     << AsmPrinter.getFunctionNumber() << '_' << MO.getIndex();
208   
209   switch (MO.getTargetFlags()) {
210   default:
211     llvm_unreachable("Unknown target flag on GV operand");
212   case X86II::MO_NO_FLAG:    // No flag.
213   case X86II::MO_PIC_BASE_OFFSET:
214   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
215   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE:
216     break;
217     // FIXME: These probably should be a modifier on the symbol or something??
218   case X86II::MO_TLSGD:     Name += "@TLSGD";     break;
219   case X86II::MO_GOTTPOFF:  Name += "@GOTTPOFF";  break;
220   case X86II::MO_INDNTPOFF: Name += "@INDNTPOFF"; break;
221   case X86II::MO_TPOFF:     Name += "@TPOFF";     break;
222   case X86II::MO_NTPOFF:    Name += "@NTPOFF";    break;
223   case X86II::MO_GOTPCREL:  Name += "@GOTPCREL";  break;
224   case X86II::MO_GOT:       Name += "@GOT";       break;
225   case X86II::MO_GOTOFF:    Name += "@GOTOFF";    break;
226   case X86II::MO_PLT:       Name += "@PLT";       break;
227   }
228   
229   // Create a symbol for the name.
230   return Ctx.GetOrCreateSymbol(Name.str());
231 }
232
233 MCOperand X86MCInstLower::LowerSymbolOperand(const MachineOperand &MO,
234                                              MCSymbol *Sym) const {
235   // FIXME: We would like an efficient form for this, so we don't have to do a
236   // lot of extra uniquing.
237   const MCExpr *Expr = MCSymbolRefExpr::Create(Sym, Ctx);
238   
239   switch (MO.getTargetFlags()) {
240   default: llvm_unreachable("Unknown target flag on GV operand");
241   case X86II::MO_NO_FLAG:    // No flag.
242       
243   // These affect the name of the symbol, not any suffix.
244   case X86II::MO_DARWIN_NONLAZY:
245   case X86II::MO_DLLIMPORT:
246   case X86II::MO_DARWIN_STUB:
247   case X86II::MO_TLSGD:
248   case X86II::MO_GOTTPOFF:
249   case X86II::MO_INDNTPOFF:
250   case X86II::MO_TPOFF:
251   case X86II::MO_NTPOFF:
252   case X86II::MO_GOTPCREL:
253   case X86II::MO_GOT:
254   case X86II::MO_GOTOFF:
255   case X86II::MO_PLT:
256     break;
257   case X86II::MO_PIC_BASE_OFFSET:
258   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
259   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE:
260     // Subtract the pic base.
261     Expr = MCBinaryExpr::CreateSub(Expr, 
262                                MCSymbolRefExpr::Create(GetPICBaseSymbol(), Ctx),
263                                    Ctx);
264     break;
265   }
266   
267   if (!MO.isJTI() && MO.getOffset())
268     Expr = MCBinaryExpr::CreateAdd(Expr,
269                                    MCConstantExpr::Create(MO.getOffset(), Ctx),
270                                    Ctx);
271   return MCOperand::CreateExpr(Expr);
272 }
273
274
275
276 static void lower_subreg32(MCInst *MI, unsigned OpNo) {
277   // Convert registers in the addr mode according to subreg32.
278   unsigned Reg = MI->getOperand(OpNo).getReg();
279   if (Reg != 0)
280     MI->getOperand(OpNo).setReg(getX86SubSuperRegister(Reg, MVT::i32));
281 }
282
283 static void lower_lea64_32mem(MCInst *MI, unsigned OpNo) {
284   // Convert registers in the addr mode according to subreg64.
285   for (unsigned i = 0; i != 4; ++i) {
286     if (!MI->getOperand(OpNo+i).isReg()) continue;
287     
288     unsigned Reg = MI->getOperand(OpNo+i).getReg();
289     if (Reg == 0) continue;
290     
291     MI->getOperand(OpNo+i).setReg(getX86SubSuperRegister(Reg, MVT::i64));
292   }
293 }
294
295
296
297 void X86MCInstLower::Lower(const MachineInstr *MI, MCInst &OutMI) const {
298   OutMI.setOpcode(MI->getOpcode());
299   
300   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
301     const MachineOperand &MO = MI->getOperand(i);
302     
303     MCOperand MCOp;
304     switch (MO.getType()) {
305     default:
306       MI->dump();
307       llvm_unreachable("unknown operand type");
308     case MachineOperand::MO_Register:
309       // Ignore all implicit register operands.
310       if (MO.isImplicit()) continue;
311       MCOp = MCOperand::CreateReg(MO.getReg());
312       break;
313     case MachineOperand::MO_Immediate:
314       MCOp = MCOperand::CreateImm(MO.getImm());
315       break;
316     case MachineOperand::MO_MachineBasicBlock:
317       MCOp = MCOperand::CreateExpr(MCSymbolRefExpr::Create(
318                        AsmPrinter.GetMBBSymbol(MO.getMBB()->getNumber()), Ctx));
319       break;
320     case MachineOperand::MO_GlobalAddress:
321       MCOp = LowerSymbolOperand(MO, GetGlobalAddressSymbol(MO));
322       break;
323     case MachineOperand::MO_ExternalSymbol:
324       MCOp = LowerSymbolOperand(MO, GetExternalSymbolSymbol(MO));
325       break;
326     case MachineOperand::MO_JumpTableIndex:
327       MCOp = LowerSymbolOperand(MO, GetJumpTableSymbol(MO));
328       break;
329     case MachineOperand::MO_ConstantPoolIndex:
330       MCOp = LowerSymbolOperand(MO, GetConstantPoolIndexSymbol(MO));
331       break;
332     case MachineOperand::MO_BlockAddress:
333       MCOp = LowerSymbolOperand(MO, AsmPrinter.GetBlockAddressSymbol(
334                                                  MO.getBlockAddress()));
335       break;
336     }
337     
338     OutMI.addOperand(MCOp);
339   }
340   
341   // Handle a few special cases to eliminate operand modifiers.
342   switch (OutMI.getOpcode()) {
343   case X86::LEA64_32r: // Handle 'subreg rewriting' for the lea64_32mem operand.
344     lower_lea64_32mem(&OutMI, 1);
345     break;
346   case X86::MOV16r0:
347     OutMI.setOpcode(X86::MOV32r0);
348     lower_subreg32(&OutMI, 0);
349     break;
350   case X86::MOVZX16rr8:
351     OutMI.setOpcode(X86::MOVZX32rr8);
352     lower_subreg32(&OutMI, 0);
353     break;
354   case X86::MOVZX16rm8:
355     OutMI.setOpcode(X86::MOVZX32rm8);
356     lower_subreg32(&OutMI, 0);
357     break;
358   case X86::MOVSX16rr8:
359     OutMI.setOpcode(X86::MOVSX32rr8);
360     lower_subreg32(&OutMI, 0);
361     break;
362   case X86::MOVSX16rm8:
363     OutMI.setOpcode(X86::MOVSX32rm8);
364     lower_subreg32(&OutMI, 0);
365     break;
366   case X86::MOVZX64rr32:
367     OutMI.setOpcode(X86::MOV32rr);
368     lower_subreg32(&OutMI, 0);
369     break;
370   case X86::MOVZX64rm32:
371     OutMI.setOpcode(X86::MOV32rm);
372     lower_subreg32(&OutMI, 0);
373     break;
374   case X86::MOV64ri64i32:
375     OutMI.setOpcode(X86::MOV32ri);
376     lower_subreg32(&OutMI, 0);
377     break;
378   case X86::MOVZX64rr8:
379     OutMI.setOpcode(X86::MOVZX32rr8);
380     lower_subreg32(&OutMI, 0);
381     break;
382   case X86::MOVZX64rm8:
383     OutMI.setOpcode(X86::MOVZX32rm8);
384     lower_subreg32(&OutMI, 0);
385     break;
386   case X86::MOVZX64rr16:
387     OutMI.setOpcode(X86::MOVZX32rr16);
388     lower_subreg32(&OutMI, 0);
389     break;
390   case X86::MOVZX64rm16:
391     OutMI.setOpcode(X86::MOVZX32rm16);
392     lower_subreg32(&OutMI, 0);
393     break;
394   }
395 }
396
397
398
399 void X86AsmPrinter::printInstructionThroughMCStreamer(const MachineInstr *MI) {
400   X86MCInstLower MCInstLowering(OutContext, Mang, *this);
401   switch (MI->getOpcode()) {
402   case TargetInstrInfo::DBG_LABEL:
403   case TargetInstrInfo::EH_LABEL:
404   case TargetInstrInfo::GC_LABEL:
405     printLabel(MI);
406     return;
407   case TargetInstrInfo::INLINEASM:
408     O << '\t';
409     printInlineAsm(MI);
410     return;
411   case TargetInstrInfo::IMPLICIT_DEF:
412     printImplicitDef(MI);
413     return;
414   case TargetInstrInfo::KILL:
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     printMCInst(&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     printMCInst(&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     const char *Prefix = MAI->getPrivateGlobalPrefix();
457     MCSymbol *DotSym = OutContext.GetOrCreateSymbol(Twine(Prefix)+"picbaseref"+
458                                                     Twine(getFunctionNumber()));
459     OutStreamer.EmitLabel(DotSym);
460     
461     // Now that we have emitted the label, lower the complex operand expression.
462     MCSymbol *OpSym = MCInstLowering.GetExternalSymbolSymbol(MI->getOperand(2));
463     
464     const MCExpr *DotExpr = MCSymbolRefExpr::Create(DotSym, OutContext);
465     const MCExpr *PICBase =
466       MCSymbolRefExpr::Create(MCInstLowering.GetPICBaseSymbol(), OutContext);
467     DotExpr = MCBinaryExpr::CreateSub(DotExpr, PICBase, OutContext);
468     
469     DotExpr = MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(OpSym,OutContext), 
470                                       DotExpr, OutContext);
471     
472     MCInst TmpInst;
473     TmpInst.setOpcode(X86::ADD32ri);
474     TmpInst.addOperand(MCOperand::CreateReg(MI->getOperand(0).getReg()));
475     TmpInst.addOperand(MCOperand::CreateReg(MI->getOperand(1).getReg()));
476     TmpInst.addOperand(MCOperand::CreateExpr(DotExpr));
477     printMCInst(&TmpInst);
478     return;
479   }
480   }
481   
482   MCInst TmpInst;
483   MCInstLowering.Lower(MI, TmpInst);
484   
485   
486   printMCInst(&TmpInst);
487 }
488