Make external globals public; other minor cleanup.
[oota-llvm.git] / lib / Target / X86 / X86IntelAsmPrinter.cpp
1 //===-- X86IntelAsmPrinter.cpp - Convert X86 LLVM code to Intel assembly --===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains a printer that converts from our internal representation
11 // of machine-dependent LLVM code to Intel format assembly language.
12 // This printer is the output mechanism used by `llc'.
13 //
14 //===----------------------------------------------------------------------===//
15
16 #include "X86IntelAsmPrinter.h"
17 #include "X86.h"
18 #include "llvm/Constants.h"
19 #include "llvm/Module.h"
20 #include "llvm/Assembly/Writer.h"
21 #include "llvm/Support/Mangler.h"
22 #include "llvm/Target/TargetOptions.h"
23 using namespace llvm;
24
25 X86IntelAsmPrinter::X86IntelAsmPrinter(std::ostream &O, X86TargetMachine &TM)
26     : X86SharedAsmPrinter(O, TM) {
27 }
28
29 /// runOnMachineFunction - This uses the printMachineInstruction()
30 /// method to print assembly for each instruction.
31 ///
32 bool X86IntelAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
33   if (forDarwin) {
34     // Let PassManager know we need debug information and relay
35     // the MachineDebugInfo address on to DwarfWriter.
36     DW.SetDebugInfo(&getAnalysis<MachineDebugInfo>());
37   }
38
39   SetupMachineFunction(MF);
40   O << "\n\n";
41
42   // Print out constants referenced by the function
43   EmitConstantPool(MF.getConstantPool());
44
45   // Print out labels for the function.
46   SwitchSection(".code", MF.getFunction());
47   EmitAlignment(4);
48   if (MF.getFunction()->getLinkage() == GlobalValue::ExternalLinkage)
49     O << "\tpublic " << CurrentFnName << "\n";
50   O << CurrentFnName << "\tproc near\n";
51   
52   if (forDarwin) {
53     // Emit pre-function debug information.
54     DW.BeginFunction(&MF);
55   }
56
57   // Print out code for the function.
58   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
59        I != E; ++I) {
60     // Print a label for the basic block if there are any predecessors.
61     if (I->pred_begin() != I->pred_end()) {
62       printBasicBlockLabel(I, true);
63       O << '\n';
64     }
65     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
66          II != E; ++II) {
67       // Print the assembly for the instruction.
68       O << "\t";
69       printMachineInstruction(II);
70     }
71   }
72
73   if (forDarwin) {
74     // Emit post-function debug information.
75     DW.EndFunction();
76   }
77
78   O << CurrentFnName << "\tendp\n";
79
80   // We didn't modify anything.
81   return false;
82 }
83
84 void X86IntelAsmPrinter::printSSECC(const MachineInstr *MI, unsigned Op) {
85   unsigned char value = MI->getOperand(Op).getImmedValue();
86   assert(value <= 7 && "Invalid ssecc argument!");
87   switch (value) {
88   case 0: O << "eq"; break;
89   case 1: O << "lt"; break;
90   case 2: O << "le"; break;
91   case 3: O << "unord"; break;
92   case 4: O << "neq"; break;
93   case 5: O << "nlt"; break;
94   case 6: O << "nle"; break;
95   case 7: O << "ord"; break;
96   }
97 }
98
99 void X86IntelAsmPrinter::printOp(const MachineOperand &MO, 
100                                  const char *Modifier) {
101   const MRegisterInfo &RI = *TM.getRegisterInfo();
102   switch (MO.getType()) {
103   case MachineOperand::MO_VirtualRegister:
104     if (MRegisterInfo::isPhysicalRegister(MO.getReg()))
105       O << RI.get(MO.getReg()).Name;
106     else
107       O << "reg" << MO.getReg();
108     return;
109
110   case MachineOperand::MO_SignExtendedImmed:
111   case MachineOperand::MO_UnextendedImmed:
112     O << (int)MO.getImmedValue();
113     return;
114   case MachineOperand::MO_MachineBasicBlock:
115     printBasicBlockLabel(MO.getMachineBasicBlock());
116     return;
117   case MachineOperand::MO_ConstantPoolIndex: {
118     bool isMemOp  = Modifier && !strcmp(Modifier, "mem");
119     if (!isMemOp) O << "OFFSET ";
120     O << "[" << PrivateGlobalPrefix << "CPI" << getFunctionNumber() << "_"
121       << MO.getConstantPoolIndex();
122     if (forDarwin && TM.getRelocationModel() == Reloc::PIC)
123       O << "-\"L" << getFunctionNumber() << "$pb\"";
124     int Offset = MO.getOffset();
125     if (Offset > 0)
126       O << " + " << Offset;
127     else if (Offset < 0)
128       O << Offset;
129     O << "]";
130     return;
131   }
132   case MachineOperand::MO_GlobalAddress: {
133     bool isCallOp = Modifier && !strcmp(Modifier, "call");
134     bool isMemOp  = Modifier && !strcmp(Modifier, "mem");
135     if (!isMemOp && !isCallOp) O << "OFFSET ";
136     if (forDarwin && TM.getRelocationModel() != Reloc::Static) {
137       GlobalValue *GV = MO.getGlobal();
138       std::string Name = Mang->getValueName(GV);
139       if (!isMemOp && !isCallOp) O << '$';
140       // Link-once, External, or Weakly-linked global variables need
141       // non-lazily-resolved stubs
142       if (GV->isExternal() || GV->hasWeakLinkage() ||
143           GV->hasLinkOnceLinkage()) {
144         // Dynamically-resolved functions need a stub for the function.
145         if (isCallOp && isa<Function>(GV) && cast<Function>(GV)->isExternal()) {
146           FnStubs.insert(Name);
147           O << "L" << Name << "$stub";
148         } else {
149           GVStubs.insert(Name);
150           O << "L" << Name << "$non_lazy_ptr";
151         }
152       } else {
153         O << Mang->getValueName(GV);
154       }
155       if (!isCallOp && TM.getRelocationModel() == Reloc::PIC)
156         O << "-\"L" << getFunctionNumber() << "$pb\"";
157     } else
158       O << Mang->getValueName(MO.getGlobal());
159     int Offset = MO.getOffset();
160     if (Offset > 0)
161       O << " + " << Offset;
162     else if (Offset < 0)
163       O << Offset;
164     return;
165   }
166   case MachineOperand::MO_ExternalSymbol: {
167     bool isCallOp = Modifier && !strcmp(Modifier, "call");
168     if (isCallOp && forDarwin && TM.getRelocationModel() != Reloc::Static) {
169       std::string Name(GlobalPrefix);
170       Name += MO.getSymbolName();
171       FnStubs.insert(Name);
172       O << "L" << Name << "$stub";
173       return;
174     }
175     if (!isCallOp) O << "OFFSET ";
176     O << GlobalPrefix << MO.getSymbolName();
177     return;
178   }
179   default:
180     O << "<unknown operand type>"; return;
181   }
182 }
183
184 void X86IntelAsmPrinter::printMemReference(const MachineInstr *MI, unsigned Op){
185   assert(isMem(MI, Op) && "Invalid memory reference!");
186
187   const MachineOperand &BaseReg  = MI->getOperand(Op);
188   int ScaleVal                   = MI->getOperand(Op+1).getImmedValue();
189   const MachineOperand &IndexReg = MI->getOperand(Op+2);
190   const MachineOperand &DispSpec = MI->getOperand(Op+3);
191
192   if (BaseReg.isFrameIndex()) {
193     O << "[frame slot #" << BaseReg.getFrameIndex();
194     if (DispSpec.getImmedValue())
195       O << " + " << DispSpec.getImmedValue();
196     O << "]";
197     return;
198   }
199
200   O << "[";
201   bool NeedPlus = false;
202   if (BaseReg.getReg()) {
203     printOp(BaseReg, "mem");
204     NeedPlus = true;
205   }
206
207   if (IndexReg.getReg()) {
208     if (NeedPlus) O << " + ";
209     if (ScaleVal != 1)
210       O << ScaleVal << "*";
211     printOp(IndexReg);
212     NeedPlus = true;
213   }
214
215   if (DispSpec.isGlobalAddress() || DispSpec.isConstantPoolIndex()) {
216     if (NeedPlus)
217       O << " + ";
218     printOp(DispSpec, "mem");
219   } else {
220     int DispVal = DispSpec.getImmedValue();
221     if (DispVal || (!BaseReg.getReg() && !IndexReg.getReg())) {
222       if (NeedPlus)
223         if (DispVal > 0)
224           O << " + ";
225         else {
226           O << " - ";
227           DispVal = -DispVal;
228         }
229       O << DispVal;
230     }
231   }
232   O << "]";
233 }
234
235 void X86IntelAsmPrinter::printPICLabel(const MachineInstr *MI, unsigned Op) {
236   O << "\"L" << getFunctionNumber() << "$pb\"\n";
237   O << "\"L" << getFunctionNumber() << "$pb\":";
238 }
239
240 bool X86IntelAsmPrinter::printAsmMRegister(const MachineOperand &MO,
241                                            const char Mode) {
242   const MRegisterInfo &RI = *TM.getRegisterInfo();
243   unsigned Reg = MO.getReg();
244   const char *Name = RI.get(Reg).Name;
245   switch (Mode) {
246   default: return true;  // Unknown mode.
247   case 'b': // Print QImode register
248     switch (Reg) {
249     default: return true;
250     case X86::AH: case X86::AL: case X86::AX: case X86::EAX:
251       Name = "AL";
252       break;
253     case X86::DH: case X86::DL: case X86::DX: case X86::EDX:
254       Name = "DL";
255       break;
256     case X86::CH: case X86::CL: case X86::CX: case X86::ECX:
257       Name = "CL";
258       break;
259     case X86::BH: case X86::BL: case X86::BX: case X86::EBX:
260       Name = "BL";
261       break;
262     case X86::ESI:
263       Name = "SIL";
264       break;
265     case X86::EDI:
266       Name = "DIL";
267       break;
268     case X86::EBP:
269       Name = "BPL";
270       break;
271     case X86::ESP:
272       Name = "SPL";
273       break;
274     }
275     break;
276   case 'h': // Print QImode high register
277     switch (Reg) {
278     default: return true;
279     case X86::AH: case X86::AL: case X86::AX: case X86::EAX:
280       Name = "AL";
281       break;
282     case X86::DH: case X86::DL: case X86::DX: case X86::EDX:
283       Name = "DL";
284       break;
285     case X86::CH: case X86::CL: case X86::CX: case X86::ECX:
286       Name = "CL";
287       break;
288     case X86::BH: case X86::BL: case X86::BX: case X86::EBX:
289       Name = "BL";
290       break;
291     }
292     break;
293   case 'w': // Print HImode register
294     switch (Reg) {
295     default: return true;
296     case X86::AH: case X86::AL: case X86::AX: case X86::EAX:
297       Name = "AX";
298       break;
299     case X86::DH: case X86::DL: case X86::DX: case X86::EDX:
300       Name = "DX";
301       break;
302     case X86::CH: case X86::CL: case X86::CX: case X86::ECX:
303       Name = "CX";
304       break;
305     case X86::BH: case X86::BL: case X86::BX: case X86::EBX:
306       Name = "BX";
307       break;
308     case X86::ESI:
309       Name = "SI";
310       break;
311     case X86::EDI:
312       Name = "DI";
313       break;
314     case X86::EBP:
315       Name = "BP";
316       break;
317     case X86::ESP:
318       Name = "SP";
319       break;
320     }
321     break;
322   case 'k': // Print SImode register
323     switch (Reg) {
324     default: return true;
325     case X86::AH: case X86::AL: case X86::AX: case X86::EAX:
326       Name = "EAX";
327       break;
328     case X86::DH: case X86::DL: case X86::DX: case X86::EDX:
329       Name = "EDX";
330       break;
331     case X86::CH: case X86::CL: case X86::CX: case X86::ECX:
332       Name = "ECX";
333       break;
334     case X86::BH: case X86::BL: case X86::BX: case X86::EBX:
335       Name = "EBX";
336       break;
337     case X86::ESI:
338       Name = "ESI";
339       break;
340     case X86::EDI:
341       Name = "EDI";
342       break;
343     case X86::EBP:
344       Name = "EBP";
345       break;
346     case X86::ESP:
347       Name = "ESP";
348       break;
349     }
350     break;
351   }
352
353   O << Name;
354   return false;
355 }
356
357 /// PrintAsmOperand - Print out an operand for an inline asm expression.
358 ///
359 bool X86IntelAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
360                                          unsigned AsmVariant, 
361                                          const char *ExtraCode) {
362   // Does this asm operand have a single letter operand modifier?
363   if (ExtraCode && ExtraCode[0]) {
364     if (ExtraCode[1] != 0) return true; // Unknown modifier.
365     
366     switch (ExtraCode[0]) {
367     default: return true;  // Unknown modifier.
368     case 'b': // Print QImode register
369     case 'h': // Print QImode high register
370     case 'w': // Print HImode register
371     case 'k': // Print SImode register
372       return printAsmMRegister(MI->getOperand(OpNo), ExtraCode[0]);
373     }
374   }
375   
376   printOperand(MI, OpNo);
377   return false;
378 }
379
380 bool X86IntelAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
381                                                unsigned OpNo,
382                                                unsigned AsmVariant, 
383                                                const char *ExtraCode) {
384   if (ExtraCode && ExtraCode[0])
385     return true; // Unknown modifier.
386   printMemReference(MI, OpNo);
387   return false;
388 }
389
390 /// printMachineInstruction -- Print out a single X86 LLVM instruction
391 /// MI in Intel syntax to the current output stream.
392 ///
393 void X86IntelAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
394   ++EmittedInsts;
395
396   // Call the autogenerated instruction printer routines.
397   printInstruction(MI);
398 }
399
400 bool X86IntelAsmPrinter::doInitialization(Module &M) {
401   X86SharedAsmPrinter::doInitialization(M);
402   CommentString = ";";
403   GlobalPrefix = "_";
404   PrivateGlobalPrefix = "$";
405   AlignDirective = "\talign\t";
406   MLSections = true;
407   ZeroDirective = "\tdb\t";
408   ZeroDirectiveSuffix = " dup(0)";
409   AsciiDirective = "\tdb\t";
410   AscizDirective = 0;
411   Data8bitsDirective = "\t.db\t";
412   Data16bitsDirective = "\t.dw\t";
413   Data32bitsDirective = "\t.dd\t";
414   Data64bitsDirective = "\t.dq\t";
415   HasDotTypeDotSizeDirective = false;
416   Mang->markCharUnacceptable('.');
417
418   O << "\t.686\n\t.model flat\n\n";
419
420   // Emit declarations for external functions.
421   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
422     if (I->isExternal())
423       O << "\textern " << Mang->getValueName(I) << ":near\n";
424
425   // Emit declarations for external globals.
426   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
427        I != E; ++I) {
428     if (I->isExternal())
429       O << "\textern " << Mang->getValueName(I) << ":byte\n";
430     else if (I->getLinkage() == GlobalValue::ExternalLinkage)
431       O << "\tpublic " << Mang->getValueName(I) << "\n";
432   }
433
434   return false;
435 }
436
437 bool X86IntelAsmPrinter::doFinalization(Module &M) {
438   X86SharedAsmPrinter::doFinalization(M);
439   SwitchSection("", 0);
440   O << "\tend\n";
441   return false;
442 }
443
444 void X86IntelAsmPrinter::EmitString(const ConstantArray *CVA) const {
445   unsigned NumElts = CVA->getNumOperands();
446   if (NumElts) {
447     // ML does not have escape sequences except '' for '.  It also has a maximum
448     // string length of 255.
449     unsigned len = 0;
450     bool inString = false;
451     for (unsigned i = 0; i < NumElts; i++) {
452       int n = cast<ConstantInt>(CVA->getOperand(i))->getRawValue() & 255;
453       if (len == 0)
454         O << "\tdb ";
455
456       if (n >= 32 && n <= 127) {
457         if (!inString) {
458           if (len > 0) {
459             O << ",'";
460             len += 2;
461           } else {
462             O << "'";
463             len++;
464           }
465           inString = true;
466         }
467         if (n == '\'') {
468           O << "'";
469           len++;
470         }
471         O << char(n);
472       } else {
473         if (inString) {
474           O << "'";
475           len++;
476           inString = false;
477         }
478         if (len > 0) {
479           O << ",";
480           len++;
481         }
482         O << n;
483         len += 1 + (n > 9) + (n > 99);
484       }
485
486       if (len > 60) {
487         if (inString) {
488           O << "'";
489           inString = false;
490         }
491         O << "\n";
492         len = 0;
493       }
494     }
495
496     if (len > 0) {
497       if (inString)
498         O << "'";
499       O << "\n";
500     }
501   }
502 }
503
504 // Include the auto-generated portion of the assembly writer.
505 #include "X86GenAsmWriter1.inc"