MC: Allow modifiers in MCSymbolRefExpr, and eliminate X86MCTargetExpr.
[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 "X86COFFMachineModuleInfo.h"
18 #include "X86MCAsmInfo.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/MC/MCSymbol.h"
26 #include "llvm/Target/Mangler.h"
27 #include "llvm/Support/FormattedStream.h"
28 #include "llvm/ADT/SmallString.h"
29 #include "llvm/Type.h"
30 using namespace llvm;
31
32
33 const X86Subtarget &X86MCInstLower::getSubtarget() const {
34   return AsmPrinter.getSubtarget();
35 }
36
37 MachineModuleInfoMachO &X86MCInstLower::getMachOMMI() const {
38   assert(getSubtarget().isTargetDarwin() &&"Can only get MachO info on darwin");
39   return AsmPrinter.MMI->getObjFileInfo<MachineModuleInfoMachO>(); 
40 }
41
42
43 MCSymbol *X86MCInstLower::GetPICBaseSymbol() const {
44   const TargetLowering *TLI = AsmPrinter.TM.getTargetLowering();
45   return static_cast<const X86TargetLowering*>(TLI)->
46     getPICBaseSymbol(AsmPrinter.MF, Ctx);
47 }
48
49 /// GetSymbolFromOperand - Lower an MO_GlobalAddress or MO_ExternalSymbol
50 /// operand to an MCSymbol.
51 MCSymbol *X86MCInstLower::
52 GetSymbolFromOperand(const MachineOperand &MO) const {
53   assert((MO.isGlobal() || MO.isSymbol()) && "Isn't a symbol reference");
54
55   SmallString<128> Name;
56   
57   if (!MO.isGlobal()) {
58     assert(MO.isSymbol());
59     Name += AsmPrinter.MAI->getGlobalPrefix();
60     Name += MO.getSymbolName();
61   } else {    
62     const GlobalValue *GV = MO.getGlobal();
63     bool isImplicitlyPrivate = false;
64     if (MO.getTargetFlags() == X86II::MO_DARWIN_STUB ||
65         MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY ||
66         MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY_PIC_BASE ||
67         MO.getTargetFlags() == X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE)
68       isImplicitlyPrivate = true;
69     
70     Mang->getNameWithPrefix(Name, GV, isImplicitlyPrivate);
71   }
72
73   // If the target flags on the operand changes the name of the symbol, do that
74   // before we return the symbol.
75   switch (MO.getTargetFlags()) {
76   default: break;
77   case X86II::MO_DLLIMPORT: {
78     // Handle dllimport linkage.
79     const char *Prefix = "__imp_";
80     Name.insert(Name.begin(), Prefix, Prefix+strlen(Prefix));
81     break;
82   }
83   case X86II::MO_DARWIN_NONLAZY:
84   case X86II::MO_DARWIN_NONLAZY_PIC_BASE: {
85     Name += "$non_lazy_ptr";
86     MCSymbol *Sym = Ctx.GetOrCreateTemporarySymbol(Name.str());
87
88     MachineModuleInfoImpl::StubValueTy &StubSym =
89       getMachOMMI().getGVStubEntry(Sym);
90     if (StubSym.getPointer() == 0) {
91       assert(MO.isGlobal() && "Extern symbol not handled yet");
92       StubSym =
93         MachineModuleInfoImpl::
94         StubValueTy(AsmPrinter.Mang->getSymbol(MO.getGlobal()),
95                     !MO.getGlobal()->hasInternalLinkage());
96     }
97     return Sym;
98   }
99   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE: {
100     Name += "$non_lazy_ptr";
101     MCSymbol *Sym = Ctx.GetOrCreateTemporarySymbol(Name.str());
102     MachineModuleInfoImpl::StubValueTy &StubSym =
103       getMachOMMI().getHiddenGVStubEntry(Sym);
104     if (StubSym.getPointer() == 0) {
105       assert(MO.isGlobal() && "Extern symbol not handled yet");
106       StubSym =
107         MachineModuleInfoImpl::
108         StubValueTy(AsmPrinter.Mang->getSymbol(MO.getGlobal()),
109                     !MO.getGlobal()->hasInternalLinkage());
110     }
111     return Sym;
112   }
113   case X86II::MO_DARWIN_STUB: {
114     Name += "$stub";
115     MCSymbol *Sym = Ctx.GetOrCreateTemporarySymbol(Name.str());
116     MachineModuleInfoImpl::StubValueTy &StubSym =
117       getMachOMMI().getFnStubEntry(Sym);
118     if (StubSym.getPointer())
119       return Sym;
120     
121     if (MO.isGlobal()) {
122       StubSym =
123         MachineModuleInfoImpl::
124         StubValueTy(AsmPrinter.Mang->getSymbol(MO.getGlobal()),
125                     !MO.getGlobal()->hasInternalLinkage());
126     } else {
127       Name.erase(Name.end()-5, Name.end());
128       StubSym =
129         MachineModuleInfoImpl::
130         StubValueTy(Ctx.GetOrCreateTemporarySymbol(Name.str()), false);
131     }
132     return Sym;
133   }
134   }
135
136   return Ctx.GetOrCreateSymbol(Name.str());
137 }
138
139 MCOperand X86MCInstLower::LowerSymbolOperand(const MachineOperand &MO,
140                                              MCSymbol *Sym) const {
141   // FIXME: We would like an efficient form for this, so we don't have to do a
142   // lot of extra uniquing.
143   const MCExpr *Expr = 0;
144   MCSymbolRefExpr::VariantKind RefKind = MCSymbolRefExpr::VK_None;
145   
146   switch (MO.getTargetFlags()) {
147   default: llvm_unreachable("Unknown target flag on GV operand");
148   case X86II::MO_NO_FLAG:    // No flag.
149   // These affect the name of the symbol, not any suffix.
150   case X86II::MO_DARWIN_NONLAZY:
151   case X86II::MO_DLLIMPORT:
152   case X86II::MO_DARWIN_STUB:
153     break;
154       
155   case X86II::MO_TLSGD:     RefKind = MCSymbolRefExpr::VK_TLSGD; break;
156   case X86II::MO_GOTTPOFF:  RefKind = MCSymbolRefExpr::VK_GOTTPOFF; break;
157   case X86II::MO_INDNTPOFF: RefKind = MCSymbolRefExpr::VK_INDNTPOFF; break;
158   case X86II::MO_TPOFF:     RefKind = MCSymbolRefExpr::VK_TPOFF; break;
159   case X86II::MO_NTPOFF:    RefKind = MCSymbolRefExpr::VK_NTPOFF; break;
160   case X86II::MO_GOTPCREL:  RefKind = MCSymbolRefExpr::VK_GOTPCREL; break;
161   case X86II::MO_GOT:       RefKind = MCSymbolRefExpr::VK_GOT; break;
162   case X86II::MO_GOTOFF:    RefKind = MCSymbolRefExpr::VK_GOTOFF; break;
163   case X86II::MO_PLT:       RefKind = MCSymbolRefExpr::VK_PLT; break;
164   case X86II::MO_PIC_BASE_OFFSET:
165   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
166   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE:
167     Expr = MCSymbolRefExpr::Create(Sym, Ctx);
168     // Subtract the pic base.
169     Expr = MCBinaryExpr::CreateSub(Expr, 
170                                MCSymbolRefExpr::Create(GetPICBaseSymbol(), Ctx),
171                                    Ctx);
172     break;
173   }
174   
175   if (Expr == 0)
176     Expr = MCSymbolRefExpr::Create(Sym, RefKind, Ctx);
177   
178   if (!MO.isJTI() && MO.getOffset())
179     Expr = MCBinaryExpr::CreateAdd(Expr,
180                                    MCConstantExpr::Create(MO.getOffset(), Ctx),
181                                    Ctx);
182   return MCOperand::CreateExpr(Expr);
183 }
184
185
186
187 static void lower_subreg32(MCInst *MI, unsigned OpNo) {
188   // Convert registers in the addr mode according to subreg32.
189   unsigned Reg = MI->getOperand(OpNo).getReg();
190   if (Reg != 0)
191     MI->getOperand(OpNo).setReg(getX86SubSuperRegister(Reg, MVT::i32));
192 }
193
194 static void lower_lea64_32mem(MCInst *MI, unsigned OpNo) {
195   // Convert registers in the addr mode according to subreg64.
196   for (unsigned i = 0; i != 4; ++i) {
197     if (!MI->getOperand(OpNo+i).isReg()) continue;
198     
199     unsigned Reg = MI->getOperand(OpNo+i).getReg();
200     if (Reg == 0) continue;
201     
202     MI->getOperand(OpNo+i).setReg(getX86SubSuperRegister(Reg, MVT::i64));
203   }
204 }
205
206 /// LowerSubReg32_Op0 - Things like MOVZX16rr8 -> MOVZX32rr8.
207 static void LowerSubReg32_Op0(MCInst &OutMI, unsigned NewOpc) {
208   OutMI.setOpcode(NewOpc);
209   lower_subreg32(&OutMI, 0);
210 }
211 /// LowerUnaryToTwoAddr - R = setb   -> R = sbb R, R
212 static void LowerUnaryToTwoAddr(MCInst &OutMI, unsigned NewOpc) {
213   OutMI.setOpcode(NewOpc);
214   OutMI.addOperand(OutMI.getOperand(0));
215   OutMI.addOperand(OutMI.getOperand(0));
216 }
217
218
219 void X86MCInstLower::Lower(const MachineInstr *MI, MCInst &OutMI) const {
220   OutMI.setOpcode(MI->getOpcode());
221   
222   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
223     const MachineOperand &MO = MI->getOperand(i);
224     
225     MCOperand MCOp;
226     switch (MO.getType()) {
227     default:
228       MI->dump();
229       llvm_unreachable("unknown operand type");
230     case MachineOperand::MO_Register:
231       // Ignore all implicit register operands.
232       if (MO.isImplicit()) continue;
233       MCOp = MCOperand::CreateReg(MO.getReg());
234       break;
235     case MachineOperand::MO_Immediate:
236       MCOp = MCOperand::CreateImm(MO.getImm());
237       break;
238     case MachineOperand::MO_MachineBasicBlock:
239       MCOp = MCOperand::CreateExpr(MCSymbolRefExpr::Create(
240                        MO.getMBB()->getSymbol(), Ctx));
241       break;
242     case MachineOperand::MO_GlobalAddress:
243       MCOp = LowerSymbolOperand(MO, GetSymbolFromOperand(MO));
244       break;
245     case MachineOperand::MO_ExternalSymbol:
246       MCOp = LowerSymbolOperand(MO, GetSymbolFromOperand(MO));
247       break;
248     case MachineOperand::MO_JumpTableIndex:
249       MCOp = LowerSymbolOperand(MO, AsmPrinter.GetJTISymbol(MO.getIndex()));
250       break;
251     case MachineOperand::MO_ConstantPoolIndex:
252       MCOp = LowerSymbolOperand(MO, AsmPrinter.GetCPISymbol(MO.getIndex()));
253       break;
254     case MachineOperand::MO_BlockAddress:
255       MCOp = LowerSymbolOperand(MO,
256                         AsmPrinter.GetBlockAddressSymbol(MO.getBlockAddress()));
257       break;
258     }
259     
260     OutMI.addOperand(MCOp);
261   }
262   
263   // Handle a few special cases to eliminate operand modifiers.
264   switch (OutMI.getOpcode()) {
265   case X86::LEA64_32r: // Handle 'subreg rewriting' for the lea64_32mem operand.
266     lower_lea64_32mem(&OutMI, 1);
267     break;
268   case X86::MOVZX16rr8:   LowerSubReg32_Op0(OutMI, X86::MOVZX32rr8); break;
269   case X86::MOVZX16rm8:   LowerSubReg32_Op0(OutMI, X86::MOVZX32rm8); break;
270   case X86::MOVSX16rr8:   LowerSubReg32_Op0(OutMI, X86::MOVSX32rr8); break;
271   case X86::MOVSX16rm8:   LowerSubReg32_Op0(OutMI, X86::MOVSX32rm8); break;
272   case X86::MOVZX64rr32:  LowerSubReg32_Op0(OutMI, X86::MOV32rr); break;
273   case X86::MOVZX64rm32:  LowerSubReg32_Op0(OutMI, X86::MOV32rm); break;
274   case X86::MOV64ri64i32: LowerSubReg32_Op0(OutMI, X86::MOV32ri); break;
275   case X86::MOVZX64rr8:   LowerSubReg32_Op0(OutMI, X86::MOVZX32rr8); break;
276   case X86::MOVZX64rm8:   LowerSubReg32_Op0(OutMI, X86::MOVZX32rm8); break;
277   case X86::MOVZX64rr16:  LowerSubReg32_Op0(OutMI, X86::MOVZX32rr16); break;
278   case X86::MOVZX64rm16:  LowerSubReg32_Op0(OutMI, X86::MOVZX32rm16); break;
279   case X86::SETB_C8r:     LowerUnaryToTwoAddr(OutMI, X86::SBB8rr); break;
280   case X86::SETB_C16r:    LowerUnaryToTwoAddr(OutMI, X86::SBB16rr); break;
281   case X86::SETB_C32r:    LowerUnaryToTwoAddr(OutMI, X86::SBB32rr); break;
282   case X86::SETB_C64r:    LowerUnaryToTwoAddr(OutMI, X86::SBB64rr); break;
283   case X86::MOV8r0:       LowerUnaryToTwoAddr(OutMI, X86::XOR8rr); break;
284   case X86::MOV32r0:      LowerUnaryToTwoAddr(OutMI, X86::XOR32rr); break;
285   case X86::MMX_V_SET0:   LowerUnaryToTwoAddr(OutMI, X86::MMX_PXORrr); break;
286   case X86::MMX_V_SETALLONES:
287     LowerUnaryToTwoAddr(OutMI, X86::MMX_PCMPEQDrr); break;
288   case X86::FsFLD0SS:     LowerUnaryToTwoAddr(OutMI, X86::PXORrr); break;
289   case X86::FsFLD0SD:     LowerUnaryToTwoAddr(OutMI, X86::PXORrr); break;
290   case X86::V_SET0:       LowerUnaryToTwoAddr(OutMI, X86::XORPSrr); break;
291   case X86::V_SETALLONES: LowerUnaryToTwoAddr(OutMI, X86::PCMPEQDrr); break;
292
293   case X86::MOV16r0:
294     LowerSubReg32_Op0(OutMI, X86::MOV32r0);   // MOV16r0 -> MOV32r0
295     LowerUnaryToTwoAddr(OutMI, X86::XOR32rr); // MOV32r0 -> XOR32rr
296     break;
297   case X86::MOV64r0:
298     LowerSubReg32_Op0(OutMI, X86::MOV32r0);   // MOV64r0 -> MOV32r0
299     LowerUnaryToTwoAddr(OutMI, X86::XOR32rr); // MOV32r0 -> XOR32rr
300     break;
301       
302       
303   // The assembler backend wants to see branches in their small form and relax
304   // them to their large form.  The JIT can only handle the large form because
305   // it does not do relaxation.  For now, translate the large form to the
306   // small one here.
307   case X86::JMP_4: OutMI.setOpcode(X86::JMP_1); break;
308   case X86::JO_4:  OutMI.setOpcode(X86::JO_1); break;
309   case X86::JNO_4: OutMI.setOpcode(X86::JNO_1); break;
310   case X86::JB_4:  OutMI.setOpcode(X86::JB_1); break;
311   case X86::JAE_4: OutMI.setOpcode(X86::JAE_1); break;
312   case X86::JE_4:  OutMI.setOpcode(X86::JE_1); break;
313   case X86::JNE_4: OutMI.setOpcode(X86::JNE_1); break;
314   case X86::JBE_4: OutMI.setOpcode(X86::JBE_1); break;
315   case X86::JA_4:  OutMI.setOpcode(X86::JA_1); break;
316   case X86::JS_4:  OutMI.setOpcode(X86::JS_1); break;
317   case X86::JNS_4: OutMI.setOpcode(X86::JNS_1); break;
318   case X86::JP_4:  OutMI.setOpcode(X86::JP_1); break;
319   case X86::JNP_4: OutMI.setOpcode(X86::JNP_1); break;
320   case X86::JL_4:  OutMI.setOpcode(X86::JL_1); break;
321   case X86::JGE_4: OutMI.setOpcode(X86::JGE_1); break;
322   case X86::JLE_4: OutMI.setOpcode(X86::JLE_1); break;
323   case X86::JG_4:  OutMI.setOpcode(X86::JG_1); break;
324   }
325 }
326
327
328
329 void X86AsmPrinter::EmitInstruction(const MachineInstr *MI) {
330   X86MCInstLower MCInstLowering(OutContext, Mang, *this);
331   switch (MI->getOpcode()) {
332   case TargetOpcode::DBG_VALUE: {
333     // FIXME: if this is implemented for another target before it goes
334     // away completely, the common part should be moved into AsmPrinter.
335     if (!VerboseAsm)
336       return;
337     O << '\t' << MAI->getCommentString() << "DEBUG_VALUE: ";
338     unsigned NOps = MI->getNumOperands();
339     // cast away const; DIetc do not take const operands for some reason.
340     DIVariable V((MDNode*)(MI->getOperand(NOps-1).getMetadata()));
341     O << V.getName();
342     O << " <- ";
343     if (NOps==3) {
344       // Register or immediate value. Register 0 means undef.
345       assert(MI->getOperand(0).getType()==MachineOperand::MO_Register ||
346              MI->getOperand(0).getType()==MachineOperand::MO_Immediate ||
347              MI->getOperand(0).getType()==MachineOperand::MO_FPImmediate);
348       if (MI->getOperand(0).getType()==MachineOperand::MO_Register &&
349           MI->getOperand(0).getReg()==0) {
350         // Suppress offset in this case, it is not meaningful.
351         O << "undef";
352         OutStreamer.AddBlankLine();
353         return;
354       } else if (MI->getOperand(0).getType()==MachineOperand::MO_FPImmediate) {
355         // This is more naturally done in printOperand, but since the only use
356         // of such an operand is in this comment and that is temporary (and it's
357         // ugly), we prefer to keep this localized.
358         // The include of Type.h may be removable when this code is.
359         if (MI->getOperand(0).getFPImm()->getType()->isFloatTy() ||
360             MI->getOperand(0).getFPImm()->getType()->isDoubleTy())
361           MI->getOperand(0).print(O, &TM);
362         else {
363           // There is no good way to print long double.  Convert a copy to
364           // double.  Ah well, it's only a comment.
365           bool ignored;
366           APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
367           APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
368                       &ignored);
369           O << "(long double) " << APF.convertToDouble();
370         }
371       } else
372         printOperand(MI, 0);
373     } else {
374       if (MI->getOperand(0).getType()==MachineOperand::MO_Register &&
375           MI->getOperand(0).getReg()==0) {
376         // Suppress offset in this case, it is not meaningful.
377         O << "undef";
378         OutStreamer.AddBlankLine();
379         return;
380       }
381       // Frame address.  Currently handles register +- offset only.
382       assert(MI->getOperand(0).getType()==MachineOperand::MO_Register);
383       assert(MI->getOperand(3).getType()==MachineOperand::MO_Immediate);
384       O << '['; printOperand(MI, 0); O << '+'; printOperand(MI, 3); O << ']';
385     }
386     O << "+";
387     printOperand(MI, NOps-2);
388     OutStreamer.AddBlankLine();
389     return;
390   }
391   case X86::MOVPC32r: {
392     MCInst TmpInst;
393     // This is a pseudo op for a two instruction sequence with a label, which
394     // looks like:
395     //     call "L1$pb"
396     // "L1$pb":
397     //     popl %esi
398     
399     // Emit the call.
400     MCSymbol *PICBase = MCInstLowering.GetPICBaseSymbol();
401     TmpInst.setOpcode(X86::CALLpcrel32);
402     // FIXME: We would like an efficient form for this, so we don't have to do a
403     // lot of extra uniquing.
404     TmpInst.addOperand(MCOperand::CreateExpr(MCSymbolRefExpr::Create(PICBase,
405                                                                  OutContext)));
406     OutStreamer.EmitInstruction(TmpInst);
407     
408     // Emit the label.
409     OutStreamer.EmitLabel(PICBase);
410     
411     // popl $reg
412     TmpInst.setOpcode(X86::POP32r);
413     TmpInst.getOperand(0) = MCOperand::CreateReg(MI->getOperand(0).getReg());
414     OutStreamer.EmitInstruction(TmpInst);
415     return;
416   }
417       
418   case X86::ADD32ri: {
419     // Lower the MO_GOT_ABSOLUTE_ADDRESS form of ADD32ri.
420     if (MI->getOperand(2).getTargetFlags() != X86II::MO_GOT_ABSOLUTE_ADDRESS)
421       break;
422     
423     // Okay, we have something like:
424     //  EAX = ADD32ri EAX, MO_GOT_ABSOLUTE_ADDRESS(@MYGLOBAL)
425     
426     // For this, we want to print something like:
427     //   MYGLOBAL + (. - PICBASE)
428     // However, we can't generate a ".", so just emit a new label here and refer
429     // to it.
430     MCSymbol *DotSym = OutContext.GetOrCreateTemporarySymbol();
431     OutStreamer.EmitLabel(DotSym);
432     
433     // Now that we have emitted the label, lower the complex operand expression.
434     MCSymbol *OpSym = MCInstLowering.GetSymbolFromOperand(MI->getOperand(2));
435     
436     const MCExpr *DotExpr = MCSymbolRefExpr::Create(DotSym, OutContext);
437     const MCExpr *PICBase =
438       MCSymbolRefExpr::Create(MCInstLowering.GetPICBaseSymbol(), OutContext);
439     DotExpr = MCBinaryExpr::CreateSub(DotExpr, PICBase, OutContext);
440     
441     DotExpr = MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(OpSym,OutContext), 
442                                       DotExpr, OutContext);
443     
444     MCInst TmpInst;
445     TmpInst.setOpcode(X86::ADD32ri);
446     TmpInst.addOperand(MCOperand::CreateReg(MI->getOperand(0).getReg()));
447     TmpInst.addOperand(MCOperand::CreateReg(MI->getOperand(1).getReg()));
448     TmpInst.addOperand(MCOperand::CreateExpr(DotExpr));
449     OutStreamer.EmitInstruction(TmpInst);
450     return;
451   }
452   }
453   
454   MCInst TmpInst;
455   MCInstLowering.Lower(MI, TmpInst);
456   
457   OutStreamer.EmitInstruction(TmpInst);
458 }
459