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