Add source debug information to the Sparc code generator.
[oota-llvm.git] / lib / Target / Sparc / AsmPrinter / SparcAsmPrinter.cpp
1 //===-- SparcAsmPrinter.cpp - Sparc LLVM assembly writer ------------------===//
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 a printer that converts from our internal representation
11 // of machine-dependent LLVM code to GAS-format SPARC assembly language.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #define DEBUG_TYPE "asm-printer"
16 #include "Sparc.h"
17 #include "SparcInstrInfo.h"
18 #include "SparcTargetMachine.h"
19 #include "llvm/Constants.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/Module.h"
22 #include "llvm/CodeGen/AsmPrinter.h"
23 #include "llvm/CodeGen/DwarfWriter.h"
24 #include "llvm/CodeGen/MachineFunctionPass.h"
25 #include "llvm/CodeGen/MachineConstantPool.h"
26 #include "llvm/CodeGen/MachineInstr.h"
27 #include "llvm/MC/MCStreamer.h"
28 #include "llvm/MC/MCAsmInfo.h"
29 #include "llvm/Target/TargetLoweringObjectFile.h"
30 #include "llvm/Target/TargetRegistry.h"
31 #include "llvm/ADT/Statistic.h"
32 #include "llvm/ADT/StringExtras.h"
33 #include "llvm/Support/CommandLine.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/FormattedStream.h"
36 #include "llvm/Support/Mangler.h"
37 #include "llvm/Support/MathExtras.h"
38 #include <cctype>
39 #include <cstring>
40 #include <map>
41 using namespace llvm;
42
43 STATISTIC(EmittedInsts, "Number of machine instrs printed");
44
45 namespace {
46   class VISIBILITY_HIDDEN SparcAsmPrinter : public AsmPrinter {
47     /// We name each basic block in a Function with a unique number, so
48     /// that we can consistently refer to them later. This is cleared
49     /// at the beginning of each call to runOnMachineFunction().
50     ///
51     typedef std::map<const Value *, unsigned> ValueMapTy;
52     ValueMapTy NumberForBB;
53     unsigned BBNumber;
54   public:
55     explicit SparcAsmPrinter(formatted_raw_ostream &O, TargetMachine &TM,
56                              const MCAsmInfo *T, bool V)
57       : AsmPrinter(O, TM, T, V), BBNumber(0) {}
58
59     virtual const char *getPassName() const {
60       return "Sparc Assembly Printer";
61     }
62
63     void PrintGlobalVariable(const GlobalVariable *GVar);
64     void printOperand(const MachineInstr *MI, int opNum);
65     void printMemOperand(const MachineInstr *MI, int opNum,
66                          const char *Modifier = 0);
67     void printCCOperand(const MachineInstr *MI, int opNum);
68
69     void printInstruction(const MachineInstr *MI);  // autogenerated.
70     bool runOnMachineFunction(MachineFunction &F);
71     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
72                        unsigned AsmVariant, const char *ExtraCode);
73     bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
74                              unsigned AsmVariant, const char *ExtraCode);
75   };
76 } // end of anonymous namespace
77
78 #include "SparcGenAsmWriter.inc"
79
80
81 /// runOnMachineFunction - This uses the printInstruction()
82 /// method to print assembly for each instruction.
83 ///
84 bool SparcAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
85   this->MF = &MF;
86
87   SetupMachineFunction(MF);
88
89   // Print out constants referenced by the function
90   EmitConstantPool(MF.getConstantPool());
91
92   // BBNumber is used here so that a given Printer will never give two
93   // BBs the same name. (If you have a better way, please let me know!)
94
95   O << "\n\n";
96
97   // Print out the label for the function.
98   const Function *F = MF.getFunction();
99   OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang, TM));
100   EmitAlignment(MF.getAlignment(), F);
101   O << "\t.globl\t" << CurrentFnName << '\n';
102
103   printVisibility(CurrentFnName, F->getVisibility());
104
105   O << "\t.type\t" << CurrentFnName << ", #function\n";
106   O << CurrentFnName << ":\n";
107   // Emit pre-function debug information.
108   DW->BeginFunction(&MF);
109
110   // Number each basic block so that we can consistently refer to them
111   // in PC-relative references.
112   // FIXME: Why not use the MBB numbers?
113   NumberForBB.clear();
114   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
115        I != E; ++I) {
116     NumberForBB[I->getBasicBlock()] = BBNumber++;
117   }
118
119   // Print out code for the function.
120   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
121        I != E; ++I) {
122     // Print a label for the basic block.
123     if (I != MF.begin()) {
124       printBasicBlockLabel(I, true, true);
125       O << '\n';
126     }
127     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
128          II != E; ++II) {
129       // Print the assembly for the instruction.
130       printInstruction(II);
131       ++EmittedInsts;
132     }
133   }
134
135   // Emit post-function debug information.
136   DW->EndFunction(&MF);
137
138   // We didn't modify anything.
139   return false;
140 }
141
142 void SparcAsmPrinter::printOperand(const MachineInstr *MI, int opNum) {
143   const MachineOperand &MO = MI->getOperand (opNum);
144   const TargetRegisterInfo &RI = *TM.getRegisterInfo();
145   bool CloseParen = false;
146   if (MI->getOpcode() == SP::SETHIi && !MO.isReg() && !MO.isImm()) {
147     O << "%hi(";
148     CloseParen = true;
149   } else if ((MI->getOpcode() == SP::ORri || MI->getOpcode() == SP::ADDri) &&
150              !MO.isReg() && !MO.isImm()) {
151     O << "%lo(";
152     CloseParen = true;
153   }
154   switch (MO.getType()) {
155   case MachineOperand::MO_Register:
156     if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()))
157       O << "%" << LowercaseString (RI.get(MO.getReg()).AsmName);
158     else
159       O << "%reg" << MO.getReg();
160     break;
161
162   case MachineOperand::MO_Immediate:
163     O << (int)MO.getImm();
164     break;
165   case MachineOperand::MO_MachineBasicBlock:
166     printBasicBlockLabel(MO.getMBB());
167     return;
168   case MachineOperand::MO_GlobalAddress:
169     O << Mang->getMangledName(MO.getGlobal());
170     break;
171   case MachineOperand::MO_ExternalSymbol:
172     O << MO.getSymbolName();
173     break;
174   case MachineOperand::MO_ConstantPoolIndex:
175     O << MAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << "_"
176       << MO.getIndex();
177     break;
178   default:
179     llvm_unreachable("<unknown operand type>");
180   }
181   if (CloseParen) O << ")";
182 }
183
184 void SparcAsmPrinter::printMemOperand(const MachineInstr *MI, int opNum,
185                                       const char *Modifier) {
186   printOperand(MI, opNum);
187
188   // If this is an ADD operand, emit it like normal operands.
189   if (Modifier && !strcmp(Modifier, "arith")) {
190     O << ", ";
191     printOperand(MI, opNum+1);
192     return;
193   }
194
195   if (MI->getOperand(opNum+1).isReg() &&
196       MI->getOperand(opNum+1).getReg() == SP::G0)
197     return;   // don't print "+%g0"
198   if (MI->getOperand(opNum+1).isImm() &&
199       MI->getOperand(opNum+1).getImm() == 0)
200     return;   // don't print "+0"
201
202   O << "+";
203   if (MI->getOperand(opNum+1).isGlobal() ||
204       MI->getOperand(opNum+1).isCPI()) {
205     O << "%lo(";
206     printOperand(MI, opNum+1);
207     O << ")";
208   } else {
209     printOperand(MI, opNum+1);
210   }
211 }
212
213 void SparcAsmPrinter::printCCOperand(const MachineInstr *MI, int opNum) {
214   int CC = (int)MI->getOperand(opNum).getImm();
215   O << SPARCCondCodeToString((SPCC::CondCodes)CC);
216 }
217
218 void SparcAsmPrinter::PrintGlobalVariable(const GlobalVariable* GVar) {
219   const TargetData *TD = TM.getTargetData();
220
221   if (!GVar->hasInitializer())
222     return;  // External global require no code
223
224   // Check to see if this is a special global used by LLVM, if so, emit it.
225   if (EmitSpecialLLVMGlobal(GVar))
226     return;
227
228   O << "\n\n";
229   std::string name = Mang->getMangledName(GVar);
230   Constant *C = GVar->getInitializer();
231   unsigned Size = TD->getTypeAllocSize(C->getType());
232   unsigned Align = TD->getPreferredAlignment(GVar);
233
234   printVisibility(name, GVar->getVisibility());
235
236   OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(GVar, Mang,
237                                                                   TM));
238
239   if (C->isNullValue() && !GVar->hasSection()) {
240     if (!GVar->isThreadLocal() &&
241         (GVar->hasLocalLinkage() || GVar->isWeakForLinker())) {
242       if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
243
244       if (GVar->hasLocalLinkage())
245         O << "\t.local " << name << '\n';
246
247       O << MAI->getCOMMDirective() << name << ',' << Size;
248       if (MAI->getCOMMDirectiveTakesAlignment())
249         O << ',' << (1 << Align);
250
251       O << '\n';
252       return;
253     }
254   }
255
256   switch (GVar->getLinkage()) {
257    case GlobalValue::CommonLinkage:
258    case GlobalValue::LinkOnceAnyLinkage:
259    case GlobalValue::LinkOnceODRLinkage:
260    case GlobalValue::WeakAnyLinkage: // FIXME: Verify correct for weak.
261    case GlobalValue::WeakODRLinkage: // FIXME: Verify correct for weak.
262     // Nonnull linkonce -> weak
263     O << "\t.weak " << name << '\n';
264     break;
265    case GlobalValue::AppendingLinkage:
266     // FIXME: appending linkage variables should go into a section of
267     // their name or something.  For now, just emit them as external.
268    case GlobalValue::ExternalLinkage:
269     // If external or appending, declare as a global symbol
270     O << MAI->getGlobalDirective() << name << '\n';
271     // FALL THROUGH
272    case GlobalValue::PrivateLinkage:
273    case GlobalValue::LinkerPrivateLinkage:
274    case GlobalValue::InternalLinkage:
275     break;
276    case GlobalValue::GhostLinkage:
277     llvm_unreachable("Should not have any unmaterialized functions!");
278    case GlobalValue::DLLImportLinkage:
279     llvm_unreachable("DLLImport linkage is not supported by this target!");
280    case GlobalValue::DLLExportLinkage:
281     llvm_unreachable("DLLExport linkage is not supported by this target!");
282    default:
283     llvm_unreachable("Unknown linkage type!");
284   }
285
286   EmitAlignment(Align, GVar);
287
288   if (MAI->hasDotTypeDotSizeDirective()) {
289     O << "\t.type " << name << ",#object\n";
290     O << "\t.size " << name << ',' << Size << '\n';
291   }
292
293   O << name << ":\n";
294   EmitGlobalConstant(C);
295 }
296
297 /// PrintAsmOperand - Print out an operand for an inline asm expression.
298 ///
299 bool SparcAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
300                                       unsigned AsmVariant,
301                                       const char *ExtraCode) {
302   if (ExtraCode && ExtraCode[0]) {
303     if (ExtraCode[1] != 0) return true; // Unknown modifier.
304
305     switch (ExtraCode[0]) {
306     default: return true;  // Unknown modifier.
307     case 'r':
308      break;
309     }
310   }
311
312   printOperand(MI, OpNo);
313
314   return false;
315 }
316
317 bool SparcAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
318                                             unsigned OpNo,
319                                             unsigned AsmVariant,
320                                             const char *ExtraCode) {
321   if (ExtraCode && ExtraCode[0])
322     return true;  // Unknown modifier
323
324   O << '[';
325   printMemOperand(MI, OpNo);
326   O << ']';
327
328   return false;
329 }
330
331 // Force static initialization.
332 extern "C" void LLVMInitializeSparcAsmPrinter() { 
333   RegisterAsmPrinter<SparcAsmPrinter> X(TheSparcTarget);
334 }