9677d0ff9e41e43a4b86fab5475618640e016e06
[oota-llvm.git] / lib / Target / PowerPC / PPCAsmPrinter.cpp
1 //===-- PPCAsmPrinter.cpp - Print machine instrs to PowerPC 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 PowerPC assembly language. This printer is
12 // the output mechanism used by `llc'.
13 //
14 // Documentation at http://developer.apple.com/documentation/DeveloperTools/
15 // Reference/Assembler/ASMIntroduction/chapter_1_section_1.html
16 //
17 //===----------------------------------------------------------------------===//
18
19 #define DEBUG_TYPE "asmprinter"
20 #include "PPC.h"
21 #include "PPCPredicates.h"
22 #include "PPCTargetMachine.h"
23 #include "PPCSubtarget.h"
24 #include "llvm/Constants.h"
25 #include "llvm/DerivedTypes.h"
26 #include "llvm/Module.h"
27 #include "llvm/Assembly/Writer.h"
28 #include "llvm/CodeGen/AsmPrinter.h"
29 #include "llvm/CodeGen/DwarfWriter.h"
30 #include "llvm/CodeGen/MachineModuleInfo.h"
31 #include "llvm/CodeGen/MachineFunctionPass.h"
32 #include "llvm/CodeGen/MachineInstr.h"
33 #include "llvm/CodeGen/MachineInstrBuilder.h"
34 #include "llvm/Support/Mangler.h"
35 #include "llvm/Support/MathExtras.h"
36 #include "llvm/Support/CommandLine.h"
37 #include "llvm/Support/Debug.h"
38 #include "llvm/Support/Compiler.h"
39 #include "llvm/Target/TargetAsmInfo.h"
40 #include "llvm/Target/TargetRegisterInfo.h"
41 #include "llvm/Target/TargetInstrInfo.h"
42 #include "llvm/Target/TargetOptions.h"
43 #include "llvm/ADT/Statistic.h"
44 #include "llvm/ADT/StringExtras.h"
45 #include <set>
46 using namespace llvm;
47
48 STATISTIC(EmittedInsts, "Number of machine instrs printed");
49
50 namespace {
51   struct VISIBILITY_HIDDEN PPCAsmPrinter : public AsmPrinter {
52     std::set<std::string> FnStubs, GVStubs;
53     const PPCSubtarget &Subtarget;
54
55     PPCAsmPrinter(std::ostream &O, TargetMachine &TM, const TargetAsmInfo *T)
56       : AsmPrinter(O, TM, T), Subtarget(TM.getSubtarget<PPCSubtarget>()) {
57     }
58
59     virtual const char *getPassName() const {
60       return "PowerPC Assembly Printer";
61     }
62
63     PPCTargetMachine &getTM() {
64       return static_cast<PPCTargetMachine&>(TM);
65     }
66
67     unsigned enumRegToMachineReg(unsigned enumReg) {
68       switch (enumReg) {
69       default: assert(0 && "Unhandled register!"); break;
70       case PPC::CR0:  return  0;
71       case PPC::CR1:  return  1;
72       case PPC::CR2:  return  2;
73       case PPC::CR3:  return  3;
74       case PPC::CR4:  return  4;
75       case PPC::CR5:  return  5;
76       case PPC::CR6:  return  6;
77       case PPC::CR7:  return  7;
78       }
79       abort();
80     }
81
82     /// printInstruction - This method is automatically generated by tablegen
83     /// from the instruction set description.  This method returns true if the
84     /// machine instruction was sufficiently described to print it, otherwise it
85     /// returns false.
86     bool printInstruction(const MachineInstr *MI);
87
88     void printMachineInstruction(const MachineInstr *MI);
89     void printOp(const MachineOperand &MO);
90
91     /// stripRegisterPrefix - This method strips the character prefix from a
92     /// register name so that only the number is left.  Used by for linux asm.
93     const char *stripRegisterPrefix(const char *RegName) {
94       switch (RegName[0]) {
95       case 'r':
96       case 'f':
97       case 'v': return RegName + 1;
98       case 'c': if (RegName[1] == 'r') return RegName + 2;
99       }
100
101       return RegName;
102     }
103
104     /// printRegister - Print register according to target requirements.
105     ///
106     void printRegister(const MachineOperand &MO, bool R0AsZero) {
107       unsigned RegNo = MO.getReg();
108       assert(TargetRegisterInfo::isPhysicalRegister(RegNo) && "Not physreg??");
109
110       // If we should use 0 for R0.
111       if (R0AsZero && RegNo == PPC::R0) {
112         O << "0";
113         return;
114       }
115
116       const char *RegName = TM.getRegisterInfo()->get(RegNo).AsmName;
117       // Linux assembler (Others?) does not take register mnemonics.
118       // FIXME - What about special registers used in mfspr/mtspr?
119       if (!Subtarget.isDarwin()) RegName = stripRegisterPrefix(RegName);
120       O << RegName;
121     }
122
123     void printOperand(const MachineInstr *MI, unsigned OpNo) {
124       const MachineOperand &MO = MI->getOperand(OpNo);
125       if (MO.isRegister()) {
126         printRegister(MO, false);
127       } else if (MO.isImmediate()) {
128         O << MO.getImm();
129       } else {
130         printOp(MO);
131       }
132     }
133
134     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
135                          unsigned AsmVariant, const char *ExtraCode);
136     bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
137                                unsigned AsmVariant, const char *ExtraCode);
138
139
140     void printS5ImmOperand(const MachineInstr *MI, unsigned OpNo) {
141       char value = MI->getOperand(OpNo).getImm();
142       value = (value << (32-5)) >> (32-5);
143       O << (int)value;
144     }
145     void printU5ImmOperand(const MachineInstr *MI, unsigned OpNo) {
146       unsigned char value = MI->getOperand(OpNo).getImm();
147       assert(value <= 31 && "Invalid u5imm argument!");
148       O << (unsigned int)value;
149     }
150     void printU6ImmOperand(const MachineInstr *MI, unsigned OpNo) {
151       unsigned char value = MI->getOperand(OpNo).getImm();
152       assert(value <= 63 && "Invalid u6imm argument!");
153       O << (unsigned int)value;
154     }
155     void printS16ImmOperand(const MachineInstr *MI, unsigned OpNo) {
156       O << (short)MI->getOperand(OpNo).getImm();
157     }
158     void printU16ImmOperand(const MachineInstr *MI, unsigned OpNo) {
159       O << (unsigned short)MI->getOperand(OpNo).getImm();
160     }
161     void printS16X4ImmOperand(const MachineInstr *MI, unsigned OpNo) {
162       if (MI->getOperand(OpNo).isImmediate()) {
163         O << (short)(MI->getOperand(OpNo).getImm()*4);
164       } else {
165         O << "lo16(";
166         printOp(MI->getOperand(OpNo));
167         if (TM.getRelocationModel() == Reloc::PIC_)
168           O << "-\"L" << getFunctionNumber() << "$pb\")";
169         else
170           O << ')';
171       }
172     }
173     void printBranchOperand(const MachineInstr *MI, unsigned OpNo) {
174       // Branches can take an immediate operand.  This is used by the branch
175       // selection pass to print $+8, an eight byte displacement from the PC.
176       if (MI->getOperand(OpNo).isImmediate()) {
177         O << "$+" << MI->getOperand(OpNo).getImm()*4;
178       } else {
179         printOp(MI->getOperand(OpNo));
180       }
181     }
182     void printCallOperand(const MachineInstr *MI, unsigned OpNo) {
183       const MachineOperand &MO = MI->getOperand(OpNo);
184       if (TM.getRelocationModel() != Reloc::Static) {
185         if (MO.getType() == MachineOperand::MO_GlobalAddress) {
186           GlobalValue *GV = MO.getGlobal();
187           if (((GV->isDeclaration() || GV->hasWeakLinkage() ||
188                 GV->hasLinkOnceLinkage() || GV->hasCommonLinkage()))) {
189             // Dynamically-resolved functions need a stub for the function.
190             std::string Name = Mang->getValueName(GV);
191             FnStubs.insert(Name);
192             printSuffixedName(Name, "$stub");
193             if (GV->hasExternalWeakLinkage())
194               ExtWeakSymbols.insert(GV);
195             return;
196           }
197         }
198         if (MO.getType() == MachineOperand::MO_ExternalSymbol) {
199           std::string Name(TAI->getGlobalPrefix()); Name += MO.getSymbolName();
200           FnStubs.insert(Name);
201           printSuffixedName(Name, "$stub");
202           return;
203         }
204       }
205
206       printOp(MI->getOperand(OpNo));
207     }
208     void printAbsAddrOperand(const MachineInstr *MI, unsigned OpNo) {
209      O << (int)MI->getOperand(OpNo).getImm()*4;
210     }
211     void printPICLabel(const MachineInstr *MI, unsigned OpNo) {
212       O << "\"L" << getFunctionNumber() << "$pb\"\n";
213       O << "\"L" << getFunctionNumber() << "$pb\":";
214     }
215     void printSymbolHi(const MachineInstr *MI, unsigned OpNo) {
216       if (MI->getOperand(OpNo).isImmediate()) {
217         printS16ImmOperand(MI, OpNo);
218       } else {
219         if (Subtarget.isDarwin()) O << "ha16(";
220         printOp(MI->getOperand(OpNo));
221         if (TM.getRelocationModel() == Reloc::PIC_)
222           O << "-\"L" << getFunctionNumber() << "$pb\"";
223         if (Subtarget.isDarwin())
224           O << ')';
225         else
226           O << "@ha";
227       }
228     }
229     void printSymbolLo(const MachineInstr *MI, unsigned OpNo) {
230       if (MI->getOperand(OpNo).isImmediate()) {
231         printS16ImmOperand(MI, OpNo);
232       } else {
233         if (Subtarget.isDarwin()) O << "lo16(";
234         printOp(MI->getOperand(OpNo));
235         if (TM.getRelocationModel() == Reloc::PIC_)
236           O << "-\"L" << getFunctionNumber() << "$pb\"";
237         if (Subtarget.isDarwin())
238           O << ')';
239         else
240           O << "@l";
241       }
242     }
243     void printcrbitm(const MachineInstr *MI, unsigned OpNo) {
244       unsigned CCReg = MI->getOperand(OpNo).getReg();
245       unsigned RegNo = enumRegToMachineReg(CCReg);
246       O << (0x80 >> RegNo);
247     }
248     // The new addressing mode printers.
249     void printMemRegImm(const MachineInstr *MI, unsigned OpNo) {
250       printSymbolLo(MI, OpNo);
251       O << '(';
252       if (MI->getOperand(OpNo+1).isRegister() &&
253           MI->getOperand(OpNo+1).getReg() == PPC::R0)
254         O << "0";
255       else
256         printOperand(MI, OpNo+1);
257       O << ')';
258     }
259     void printMemRegImmShifted(const MachineInstr *MI, unsigned OpNo) {
260       if (MI->getOperand(OpNo).isImmediate())
261         printS16X4ImmOperand(MI, OpNo);
262       else
263         printSymbolLo(MI, OpNo);
264       O << '(';
265       if (MI->getOperand(OpNo+1).isRegister() &&
266           MI->getOperand(OpNo+1).getReg() == PPC::R0)
267         O << "0";
268       else
269         printOperand(MI, OpNo+1);
270       O << ')';
271     }
272
273     void printMemRegReg(const MachineInstr *MI, unsigned OpNo) {
274       // When used as the base register, r0 reads constant zero rather than
275       // the value contained in the register.  For this reason, the darwin
276       // assembler requires that we print r0 as 0 (no r) when used as the base.
277       const MachineOperand &MO = MI->getOperand(OpNo);
278       printRegister(MO, true);
279       O << ", ";
280       printOperand(MI, OpNo+1);
281     }
282
283     void printPredicateOperand(const MachineInstr *MI, unsigned OpNo,
284                                const char *Modifier);
285
286     virtual bool runOnMachineFunction(MachineFunction &F) = 0;
287     virtual bool doFinalization(Module &M) = 0;
288
289     virtual void EmitExternalGlobal(const GlobalVariable *GV);
290   };
291
292   /// PPCLinuxAsmPrinter - PowerPC assembly printer, customized for Linux
293   struct VISIBILITY_HIDDEN PPCLinuxAsmPrinter : public PPCAsmPrinter {
294
295     DwarfWriter DW;
296     MachineModuleInfo *MMI;
297
298     PPCLinuxAsmPrinter(std::ostream &O, PPCTargetMachine &TM,
299                     const TargetAsmInfo *T)
300       : PPCAsmPrinter(O, TM, T), DW(O, this, T), MMI(0) {
301     }
302
303     virtual const char *getPassName() const {
304       return "Linux PPC Assembly Printer";
305     }
306
307     bool runOnMachineFunction(MachineFunction &F);
308     bool doInitialization(Module &M);
309     bool doFinalization(Module &M);
310
311     void getAnalysisUsage(AnalysisUsage &AU) const {
312       AU.setPreservesAll();
313       AU.addRequired<MachineModuleInfo>();
314       PPCAsmPrinter::getAnalysisUsage(AU);
315     }
316
317     /// getSectionForFunction - Return the section that we should emit the
318     /// specified function body into.
319     virtual std::string getSectionForFunction(const Function &F) const;
320   };
321
322   /// PPCDarwinAsmPrinter - PowerPC assembly printer, customized for Darwin/Mac
323   /// OS X
324   struct VISIBILITY_HIDDEN PPCDarwinAsmPrinter : public PPCAsmPrinter {
325
326     DwarfWriter DW;
327     MachineModuleInfo *MMI;
328
329     PPCDarwinAsmPrinter(std::ostream &O, PPCTargetMachine &TM,
330                         const TargetAsmInfo *T)
331       : PPCAsmPrinter(O, TM, T), DW(O, this, T), MMI(0) {
332     }
333
334     virtual const char *getPassName() const {
335       return "Darwin PPC Assembly Printer";
336     }
337
338     bool runOnMachineFunction(MachineFunction &F);
339     bool doInitialization(Module &M);
340     bool doFinalization(Module &M);
341
342     void getAnalysisUsage(AnalysisUsage &AU) const {
343       AU.setPreservesAll();
344       AU.addRequired<MachineModuleInfo>();
345       PPCAsmPrinter::getAnalysisUsage(AU);
346     }
347
348     /// getSectionForFunction - Return the section that we should emit the
349     /// specified function body into.
350     virtual std::string getSectionForFunction(const Function &F) const;
351   };
352 } // end of anonymous namespace
353
354 // Include the auto-generated portion of the assembly writer
355 #include "PPCGenAsmWriter.inc"
356
357 void PPCAsmPrinter::printOp(const MachineOperand &MO) {
358   switch (MO.getType()) {
359   case MachineOperand::MO_Immediate:
360     cerr << "printOp() does not handle immediate values\n";
361     abort();
362     return;
363
364   case MachineOperand::MO_MachineBasicBlock:
365     printBasicBlockLabel(MO.getMBB());
366     return;
367   case MachineOperand::MO_JumpTableIndex:
368     O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
369       << '_' << MO.getIndex();
370     // FIXME: PIC relocation model
371     return;
372   case MachineOperand::MO_ConstantPoolIndex:
373     O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber()
374       << '_' << MO.getIndex();
375     return;
376   case MachineOperand::MO_ExternalSymbol:
377     // Computing the address of an external symbol, not calling it.
378     if (TM.getRelocationModel() != Reloc::Static) {
379       std::string Name(TAI->getGlobalPrefix()); Name += MO.getSymbolName();
380       GVStubs.insert(Name);
381       printSuffixedName(Name, "$non_lazy_ptr");
382       return;
383     }
384     O << TAI->getGlobalPrefix() << MO.getSymbolName();
385     return;
386   case MachineOperand::MO_GlobalAddress: {
387     // Computing the address of a global symbol, not calling it.
388     GlobalValue *GV = MO.getGlobal();
389     std::string Name = Mang->getValueName(GV);
390
391     // External or weakly linked global variables need non-lazily-resolved stubs
392     if (TM.getRelocationModel() != Reloc::Static) {
393       if (((GV->isDeclaration() || GV->hasWeakLinkage() ||
394             GV->hasLinkOnceLinkage() || GV->hasCommonLinkage()))) {
395         GVStubs.insert(Name);
396         printSuffixedName(Name, "$non_lazy_ptr");
397         if (GV->hasExternalWeakLinkage())
398           ExtWeakSymbols.insert(GV);
399         return;
400       }
401     }
402     O << Name;
403
404     if (MO.getOffset() > 0)
405       O << "+" << MO.getOffset();
406     else if (MO.getOffset() < 0)
407       O << MO.getOffset();
408
409     if (GV->hasExternalWeakLinkage())
410       ExtWeakSymbols.insert(GV);
411     return;
412   }
413
414   default:
415     O << "<unknown operand type: " << MO.getType() << ">";
416     return;
417   }
418 }
419
420 /// EmitExternalGlobal - In this case we need to use the indirect symbol.
421 ///
422 void PPCAsmPrinter::EmitExternalGlobal(const GlobalVariable *GV) {
423   std::string Name = getGlobalLinkName(GV);
424   if (TM.getRelocationModel() != Reloc::Static) {
425     GVStubs.insert(Name);
426     printSuffixedName(Name, "$non_lazy_ptr");
427     return;
428   }
429   O << Name;
430 }
431
432 /// PrintAsmOperand - Print out an operand for an inline asm expression.
433 ///
434 bool PPCAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
435                                     unsigned AsmVariant,
436                                     const char *ExtraCode) {
437   // Does this asm operand have a single letter operand modifier?
438   if (ExtraCode && ExtraCode[0]) {
439     if (ExtraCode[1] != 0) return true; // Unknown modifier.
440
441     switch (ExtraCode[0]) {
442     default: return true;  // Unknown modifier.
443     case 'c': // Don't print "$" before a global var name or constant.
444       // PPC never has a prefix.
445       printOperand(MI, OpNo);
446       return false;
447     case 'L': // Write second word of DImode reference.
448       // Verify that this operand has two consecutive registers.
449       if (!MI->getOperand(OpNo).isRegister() ||
450           OpNo+1 == MI->getNumOperands() ||
451           !MI->getOperand(OpNo+1).isRegister())
452         return true;
453       ++OpNo;   // Return the high-part.
454       break;
455     case 'I':
456       // Write 'i' if an integer constant, otherwise nothing.  Used to print
457       // addi vs add, etc.
458       if (MI->getOperand(OpNo).isImmediate())
459         O << "i";
460       return false;
461     }
462   }
463
464   printOperand(MI, OpNo);
465   return false;
466 }
467
468 bool PPCAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
469                                           unsigned AsmVariant,
470                                           const char *ExtraCode) {
471   if (ExtraCode && ExtraCode[0])
472     return true; // Unknown modifier.
473   if (MI->getOperand(OpNo).isRegister())
474     printMemRegReg(MI, OpNo);
475   else
476     printMemRegImm(MI, OpNo);
477   return false;
478 }
479
480 void PPCAsmPrinter::printPredicateOperand(const MachineInstr *MI, unsigned OpNo,
481                                           const char *Modifier) {
482   assert(Modifier && "Must specify 'cc' or 'reg' as predicate op modifier!");
483   unsigned Code = MI->getOperand(OpNo).getImm();
484   if (!strcmp(Modifier, "cc")) {
485     switch ((PPC::Predicate)Code) {
486     case PPC::PRED_ALWAYS: return; // Don't print anything for always.
487     case PPC::PRED_LT: O << "lt"; return;
488     case PPC::PRED_LE: O << "le"; return;
489     case PPC::PRED_EQ: O << "eq"; return;
490     case PPC::PRED_GE: O << "ge"; return;
491     case PPC::PRED_GT: O << "gt"; return;
492     case PPC::PRED_NE: O << "ne"; return;
493     case PPC::PRED_UN: O << "un"; return;
494     case PPC::PRED_NU: O << "nu"; return;
495     }
496
497   } else {
498     assert(!strcmp(Modifier, "reg") &&
499            "Need to specify 'cc' or 'reg' as predicate op modifier!");
500     // Don't print the register for 'always'.
501     if (Code == PPC::PRED_ALWAYS) return;
502     printOperand(MI, OpNo+1);
503   }
504 }
505
506
507 /// printMachineInstruction -- Print out a single PowerPC MI in Darwin syntax to
508 /// the current output stream.
509 ///
510 void PPCAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
511   ++EmittedInsts;
512
513   // Check for slwi/srwi mnemonics.
514   if (MI->getOpcode() == PPC::RLWINM) {
515     bool FoundMnemonic = false;
516     unsigned char SH = MI->getOperand(2).getImm();
517     unsigned char MB = MI->getOperand(3).getImm();
518     unsigned char ME = MI->getOperand(4).getImm();
519     if (SH <= 31 && MB == 0 && ME == (31-SH)) {
520       O << "\tslwi "; FoundMnemonic = true;
521     }
522     if (SH <= 31 && MB == (32-SH) && ME == 31) {
523       O << "\tsrwi "; FoundMnemonic = true;
524       SH = 32-SH;
525     }
526     if (FoundMnemonic) {
527       printOperand(MI, 0);
528       O << ", ";
529       printOperand(MI, 1);
530       O << ", " << (unsigned int)SH << "\n";
531       return;
532     }
533   } else if (MI->getOpcode() == PPC::OR || MI->getOpcode() == PPC::OR8) {
534     if (MI->getOperand(1).getReg() == MI->getOperand(2).getReg()) {
535       O << "\tmr ";
536       printOperand(MI, 0);
537       O << ", ";
538       printOperand(MI, 1);
539       O << "\n";
540       return;
541     }
542   } else if (MI->getOpcode() == PPC::RLDICR) {
543     unsigned char SH = MI->getOperand(2).getImm();
544     unsigned char ME = MI->getOperand(3).getImm();
545     // rldicr RA, RS, SH, 63-SH == sldi RA, RS, SH
546     if (63-SH == ME) {
547       O << "\tsldi ";
548       printOperand(MI, 0);
549       O << ", ";
550       printOperand(MI, 1);
551       O << ", " << (unsigned int)SH << "\n";
552       return;
553     }
554   }
555
556   if (printInstruction(MI))
557     return; // Printer was automatically generated
558
559   assert(0 && "Unhandled instruction in asm writer!");
560   abort();
561   return;
562 }
563
564 /// runOnMachineFunction - This uses the printMachineInstruction()
565 /// method to print assembly for each instruction.
566 ///
567 bool PPCLinuxAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
568
569   SetupMachineFunction(MF);
570   O << "\n\n";
571
572   // Print out constants referenced by the function
573   EmitConstantPool(MF.getConstantPool());
574
575   // Print out labels for the function.
576   const Function *F = MF.getFunction();
577   SwitchToTextSection(getSectionForFunction(*F).c_str(), F);
578
579   switch (F->getLinkage()) {
580   default: assert(0 && "Unknown linkage type!");
581   case Function::InternalLinkage:  // Symbols default to internal.
582     break;
583   case Function::ExternalLinkage:
584     O << "\t.global\t" << CurrentFnName << '\n'
585       << "\t.type\t" << CurrentFnName << ", @function\n";
586     break;
587   case Function::WeakLinkage:
588   case Function::LinkOnceLinkage:
589     O << "\t.global\t" << CurrentFnName << '\n';
590     O << "\t.weak\t" << CurrentFnName << '\n';
591     break;
592   }
593
594   if (F->hasHiddenVisibility())
595     if (const char *Directive = TAI->getHiddenDirective())
596       O << Directive << CurrentFnName << "\n";
597
598   EmitAlignment(2, F);
599   O << CurrentFnName << ":\n";
600
601   // Emit pre-function debug information.
602   DW.BeginFunction(&MF);
603
604   // Print out code for the function.
605   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
606        I != E; ++I) {
607     // Print a label for the basic block.
608     if (I != MF.begin()) {
609       printBasicBlockLabel(I, true, true);
610       O << '\n';
611     }
612     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
613          II != E; ++II) {
614       // Print the assembly for the instruction.
615       printMachineInstruction(II);
616     }
617   }
618
619   O << "\t.size\t" << CurrentFnName << ",.-" << CurrentFnName << "\n";
620
621   // Print out jump tables referenced by the function.
622   EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
623
624   // Emit post-function debug information.
625   DW.EndFunction();
626
627   // We didn't modify anything.
628   return false;
629 }
630
631 bool PPCLinuxAsmPrinter::doInitialization(Module &M) {
632   bool Result = AsmPrinter::doInitialization(M);
633
634   // Emit initial debug information.
635   DW.BeginModule(&M);
636
637   // AsmPrinter::doInitialization should have done this analysis.
638   MMI = getAnalysisToUpdate<MachineModuleInfo>();
639   assert(MMI);
640   DW.SetModuleInfo(MMI);
641
642   // GNU as handles section names wrapped in quotes
643   Mang->setUseQuotes(true);
644
645   SwitchToTextSection(TAI->getTextSection());
646
647   return Result;
648 }
649
650 /// PrintUnmangledNameSafely - Print out the printable characters in the name.
651 /// Don't print things like \n or \0.
652 static void PrintUnmangledNameSafely(const Value *V, std::ostream &OS) {
653   for (const char *Name = V->getNameStart(), *E = Name+V->getNameLen();
654        Name != E; ++Name)
655     if (isprint(*Name))
656       OS << *Name;
657 }
658
659 bool PPCLinuxAsmPrinter::doFinalization(Module &M) {
660   const TargetData *TD = TM.getTargetData();
661
662   // Print out module-level global variables here.
663   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
664        I != E; ++I) {
665     if (!I->hasInitializer()) continue;   // External global require no code
666
667     // Check to see if this is a special global used by LLVM, if so, emit it.
668     if (EmitSpecialLLVMGlobal(I))
669       continue;
670
671     std::string name = Mang->getValueName(I);
672
673     if (I->hasHiddenVisibility())
674       if (const char *Directive = TAI->getHiddenDirective())
675         O << Directive << name << "\n";
676
677     Constant *C = I->getInitializer();
678     unsigned Size = TD->getABITypeSize(C->getType());
679     unsigned Align = TD->getPreferredAlignmentLog(I);
680
681     if (C->isNullValue() && /* FIXME: Verify correct */
682         !I->hasSection() && (I->hasCommonLinkage() ||
683          I->hasInternalLinkage() || I->hasWeakLinkage() ||
684          I->hasLinkOnceLinkage() || I->hasExternalLinkage())) {
685       if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
686       if (I->hasExternalLinkage()) {
687         O << "\t.global " << name << '\n';
688         O << "\t.type " << name << ", @object\n";
689         if (TAI->getBSSSection())
690           SwitchToDataSection(TAI->getBSSSection(), I);
691         O << name << ":\n";
692         O << "\t.zero " << Size << "\n";
693       } else if (I->hasInternalLinkage()) {
694         SwitchToDataSection("\t.data", I);
695         O << TAI->getLCOMMDirective() << name << "," << Size;
696       } else {
697         SwitchToDataSection("\t.data", I);
698         O << ".comm " << name << "," << Size;
699       }
700       O << "\t\t" << TAI->getCommentString() << " '";
701       PrintUnmangledNameSafely(I, O);
702       O << "'\n";
703     } else {
704       switch (I->getLinkage()) {
705       case GlobalValue::LinkOnceLinkage:
706       case GlobalValue::WeakLinkage:
707       case GlobalValue::CommonLinkage:
708         O << "\t.global " << name << '\n'
709           << "\t.type " << name << ", @object\n"
710           << "\t.weak " << name << '\n';
711         SwitchToDataSection("\t.data", I);
712         break;
713       case GlobalValue::AppendingLinkage:
714         // FIXME: appending linkage variables should go into a section of
715         // their name or something.  For now, just emit them as external.
716       case GlobalValue::ExternalLinkage:
717         // If external or appending, declare as a global symbol
718         O << "\t.global " << name << "\n"
719           << "\t.type " << name << ", @object\n";
720         // FALL THROUGH
721       case GlobalValue::InternalLinkage:
722         if (I->isConstant()) {
723           const ConstantArray *CVA = dyn_cast<ConstantArray>(C);
724           if (TAI->getCStringSection() && CVA && CVA->isCString()) {
725             SwitchToDataSection(TAI->getCStringSection(), I);
726             break;
727           }
728         }
729
730         // FIXME: special handling for ".ctors" & ".dtors" sections
731         if (I->hasSection() &&
732             (I->getSection() == ".ctors" ||
733              I->getSection() == ".dtors")) {
734           std::string SectionName = ".section " + I->getSection()
735                                                 + ",\"aw\",@progbits";
736           SwitchToDataSection(SectionName.c_str());
737         } else {
738           if (I->isConstant() && TAI->getReadOnlySection())
739             SwitchToDataSection(TAI->getReadOnlySection(), I);
740           else
741             SwitchToDataSection(TAI->getDataSection(), I);
742         }
743         break;
744       default:
745         cerr << "Unknown linkage type!";
746         abort();
747       }
748
749       EmitAlignment(Align, I);
750       O << name << ":\t\t\t\t" << TAI->getCommentString() << " '";
751       PrintUnmangledNameSafely(I, O);
752       O << "'\n";
753
754       // If the initializer is a extern weak symbol, remember to emit the weak
755       // reference!
756       if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
757         if (GV->hasExternalWeakLinkage())
758           ExtWeakSymbols.insert(GV);
759
760       EmitGlobalConstant(C);
761       O << '\n';
762     }
763   }
764
765   // TODO
766
767   // Emit initial debug information.
768   DW.EndModule();
769
770   return AsmPrinter::doFinalization(M);
771 }
772
773 std::string PPCLinuxAsmPrinter::getSectionForFunction(const Function &F) const {
774   switch (F.getLinkage()) {
775   default: assert(0 && "Unknown linkage type!");
776   case Function::ExternalLinkage:
777   case Function::InternalLinkage: return TAI->getTextSection();
778   case Function::WeakLinkage:
779   case Function::LinkOnceLinkage:
780     return ".text";
781   }
782 }
783
784 std::string PPCDarwinAsmPrinter::getSectionForFunction(const Function &F) const {
785   switch (F.getLinkage()) {
786   default: assert(0 && "Unknown linkage type!");
787   case Function::ExternalLinkage:
788   case Function::InternalLinkage: return TAI->getTextSection();
789   case Function::WeakLinkage:
790   case Function::LinkOnceLinkage:
791     return "\t.section __TEXT,__textcoal_nt,coalesced,pure_instructions";
792   }
793 }
794
795 /// runOnMachineFunction - This uses the printMachineInstruction()
796 /// method to print assembly for each instruction.
797 ///
798 bool PPCDarwinAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
799
800   SetupMachineFunction(MF);
801   O << "\n\n";
802
803   // Print out constants referenced by the function
804   EmitConstantPool(MF.getConstantPool());
805
806   // Print out labels for the function.
807   const Function *F = MF.getFunction();
808   SwitchToTextSection(getSectionForFunction(*F).c_str(), F);
809
810   switch (F->getLinkage()) {
811   default: assert(0 && "Unknown linkage type!");
812   case Function::InternalLinkage:  // Symbols default to internal.
813     break;
814   case Function::ExternalLinkage:
815     O << "\t.globl\t" << CurrentFnName << "\n";
816     break;
817   case Function::WeakLinkage:
818   case Function::LinkOnceLinkage:
819     O << "\t.globl\t" << CurrentFnName << "\n";
820     O << "\t.weak_definition\t" << CurrentFnName << "\n";
821     break;
822   }
823
824   if (F->hasHiddenVisibility())
825     if (const char *Directive = TAI->getHiddenDirective())
826       O << Directive << CurrentFnName << "\n";
827
828   EmitAlignment(OptimizeForSize ? 2 : 4, F);
829   O << CurrentFnName << ":\n";
830
831   // Emit pre-function debug information.
832   DW.BeginFunction(&MF);
833
834   // If the function is empty, then we need to emit *something*. Otherwise, the
835   // function's label might be associated with something that it wasn't meant to
836   // be associated with. We emit a noop in this situation.
837   MachineFunction::iterator I = MF.begin();
838
839   if (++I == MF.end() && MF.front().empty())
840     O << "\tnop\n";
841
842   // Print out code for the function.
843   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
844        I != E; ++I) {
845     // Print a label for the basic block.
846     if (I != MF.begin()) {
847       printBasicBlockLabel(I, true, true);
848       O << '\n';
849     }
850     for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
851          II != IE; ++II) {
852       // Print the assembly for the instruction.
853       printMachineInstruction(II);
854     }
855   }
856
857   // Print out jump tables referenced by the function.
858   EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
859
860   // Emit post-function debug information.
861   DW.EndFunction();
862
863   // We didn't modify anything.
864   return false;
865 }
866
867
868 bool PPCDarwinAsmPrinter::doInitialization(Module &M) {
869   static const char *const CPUDirectives[] = {
870     "",
871     "ppc",
872     "ppc601",
873     "ppc602",
874     "ppc603",
875     "ppc7400",
876     "ppc750",
877     "ppc970",
878     "ppc64"
879   };
880
881   unsigned Directive = Subtarget.getDarwinDirective();
882   if (Subtarget.isGigaProcessor() && Directive < PPC::DIR_970)
883     Directive = PPC::DIR_970;
884   if (Subtarget.hasAltivec() && Directive < PPC::DIR_7400)
885     Directive = PPC::DIR_7400;
886   if (Subtarget.isPPC64() && Directive < PPC::DIR_970)
887     Directive = PPC::DIR_64;
888   assert(Directive <= PPC::DIR_64 && "Directive out of range.");
889   O << "\t.machine " << CPUDirectives[Directive] << "\n";
890
891   bool Result = AsmPrinter::doInitialization(M);
892
893   // Emit initial debug information.
894   DW.BeginModule(&M);
895
896   // We need this for Personality functions.
897   // AsmPrinter::doInitialization should have done this analysis.
898   MMI = getAnalysisToUpdate<MachineModuleInfo>();
899   assert(MMI);
900   DW.SetModuleInfo(MMI);
901
902   // Darwin wants symbols to be quoted if they have complex names.
903   Mang->setUseQuotes(true);
904
905   // Prime text sections so they are adjacent.  This reduces the likelihood a
906   // large data or debug section causes a branch to exceed 16M limit.
907   SwitchToTextSection("\t.section __TEXT,__textcoal_nt,coalesced,"
908                       "pure_instructions");
909   if (TM.getRelocationModel() == Reloc::PIC_) {
910     SwitchToTextSection("\t.section __TEXT,__picsymbolstub1,symbol_stubs,"
911                           "pure_instructions,32");
912   } else if (TM.getRelocationModel() == Reloc::DynamicNoPIC) {
913     SwitchToTextSection("\t.section __TEXT,__symbol_stub1,symbol_stubs,"
914                         "pure_instructions,16");
915   }
916   SwitchToTextSection(TAI->getTextSection());
917
918   return Result;
919 }
920
921 bool PPCDarwinAsmPrinter::doFinalization(Module &M) {
922   const TargetData *TD = TM.getTargetData();
923
924   // Print out module-level global variables here.
925   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
926        I != E; ++I) {
927     if (!I->hasInitializer()) continue;   // External global require no code
928
929     // Check to see if this is a special global used by LLVM, if so, emit it.
930     if (EmitSpecialLLVMGlobal(I)) {
931       if (TM.getRelocationModel() == Reloc::Static) {
932         if (I->getName() == "llvm.global_ctors")
933           O << ".reference .constructors_used\n";
934         else if (I->getName() == "llvm.global_dtors")
935           O << ".reference .destructors_used\n";
936       }
937       continue;
938     }
939
940     std::string name = Mang->getValueName(I);
941
942     if (I->hasHiddenVisibility())
943       if (const char *Directive = TAI->getHiddenDirective())
944         O << Directive << name << "\n";
945
946     Constant *C = I->getInitializer();
947     const Type *Type = C->getType();
948     unsigned Size = TD->getABITypeSize(Type);
949     unsigned Align = TD->getPreferredAlignmentLog(I);
950
951     if (C->isNullValue() && /* FIXME: Verify correct */
952         !I->hasSection() && (I->hasCommonLinkage() ||
953          I->hasInternalLinkage() || I->hasWeakLinkage() ||
954          I->hasLinkOnceLinkage() || I->hasExternalLinkage())) {
955       if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
956       if (I->hasExternalLinkage()) {
957         O << "\t.globl " << name << '\n';
958         O << "\t.zerofill __DATA, __common, " << name << ", "
959           << Size << ", " << Align;
960       } else if (I->hasInternalLinkage()) {
961         SwitchToDataSection("\t.data", I);
962         O << TAI->getLCOMMDirective() << name << "," << Size << "," << Align;
963       } else if (!I->hasCommonLinkage()) {
964         O << "\t.globl " << name << "\n"
965           << TAI->getWeakDefDirective() << name << "\n";
966         SwitchToDataSection("\t.section __DATA,__datacoal_nt,coalesced", I);
967         EmitAlignment(Align, I);
968         O << name << ":\t\t\t\t" << TAI->getCommentString() << " ";
969         PrintUnmangledNameSafely(I, O);
970         O << "\n";
971         EmitGlobalConstant(C);
972         continue;
973       } else {
974         SwitchToDataSection("\t.data", I);
975         O << ".comm " << name << "," << Size;
976         // Darwin 9 and above support aligned common data.
977         if (Subtarget.isDarwin9())
978           O << "," << Align;
979       }
980       O << "\t\t" << TAI->getCommentString() << " '";
981       PrintUnmangledNameSafely(I, O);
982       O << "'\n";
983     } else {
984       switch (I->getLinkage()) {
985       case GlobalValue::LinkOnceLinkage:
986       case GlobalValue::WeakLinkage:
987       case GlobalValue::CommonLinkage:
988         O << "\t.globl " << name << '\n'
989           << "\t.weak_definition " << name << '\n';
990         if (!I->isConstant())
991           SwitchToDataSection("\t.section __DATA,__datacoal_nt,coalesced", I);
992         else {
993           const ArrayType *AT = dyn_cast<ArrayType>(Type);
994           if (AT && AT->getElementType()==Type::Int8Ty)
995             SwitchToDataSection("\t.section __TEXT,__const_coal,coalesced", I);
996           else
997             SwitchToDataSection("\t.section __DATA,__const_coal,coalesced", I);
998         }
999         break;
1000       case GlobalValue::AppendingLinkage:
1001         // FIXME: appending linkage variables should go into a section of
1002         // their name or something.  For now, just emit them as external.
1003       case GlobalValue::ExternalLinkage:
1004         // If external or appending, declare as a global symbol
1005         O << "\t.globl " << name << "\n";
1006         // FALL THROUGH
1007       case GlobalValue::InternalLinkage:
1008         if (I->isConstant()) {
1009           const ConstantArray *CVA = dyn_cast<ConstantArray>(C);
1010           if (TAI->getCStringSection() && CVA && CVA->isCString()) {
1011             SwitchToDataSection(TAI->getCStringSection(), I);
1012             break;
1013           }
1014         }
1015         if (I->hasSection()) {
1016           // Honor all section names on Darwin; ObjC uses this
1017           std::string SectionName = ".section " + I->getSection();
1018           SwitchToDataSection(SectionName.c_str());
1019         } else if (!I->isConstant())
1020           SwitchToDataSection(TAI->getDataSection(), I);
1021         else {
1022           // Read-only data.
1023           bool HasReloc = C->ContainsRelocations();
1024           if (HasReloc &&
1025               TM.getRelocationModel() != Reloc::Static)
1026             SwitchToDataSection("\t.const_data\n");
1027           else if (!HasReloc && Size == 4 &&
1028                    TAI->getFourByteConstantSection())
1029             SwitchToDataSection(TAI->getFourByteConstantSection(), I);
1030           else if (!HasReloc && Size == 8 &&
1031                    TAI->getEightByteConstantSection())
1032             SwitchToDataSection(TAI->getEightByteConstantSection(), I);
1033           else if (!HasReloc && Size == 16 &&
1034                    TAI->getSixteenByteConstantSection())
1035             SwitchToDataSection(TAI->getSixteenByteConstantSection(), I);
1036           else if (TAI->getReadOnlySection())
1037             SwitchToDataSection(TAI->getReadOnlySection(), I);
1038           else
1039             SwitchToDataSection(TAI->getDataSection(), I);
1040         }
1041         break;
1042       default:
1043         cerr << "Unknown linkage type!";
1044         abort();
1045       }
1046
1047       EmitAlignment(Align, I);
1048       O << name << ":\t\t\t\t" << TAI->getCommentString() << " '";
1049       PrintUnmangledNameSafely(I, O);
1050       O << "'\n";
1051
1052       // If the initializer is a extern weak symbol, remember to emit the weak
1053       // reference!
1054       if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
1055         if (GV->hasExternalWeakLinkage())
1056           ExtWeakSymbols.insert(GV);
1057
1058       EmitGlobalConstant(C);
1059       O << '\n';
1060     }
1061   }
1062
1063   bool isPPC64 = TD->getPointerSizeInBits() == 64;
1064
1065   // Output stubs for dynamically-linked functions
1066   if (TM.getRelocationModel() == Reloc::PIC_) {
1067     for (std::set<std::string>::iterator i = FnStubs.begin(), e = FnStubs.end();
1068          i != e; ++i) {
1069       SwitchToTextSection("\t.section __TEXT,__picsymbolstub1,symbol_stubs,"
1070                           "pure_instructions,32");
1071       EmitAlignment(4);
1072       std::string p = *i;
1073       std::string L0p = (p[0]=='\"') ? "\"L0$" + p.substr(1) : "L0$" + p ;
1074       printSuffixedName(p, "$stub");
1075       O << ":\n";
1076       O << "\t.indirect_symbol " << *i << "\n";
1077       O << "\tmflr r0\n";
1078       O << "\tbcl 20,31," << L0p << "\n";
1079       O << L0p << ":\n";
1080       O << "\tmflr r11\n";
1081       O << "\taddis r11,r11,ha16(";
1082       printSuffixedName(p, "$lazy_ptr");
1083       O << "-" << L0p << ")\n";
1084       O << "\tmtlr r0\n";
1085       if (isPPC64)
1086         O << "\tldu r12,lo16(";
1087       else
1088         O << "\tlwzu r12,lo16(";
1089       printSuffixedName(p, "$lazy_ptr");
1090       O << "-" << L0p << ")(r11)\n";
1091       O << "\tmtctr r12\n";
1092       O << "\tbctr\n";
1093       SwitchToDataSection(".lazy_symbol_pointer");
1094       printSuffixedName(p, "$lazy_ptr");
1095       O << ":\n";
1096       O << "\t.indirect_symbol " << *i << "\n";
1097       if (isPPC64)
1098         O << "\t.quad dyld_stub_binding_helper\n";
1099       else
1100         O << "\t.long dyld_stub_binding_helper\n";
1101     }
1102   } else {
1103     for (std::set<std::string>::iterator i = FnStubs.begin(), e = FnStubs.end();
1104          i != e; ++i) {
1105       SwitchToTextSection("\t.section __TEXT,__symbol_stub1,symbol_stubs,"
1106                           "pure_instructions,16");
1107       EmitAlignment(4);
1108       std::string p = *i;
1109       printSuffixedName(p, "$stub");
1110       O << ":\n";
1111       O << "\t.indirect_symbol " << *i << "\n";
1112       O << "\tlis r11,ha16(";
1113       printSuffixedName(p, "$lazy_ptr");
1114       O << ")\n";
1115       if (isPPC64)
1116         O << "\tldu r12,lo16(";
1117       else
1118         O << "\tlwzu r12,lo16(";
1119       printSuffixedName(p, "$lazy_ptr");
1120       O << ")(r11)\n";
1121       O << "\tmtctr r12\n";
1122       O << "\tbctr\n";
1123       SwitchToDataSection(".lazy_symbol_pointer");
1124       printSuffixedName(p, "$lazy_ptr");
1125       O << ":\n";
1126       O << "\t.indirect_symbol " << *i << "\n";
1127       if (isPPC64)
1128         O << "\t.quad dyld_stub_binding_helper\n";
1129       else
1130         O << "\t.long dyld_stub_binding_helper\n";
1131     }
1132   }
1133
1134   O << "\n";
1135
1136   if (TAI->doesSupportExceptionHandling() && MMI) {
1137     // Add the (possibly multiple) personalities to the set of global values.
1138     // Only referenced functions get into the Personalities list.
1139     const std::vector<Function *>& Personalities = MMI->getPersonalities();
1140
1141     for (std::vector<Function *>::const_iterator I = Personalities.begin(),
1142            E = Personalities.end(); I != E; ++I)
1143       if (*I) GVStubs.insert("_" + (*I)->getName());
1144   }
1145
1146   // Output stubs for external and common global variables.
1147   if (!GVStubs.empty()) {
1148     SwitchToDataSection(".non_lazy_symbol_pointer");
1149     for (std::set<std::string>::iterator I = GVStubs.begin(),
1150          E = GVStubs.end(); I != E; ++I) {
1151       std::string p = *I;
1152       printSuffixedName(p, "$non_lazy_ptr");
1153       O << ":\n";
1154       O << "\t.indirect_symbol " << *I << "\n";
1155       if (isPPC64)
1156         O << "\t.quad\t0\n";
1157       else
1158         O << "\t.long\t0\n";
1159     }
1160   }
1161
1162   // Emit initial debug information.
1163   DW.EndModule();
1164
1165   // Funny Darwin hack: This flag tells the linker that no global symbols
1166   // contain code that falls through to other global symbols (e.g. the obvious
1167   // implementation of multiple entry points).  If this doesn't occur, the
1168   // linker can safely perform dead code stripping.  Since LLVM never generates
1169   // code that does this, it is always safe to set.
1170   O << "\t.subsections_via_symbols\n";
1171
1172   return AsmPrinter::doFinalization(M);
1173 }
1174
1175
1176
1177 /// createPPCAsmPrinterPass - Returns a pass that prints the PPC assembly code
1178 /// for a MachineFunction to the given output stream, in a format that the
1179 /// Darwin assembler can deal with.
1180 ///
1181 FunctionPass *llvm::createPPCAsmPrinterPass(std::ostream &o,
1182                                             PPCTargetMachine &tm) {
1183   const PPCSubtarget *Subtarget = &tm.getSubtarget<PPCSubtarget>();
1184
1185   if (Subtarget->isDarwin()) {
1186     return new PPCDarwinAsmPrinter(o, tm, tm.getTargetAsmInfo());
1187   } else {
1188     return new PPCLinuxAsmPrinter(o, tm, tm.getTargetAsmInfo());
1189   }
1190 }