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