Add a quick and dirty "loop aligner pass". x86 uses it to align its loops to 16-byte...
[oota-llvm.git] / lib / Target / IA64 / IA64AsmPrinter.cpp
1 //===-- IA64AsmPrinter.cpp - Print out IA64 LLVM as assembly --------------===//
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 assembly accepted by the GNU binutils 'gas'
12 // assembler. The Intel 'ias' and HP-UX 'as' assemblers *may* choke on this
13 // output, but if so that's a bug I'd like to hear about: please file a bug
14 // report in bugzilla. FYI, the not too bad 'ias' assembler is bundled with
15 // the Intel C/C++ compiler for Itanium Linux.
16 //
17 //===----------------------------------------------------------------------===//
18
19 #define DEBUG_TYPE "asm-printer"
20 #include "IA64.h"
21 #include "IA64TargetMachine.h"
22 #include "llvm/Module.h"
23 #include "llvm/Type.h"
24 #include "llvm/CodeGen/AsmPrinter.h"
25 #include "llvm/CodeGen/MachineFunctionPass.h"
26 #include "llvm/Target/TargetAsmInfo.h"
27 #include "llvm/Target/TargetMachine.h"
28 #include "llvm/Support/Mangler.h"
29 #include "llvm/ADT/Statistic.h"
30 using namespace llvm;
31
32 STATISTIC(EmittedInsts, "Number of machine instrs printed");
33
34 namespace {
35   struct IA64AsmPrinter : public AsmPrinter {
36     std::set<std::string> ExternalFunctionNames, ExternalObjectNames;
37
38     IA64AsmPrinter(std::ostream &O, TargetMachine &TM, const TargetAsmInfo *T)
39       : AsmPrinter(O, TM, T) {
40     }
41
42     virtual const char *getPassName() const {
43       return "IA64 Assembly Printer";
44     }
45
46     /// printInstruction - This method is automatically generated by tablegen
47     /// from the instruction set description.  This method returns true if the
48     /// machine instruction was sufficiently described to print it, otherwise it
49     /// returns false.
50     bool printInstruction(const MachineInstr *MI);
51
52     // This method is used by the tablegen'erated instruction printer.
53     void printOperand(const MachineInstr *MI, unsigned OpNo){
54       const MachineOperand &MO = MI->getOperand(OpNo);
55       if (MO.getType() == MachineOperand::MO_Register) {
56         assert(TargetRegisterInfo::isPhysicalRegister(MO.getReg()) &&
57                "Not physref??");
58         //XXX Bug Workaround: See note in Printer::doInitialization about %.
59         O << TM.getRegisterInfo()->get(MO.getReg()).AsmName;
60       } else {
61         printOp(MO);
62       }
63     }
64
65     void printS8ImmOperand(const MachineInstr *MI, unsigned OpNo) {
66       int val=(unsigned int)MI->getOperand(OpNo).getImm();
67       if(val>=128) val=val-256; // if negative, flip sign
68       O << val;
69     }
70     void printS14ImmOperand(const MachineInstr *MI, unsigned OpNo) {
71       int val=(unsigned int)MI->getOperand(OpNo).getImm();
72       if(val>=8192) val=val-16384; // if negative, flip sign
73       O << val;
74     }
75     void printS22ImmOperand(const MachineInstr *MI, unsigned OpNo) {
76       int val=(unsigned int)MI->getOperand(OpNo).getImm();
77       if(val>=2097152) val=val-4194304; // if negative, flip sign
78       O << val;
79     }
80     void printU64ImmOperand(const MachineInstr *MI, unsigned OpNo) {
81       O << (uint64_t)MI->getOperand(OpNo).getImm();
82     }
83     void printS64ImmOperand(const MachineInstr *MI, unsigned OpNo) {
84 // XXX : nasty hack to avoid GPREL22 "relocation truncated to fit" linker
85 // errors - instead of add rX = @gprel(CPI<whatever>), r1;; we now
86 // emit movl rX = @gprel(CPI<whatever);;
87 //      add  rX = rX, r1; 
88 // this gives us 64 bits instead of 22 (for the add long imm) to play
89 // with, which shuts up the linker. The problem is that the constant
90 // pool entries aren't immediates at this stage, so we check here. 
91 // If it's an immediate, print it the old fashioned way. If it's
92 // not, we print it as a constant pool index. 
93       if(MI->getOperand(OpNo).isImmediate()) {
94         O << (int64_t)MI->getOperand(OpNo).getImm();
95       } else { // this is a constant pool reference: FIXME: assert this
96         printOp(MI->getOperand(OpNo));
97       }
98     }
99
100     void printGlobalOperand(const MachineInstr *MI, unsigned OpNo) {
101       printOp(MI->getOperand(OpNo), false); // this is NOT a br.call instruction
102     }
103
104     void printCallOperand(const MachineInstr *MI, unsigned OpNo) {
105       printOp(MI->getOperand(OpNo), true); // this is a br.call instruction
106     }
107
108     std::string getSectionForFunction(const Function &F) const;
109
110     void printMachineInstruction(const MachineInstr *MI);
111     void printOp(const MachineOperand &MO, bool isBRCALLinsn= false);
112     bool runOnMachineFunction(MachineFunction &F);
113     bool doInitialization(Module &M);
114     bool doFinalization(Module &M);
115   };
116 } // end of anonymous namespace
117
118
119 // Include the auto-generated portion of the assembly writer.
120 #include "IA64GenAsmWriter.inc"
121
122
123 std::string IA64AsmPrinter::getSectionForFunction(const Function &F) const {
124   // This means "Allocated instruXions in mem, initialized".
125   return "\n\t.section .text, \"ax\", \"progbits\"\n";
126 }
127
128 /// runOnMachineFunction - This uses the printMachineInstruction()
129 /// method to print assembly for each instruction.
130 ///
131 bool IA64AsmPrinter::runOnMachineFunction(MachineFunction &MF) {
132   SetupMachineFunction(MF);
133   O << "\n\n";
134
135   // Print out constants referenced by the function
136   EmitConstantPool(MF.getConstantPool());
137
138   const Function *F = MF.getFunction();
139   SwitchToTextSection(getSectionForFunction(*F).c_str(), F);
140
141   // Print out labels for the function.
142   EmitAlignment(5);
143   O << "\t.global\t" << CurrentFnName << "\n";
144   O << "\t.type\t" << CurrentFnName << ", @function\n";
145   O << CurrentFnName << ":\n";
146
147   // Print out code for the function.
148   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
149        I != E; ++I) {
150     // Print a label for the basic block if there are any predecessors.
151     if (!I->pred_empty()) {
152       printBasicBlockLabel(I, true, true);
153       O << '\n';
154     }
155     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
156          II != E; ++II) {
157       // Print the assembly for the instruction.
158       printMachineInstruction(II);
159     }
160   }
161
162   // We didn't modify anything.
163   return false;
164 }
165
166 void IA64AsmPrinter::printOp(const MachineOperand &MO,
167                              bool isBRCALLinsn /* = false */) {
168   const TargetRegisterInfo &RI = *TM.getRegisterInfo();
169   switch (MO.getType()) {
170   case MachineOperand::MO_Register:
171     O << RI.get(MO.getReg()).AsmName;
172     return;
173
174   case MachineOperand::MO_Immediate:
175     O << MO.getImm();
176     return;
177   case MachineOperand::MO_MachineBasicBlock:
178     printBasicBlockLabel(MO.getMBB());
179     return;
180   case MachineOperand::MO_ConstantPoolIndex: {
181     O << "@gprel(" << TAI->getPrivateGlobalPrefix()
182       << "CPI" << getFunctionNumber() << "_" << MO.getIndex() << ")";
183     return;
184   }
185
186   case MachineOperand::MO_GlobalAddress: {
187
188     // functions need @ltoff(@fptr(fn_name)) form
189     GlobalValue *GV = MO.getGlobal();
190     Function *F = dyn_cast<Function>(GV);
191
192     bool Needfptr=false; // if we're computing an address @ltoff(X), do
193                          // we need to decorate it so it becomes
194                          // @ltoff(@fptr(X)) ?
195     if (F && !isBRCALLinsn /*&& F->isDeclaration()*/)
196       Needfptr=true;
197
198     // if this is the target of a call instruction, we should define
199     // the function somewhere (GNU gas has no problem without this, but
200     // Intel ias rightly complains of an 'undefined symbol')
201
202     if (F /*&& isBRCALLinsn*/ && F->isDeclaration())
203       ExternalFunctionNames.insert(Mang->getValueName(MO.getGlobal()));
204     else
205       if (GV->isDeclaration()) // e.g. stuff like 'stdin'
206         ExternalObjectNames.insert(Mang->getValueName(MO.getGlobal()));
207
208     if (!isBRCALLinsn)
209       O << "@ltoff(";
210     if (Needfptr)
211       O << "@fptr(";
212     O << Mang->getValueName(MO.getGlobal());
213     
214     if (Needfptr && !isBRCALLinsn)
215       O << "#))"; // close both fptr( and ltoff(
216     else {
217       if (Needfptr)
218         O << "#)"; // close only fptr(
219       if (!isBRCALLinsn)
220         O << "#)"; // close only ltoff(
221     }
222     
223     int Offset = MO.getOffset();
224     if (Offset > 0)
225       O << " + " << Offset;
226     else if (Offset < 0)
227       O << " - " << -Offset;
228     return;
229   }
230   case MachineOperand::MO_ExternalSymbol:
231     O << MO.getSymbolName();
232     ExternalFunctionNames.insert(MO.getSymbolName());
233     return;
234   default:
235     O << "<AsmPrinter: unknown operand type: " << MO.getType() << " >"; return;
236   }
237 }
238
239 /// printMachineInstruction -- Print out a single IA64 LLVM instruction
240 /// MI to the current output stream.
241 ///
242 void IA64AsmPrinter::printMachineInstruction(const MachineInstr *MI) {
243   ++EmittedInsts;
244
245   // Call the autogenerated instruction printer routines.
246   printInstruction(MI);
247 }
248
249 bool IA64AsmPrinter::doInitialization(Module &M) {
250   bool Result = AsmPrinter::doInitialization(M);
251
252   O << "\n.ident \"LLVM-ia64\"\n\n"
253     << "\t.psr    lsb\n"  // should be "msb" on HP-UX, for starters
254     << "\t.radix  C\n"
255     << "\t.psr    abi64\n"; // we only support 64 bits for now
256   return Result;
257 }
258
259 bool IA64AsmPrinter::doFinalization(Module &M) {
260   const TargetData *TD = TM.getTargetData();
261   
262   // Print out module-level global variables here.
263   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
264        I != E; ++I)
265     if (I->hasInitializer()) {   // External global require no code
266       // Check to see if this is a special global used by LLVM, if so, emit it.
267       if (EmitSpecialLLVMGlobal(I))
268         continue;
269       
270       O << "\n\n";
271       std::string name = Mang->getValueName(I);
272       Constant *C = I->getInitializer();
273       unsigned Size = TD->getABITypeSize(C->getType());
274       unsigned Align = TD->getPreferredAlignmentLog(I);
275
276       if (C->isNullValue() &&
277           (I->hasLinkOnceLinkage() || I->hasInternalLinkage() ||
278            I->hasWeakLinkage() /* FIXME: Verify correct */)) {
279         SwitchToDataSection(".data", I);
280         if (I->hasInternalLinkage()) {
281           O << "\t.lcomm " << name << "#," << TD->getABITypeSize(C->getType())
282           << "," << (1 << Align);
283           O << "\n";
284         } else {
285           O << "\t.common " << name << "#," << TD->getABITypeSize(C->getType())
286           << "," << (1 << Align);
287           O << "\n";
288         }
289       } else {
290         switch (I->getLinkage()) {
291           case GlobalValue::LinkOnceLinkage:
292           case GlobalValue::WeakLinkage:   // FIXME: Verify correct for weak.
293                                            // Nonnull linkonce -> weak
294             O << "\t.weak " << name << "\n";
295             O << "\t.section\t.llvm.linkonce.d." << name
296               << ", \"aw\", \"progbits\"\n";
297             SwitchToDataSection("", I);
298             break;
299           case GlobalValue::AppendingLinkage:
300             // FIXME: appending linkage variables should go into a section of
301             // their name or something.  For now, just emit them as external.
302           case GlobalValue::ExternalLinkage:
303             // If external or appending, declare as a global symbol
304             O << "\t.global " << name << "\n";
305             // FALL THROUGH
306           case GlobalValue::InternalLinkage:
307             SwitchToDataSection(C->isNullValue() ? ".bss" : ".data", I);
308             break;
309           case GlobalValue::GhostLinkage:
310             cerr << "GhostLinkage cannot appear in IA64AsmPrinter!\n";
311             abort();
312           case GlobalValue::DLLImportLinkage:
313             cerr << "DLLImport linkage is not supported by this target!\n";
314             abort();
315           case GlobalValue::DLLExportLinkage:
316             cerr << "DLLExport linkage is not supported by this target!\n";
317             abort();
318           default:
319             assert(0 && "Unknown linkage type!");            
320         }
321         
322         EmitAlignment(Align);
323         O << "\t.type " << name << ",@object\n";
324         O << "\t.size " << name << "," << Size << "\n";
325         O << name << ":\t\t\t\t// " << *C << "\n";
326         EmitGlobalConstant(C);
327       }
328     }
329       
330       // we print out ".global X \n .type X, @function" for each external function
331       O << "\n\n// br.call targets referenced (and not defined) above: \n";
332   for (std::set<std::string>::iterator i = ExternalFunctionNames.begin(),
333        e = ExternalFunctionNames.end(); i!=e; ++i) {
334     O << "\t.global " << *i << "\n\t.type " << *i << ", @function\n";
335   }
336   O << "\n\n";
337   
338   // we print out ".global X \n .type X, @object" for each external object
339   O << "\n\n// (external) symbols referenced (and not defined) above: \n";
340   for (std::set<std::string>::iterator i = ExternalObjectNames.begin(),
341        e = ExternalObjectNames.end(); i!=e; ++i) {
342     O << "\t.global " << *i << "\n\t.type " << *i << ", @object\n";
343   }
344   O << "\n\n";
345   
346   return AsmPrinter::doFinalization(M);
347 }
348
349 /// createIA64CodePrinterPass - Returns a pass that prints the IA64
350 /// assembly code for a MachineFunction to the given output stream, using
351 /// the given target machine description.
352 ///
353 FunctionPass *llvm::createIA64CodePrinterPass(std::ostream &o,
354                                               IA64TargetMachine &tm) {
355   return new IA64AsmPrinter(o, tm, tm.getTargetAsmInfo());
356 }
357
358