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 <set>
  47 using namespace llvm;
  48
  49 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  50
  51 namespace {
  52   struct VISIBILITY_HIDDEN PPCAsmPrinter : public AsmPrinter {
  53     std::set<std::string> FnStubs, GVStubs;
  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.isRegister()) {
 127         printRegister(MO, false);
 128       } else if (MO.isImmediate()) {
 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).isImmediate()) {
 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).isImmediate()) {
 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).isImmediate()) {
 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).isImmediate()) {
 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).isRegister() &&
 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).isImmediate())
 262         printS16X4ImmOperand(MI, OpNo);
 263       else
 264         printSymbolLo(MI, OpNo);
 265       O << '(';
 266       if (MI->getOperand(OpNo+1).isRegister() &&
 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
 296     DwarfWriter DW;
 297     MachineModuleInfo *MMI;
 298
 299     PPCLinuxAsmPrinter(raw_ostream &O, PPCTargetMachine &TM,
 300                     const TargetAsmInfo *T)
 301       : PPCAsmPrinter(O, TM, T), DW(O, this, T), MMI(0) {
 302     }
 303
 304     virtual const char *getPassName() const {
 305       return "Linux PPC Assembly Printer";
 306     }
 307
 308     bool runOnMachineFunction(MachineFunction &F);
 309     bool doInitialization(Module &M);
 310     bool doFinalization(Module &M);
 311
 312     void getAnalysisUsage(AnalysisUsage &AU) const {
 313       AU.setPreservesAll();
 314       AU.addRequired<MachineModuleInfo>();
 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
 328     PPCDarwinAsmPrinter(raw_ostream &O, PPCTargetMachine &TM,
 329                         const TargetAsmInfo *T)
 330       : PPCAsmPrinter(O, TM, T), DW(O, this, T), MMI(0) {
 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       PPCAsmPrinter::getAnalysisUsage(AU);
 345     }
 346
 347     void printModuleLevelGV(const GlobalVariable* GVar);
 348   };
 349 } // end of anonymous namespace
 350
 351 // Include the auto-generated portion of the assembly writer
 352 #include "PPCGenAsmWriter.inc"
 353
 354 void PPCAsmPrinter::printOp(const MachineOperand &MO) {
 355   switch (MO.getType()) {
 356   case MachineOperand::MO_Immediate:
 357     cerr << "printOp() does not handle immediate values\n";
 358     abort();
 359     return;
 360
 361   case MachineOperand::MO_MachineBasicBlock:
 362     printBasicBlockLabel(MO.getMBB());
 363     return;
 364   case MachineOperand::MO_JumpTableIndex:
 365     O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 366       << '_' << MO.getIndex();
 367     // FIXME: PIC relocation model
 368     return;
 369   case MachineOperand::MO_ConstantPoolIndex:
 370     O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber()
 371       << '_' << MO.getIndex();
 372     return;
 373   case MachineOperand::MO_ExternalSymbol:
 374     // Computing the address of an external symbol, not calling it.
 375     if (TM.getRelocationModel() != Reloc::Static) {
 376       std::string Name(TAI->getGlobalPrefix()); Name += MO.getSymbolName();
 377       GVStubs.insert(Name);
 378       printSuffixedName(Name, "$non_lazy_ptr");
 379       return;
 380     }
 381     O << TAI->getGlobalPrefix() << MO.getSymbolName();
 382     return;
 383   case MachineOperand::MO_GlobalAddress: {
 384     // Computing the address of a global symbol, not calling it.
 385     GlobalValue *GV = MO.getGlobal();
 386     std::string Name = Mang->getValueName(GV);
 387
 388     // External or weakly linked global variables need non-lazily-resolved stubs
 389     if (TM.getRelocationModel() != Reloc::Static) {
 390       if (((GV->isDeclaration() || GV->hasWeakLinkage() ||
 391             GV->hasLinkOnceLinkage() || GV->hasCommonLinkage()))) {
 392         GVStubs.insert(Name);
 393         printSuffixedName(Name, "$non_lazy_ptr");
 394         if (GV->hasExternalWeakLinkage())
 395           ExtWeakSymbols.insert(GV);
 396         return;
 397       }
 398     }
 399     O << Name;
 400
 401     if (MO.getOffset() > 0)
 402       O << "+" << MO.getOffset();
 403     else if (MO.getOffset() < 0)
 404       O << MO.getOffset();
 405
 406     if (GV->hasExternalWeakLinkage())
 407       ExtWeakSymbols.insert(GV);
 408     return;
 409   }
 410
 411   default:
 412     O << "<unknown operand type: " << MO.getType() << ">";
 413     return;
 414   }
 415 }
 416
 417 /// EmitExternalGlobal - In this case we need to use the indirect symbol.
 418 ///
 419 void PPCAsmPrinter::EmitExternalGlobal(const GlobalVariable *GV) {
 420   std::string Name = getGlobalLinkName(GV);
 421   if (TM.getRelocationModel() != Reloc::Static) {
 422     GVStubs.insert(Name);
 423     printSuffixedName(Name, "$non_lazy_ptr");
 424     return;
 425   }
 426   O << Name;
 427 }
 428
 429 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 430 ///
 431 bool PPCAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 432                                     unsigned AsmVariant,
 433                                     const char *ExtraCode) {
 434   // Does this asm operand have a single letter operand modifier?
 435   if (ExtraCode && ExtraCode[0]) {
 436     if (ExtraCode[1] != 0) return true; // Unknown modifier.
 437
 438     switch (ExtraCode[0]) {
 439     default: return true;  // Unknown modifier.
 440     case 'c': // Don't print "$" before a global var name or constant.
 441       // PPC never has a prefix.
 442       printOperand(MI, OpNo);
 443       return false;
 444     case 'L': // Write second word of DImode reference.
 445       // Verify that this operand has two consecutive registers.
 446       if (!MI->getOperand(OpNo).isRegister() ||
 447           OpNo+1 == MI->getNumOperands() ||
 448           !MI->getOperand(OpNo+1).isRegister())
 449         return true;
 450       ++OpNo;   // Return the high-part.
 451       break;
 452     case 'I':
 453       // Write 'i' if an integer constant, otherwise nothing.  Used to print
 454       // addi vs add, etc.
 455       if (MI->getOperand(OpNo).isImmediate())
 456         O << "i";
 457       return false;
 458     }
 459   }
 460
 461   printOperand(MI, OpNo);
 462   return false;
 463 }
 464
 465 bool PPCAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
 466                                           unsigned AsmVariant,
 467                                           const char *ExtraCode) {
 468   if (ExtraCode && ExtraCode[0])
 469     return true; // Unknown modifier.
 470   if (MI->getOperand(OpNo).isRegister())
 471     printMemRegReg(MI, OpNo);
 472   else
 473     printMemRegImm(MI, OpNo);
 474   return false;
 475 }
 476
 477 void PPCAsmPrinter::printPredicateOperand(const MachineInstr *MI, unsigned OpNo,
 478                                           const char *Modifier) {
 479   assert(Modifier && "Must specify 'cc' or 'reg' as predicate op modifier!");
 480   unsigned Code = MI->getOperand(OpNo).getImm();
 481   if (!strcmp(Modifier, "cc")) {
 482     switch ((PPC::Predicate)Code) {
 483     case PPC::PRED_ALWAYS: return; // Don't print anything for always.
 484     case PPC::PRED_LT: O << "lt"; return;
 485     case PPC::PRED_LE: O << "le"; return;
 486     case PPC::PRED_EQ: O << "eq"; return;
 487     case PPC::PRED_GE: O << "ge"; return;
 488     case PPC::PRED_GT: O << "gt"; return;
 489     case PPC::PRED_NE: O << "ne"; return;
 490     case PPC::PRED_UN: O << "un"; return;
 491     case PPC::PRED_NU: O << "nu"; return;
 492     }
 493
 494   } else {
 495     assert(!strcmp(Modifier, "reg") &&
 496            "Need to specify 'cc' or 'reg' as predicate op modifier!");
 497     // Don't print the register for 'always'.
 498     if (Code == PPC::PRED_ALWAYS) return;
 499     printOperand(MI, OpNo+1);
 500   }
 501 }
 502
 503
 504 /// printMachineInstruction -- Print out a single PowerPC MI in Darwin syntax to
 505 /// the current output stream.
 506 ///
 507 void PPCAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
 508   ++EmittedInsts;
 509
 510   // Check for slwi/srwi mnemonics.
 511   if (MI->getOpcode() == PPC::RLWINM) {
 512     bool FoundMnemonic = false;
 513     unsigned char SH = MI->getOperand(2).getImm();
 514     unsigned char MB = MI->getOperand(3).getImm();
 515     unsigned char ME = MI->getOperand(4).getImm();
 516     if (SH <= 31 && MB == 0 && ME == (31-SH)) {
 517       O << "\tslwi "; FoundMnemonic = true;
 518     }
 519     if (SH <= 31 && MB == (32-SH) && ME == 31) {
 520       O << "\tsrwi "; FoundMnemonic = true;
 521       SH = 32-SH;
 522     }
 523     if (FoundMnemonic) {
 524       printOperand(MI, 0);
 525       O << ", ";
 526       printOperand(MI, 1);
 527       O << ", " << (unsigned int)SH << '\n';
 528       return;
 529     }
 530   } else if (MI->getOpcode() == PPC::OR || MI->getOpcode() == PPC::OR8) {
 531     if (MI->getOperand(1).getReg() == MI->getOperand(2).getReg()) {
 532       O << "\tmr ";
 533       printOperand(MI, 0);
 534       O << ", ";
 535       printOperand(MI, 1);
 536       O << '\n';
 537       return;
 538     }
 539   } else if (MI->getOpcode() == PPC::RLDICR) {
 540     unsigned char SH = MI->getOperand(2).getImm();
 541     unsigned char ME = MI->getOperand(3).getImm();
 542     // rldicr RA, RS, SH, 63-SH == sldi RA, RS, SH
 543     if (63-SH == ME) {
 544       O << "\tsldi ";
 545       printOperand(MI, 0);
 546       O << ", ";
 547       printOperand(MI, 1);
 548       O << ", " << (unsigned int)SH << '\n';
 549       return;
 550     }
 551   }
 552
 553   if (printInstruction(MI))
 554     return; // Printer was automatically generated
 555
 556   assert(0 && "Unhandled instruction in asm writer!");
 557   abort();
 558   return;
 559 }
 560
 561 /// runOnMachineFunction - This uses the printMachineInstruction()
 562 /// method to print assembly for each instruction.
 563 ///
 564 bool PPCLinuxAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
 565
 566   SetupMachineFunction(MF);
 567   O << "\n\n";
 568
 569   // Print out constants referenced by the function
 570   EmitConstantPool(MF.getConstantPool());
 571
 572   // Print out labels for the function.
 573   const Function *F = MF.getFunction();
 574   SwitchToSection(TAI->SectionForGlobal(F));
 575
 576   switch (F->getLinkage()) {
 577   default: assert(0 && "Unknown linkage type!");
 578   case Function::InternalLinkage:  // Symbols default to internal.
 579     break;
 580   case Function::ExternalLinkage:
 581     O << "\t.global\t" << CurrentFnName << '\n'
 582       << "\t.type\t" << CurrentFnName << ", @function\n";
 583     break;
 584   case Function::WeakLinkage:
 585   case Function::LinkOnceLinkage:
 586     O << "\t.global\t" << CurrentFnName << '\n';
 587     O << "\t.weak\t" << CurrentFnName << '\n';
 588     break;
 589   }
 590
 591   printVisibility(CurrentFnName, F->getVisibility());
 592
 593   EmitAlignment(2, F);
 594   O << CurrentFnName << ":\n";
 595
 596   // Emit pre-function debug information.
 597   DW.BeginFunction(&MF);
 598
 599   // Print out code for the function.
 600   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 601        I != E; ++I) {
 602     // Print a label for the basic block.
 603     if (I != MF.begin()) {
 604       printBasicBlockLabel(I, true, true);
 605       O << '\n';
 606     }
 607     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 608          II != E; ++II) {
 609       // Print the assembly for the instruction.
 610       printMachineInstruction(II);
 611     }
 612   }
 613
 614   O << "\t.size\t" << CurrentFnName << ",.-" << CurrentFnName << '\n';
 615
 616   // Print out jump tables referenced by the function.
 617   EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
 618
 619   // Emit post-function debug information.
 620   DW.EndFunction(&MF);
 621
 622   // We didn't modify anything.
 623   return false;
 624 }
 625
 626 bool PPCLinuxAsmPrinter::doInitialization(Module &M) {
 627   bool Result = AsmPrinter::doInitialization(M);
 628
 629   // Emit initial debug information.
 630   DW.BeginModule(&M);
 631
 632   // AsmPrinter::doInitialization should have done this analysis.
 633   MMI = getAnalysisToUpdate<MachineModuleInfo>();
 634   assert(MMI);
 635   DW.SetModuleInfo(MMI);
 636
 637   // GNU as handles section names wrapped in quotes
 638   Mang->setUseQuotes(true);
 639
 640   SwitchToSection(TAI->getTextSection());
 641
 642   return Result;
 643 }
 644
 645 /// PrintUnmangledNameSafely - Print out the printable characters in the name.
 646 /// Don't print things like \n or \0.
 647 static void PrintUnmangledNameSafely(const Value *V, raw_ostream &OS) {
 648   for (const char *Name = V->getNameStart(), *E = Name+V->getNameLen();
 649        Name != E; ++Name)
 650     if (isprint(*Name))
 651       OS << *Name;
 652 }
 653
 654 void PPCLinuxAsmPrinter::printModuleLevelGV(const GlobalVariable* GVar) {
 655   const TargetData *TD = TM.getTargetData();
 656
 657   if (!GVar->hasInitializer())
 658     return;   // External global require no code
 659
 660   // Check to see if this is a special global used by LLVM, if so, emit it.
 661   if (EmitSpecialLLVMGlobal(GVar))
 662     return;
 663
 664   std::string name = Mang->getValueName(GVar);
 665
 666   printVisibility(name, GVar->getVisibility());
 667
 668   Constant *C = GVar->getInitializer();
 669   const Type *Type = C->getType();
 670   unsigned Size = TD->getABITypeSize(Type);
 671   unsigned Align = TD->getPreferredAlignmentLog(GVar);
 672
 673   SwitchToSection(TAI->SectionForGlobal(GVar));
 674
 675   if (C->isNullValue() && /* FIXME: Verify correct */
 676       !GVar->hasSection() &&
 677       (GVar->hasInternalLinkage() || GVar->hasExternalLinkage() ||
 678        GVar->mayBeOverridden())) {
 679       if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
 680
 681       if (GVar->hasExternalLinkage()) {
 682         O << "\t.global " << name << '\n';
 683         O << "\t.type " << name << ", @object\n";
 684         O << name << ":\n";
 685         O << "\t.zero " << Size << '\n';
 686       } else if (GVar->hasInternalLinkage()) {
 687         O << TAI->getLCOMMDirective() << name << ',' << Size;
 688       } else {
 689         O << ".comm " << name << ',' << Size;
 690       }
 691       O << "\t\t" << TAI->getCommentString() << " '";
 692       PrintUnmangledNameSafely(GVar, O);
 693       O << "'\n";
 694       return;
 695   }
 696
 697   switch (GVar->getLinkage()) {
 698    case GlobalValue::LinkOnceLinkage:
 699    case GlobalValue::WeakLinkage:
 700    case GlobalValue::CommonLinkage:
 701     O << "\t.global " << name << '\n'
 702       << "\t.type " << name << ", @object\n"
 703       << "\t.weak " << name << '\n';
 704     break;
 705    case GlobalValue::AppendingLinkage:
 706     // FIXME: appending linkage variables should go into a section of
 707     // their name or something.  For now, just emit them as external.
 708    case GlobalValue::ExternalLinkage:
 709     // If external or appending, declare as a global symbol
 710     O << "\t.global " << name << '\n'
 711       << "\t.type " << name << ", @object\n";
 712     // FALL THROUGH
 713    case GlobalValue::InternalLinkage:
 714     break;
 715    default:
 716     cerr << "Unknown linkage type!";
 717     abort();
 718   }
 719
 720   EmitAlignment(Align, GVar);
 721   O << name << ":\t\t\t\t" << TAI->getCommentString() << " '";
 722   PrintUnmangledNameSafely(GVar, O);
 723   O << "'\n";
 724
 725   // If the initializer is a extern weak symbol, remember to emit the weak
 726   // reference!
 727   if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
 728     if (GV->hasExternalWeakLinkage())
 729       ExtWeakSymbols.insert(GV);
 730
 731   EmitGlobalConstant(C);
 732   O << '\n';
 733 }
 734
 735 bool PPCLinuxAsmPrinter::doFinalization(Module &M) {
 736   // Print out module-level global variables here.
 737   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 738        I != E; ++I)
 739     printModuleLevelGV(I);
 740
 741   // TODO
 742
 743   // Emit initial debug information.
 744   DW.EndModule();
 745
 746   return AsmPrinter::doFinalization(M);
 747 }
 748
 749 /// runOnMachineFunction - This uses the printMachineInstruction()
 750 /// method to print assembly for each instruction.
 751 ///
 752 bool PPCDarwinAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
 753   SetupMachineFunction(MF);
 754   O << "\n\n";
 755
 756   // Print out constants referenced by the function
 757   EmitConstantPool(MF.getConstantPool());
 758
 759   // Print out labels for the function.
 760   const Function *F = MF.getFunction();
 761   SwitchToSection(TAI->SectionForGlobal(F));
 762
 763   switch (F->getLinkage()) {
 764   default: assert(0 && "Unknown linkage type!");
 765   case Function::InternalLinkage:  // Symbols default to internal.
 766     break;
 767   case Function::ExternalLinkage:
 768     O << "\t.globl\t" << CurrentFnName << '\n';
 769     break;
 770   case Function::WeakLinkage:
 771   case Function::LinkOnceLinkage:
 772     O << "\t.globl\t" << CurrentFnName << '\n';
 773     O << "\t.weak_definition\t" << CurrentFnName << '\n';
 774     break;
 775   }
 776
 777   printVisibility(CurrentFnName, F->getVisibility());
 778
 779   EmitAlignment(F->hasFnAttr(Attribute::OptimizeForSize) ? 2 : 4, F);
 780   O << CurrentFnName << ":\n";
 781
 782   // Emit pre-function debug information.
 783   DW.BeginFunction(&MF);
 784
 785   // If the function is empty, then we need to emit *something*. Otherwise, the
 786   // function's label might be associated with something that it wasn't meant to
 787   // be associated with. We emit a noop in this situation.
 788   MachineFunction::iterator I = MF.begin();
 789
 790   if (++I == MF.end() && MF.front().empty())
 791     O << "\tnop\n";
 792
 793   // Print out code for the function.
 794   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 795        I != E; ++I) {
 796     // Print a label for the basic block.
 797     if (I != MF.begin()) {
 798       printBasicBlockLabel(I, true, true);
 799       O << '\n';
 800     }
 801     for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
 802          II != IE; ++II) {
 803       // Print the assembly for the instruction.
 804       printMachineInstruction(II);
 805     }
 806   }
 807
 808   // Print out jump tables referenced by the function.
 809   EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
 810
 811   // Emit post-function debug information.
 812   DW.EndFunction(&MF);
 813
 814   // We didn't modify anything.
 815   return false;
 816 }
 817
 818
 819 bool PPCDarwinAsmPrinter::doInitialization(Module &M) {
 820   static const char *const CPUDirectives[] = {
 821     "",
 822     "ppc",
 823     "ppc601",
 824     "ppc602",
 825     "ppc603",
 826     "ppc7400",
 827     "ppc750",
 828     "ppc970",
 829     "ppc64"
 830   };
 831
 832   unsigned Directive = Subtarget.getDarwinDirective();
 833   if (Subtarget.isGigaProcessor() && Directive < PPC::DIR_970)
 834     Directive = PPC::DIR_970;
 835   if (Subtarget.hasAltivec() && Directive < PPC::DIR_7400)
 836     Directive = PPC::DIR_7400;
 837   if (Subtarget.isPPC64() && Directive < PPC::DIR_970)
 838     Directive = PPC::DIR_64;
 839   assert(Directive <= PPC::DIR_64 && "Directive out of range.");
 840   O << "\t.machine " << CPUDirectives[Directive] << '\n';
 841
 842   bool Result = AsmPrinter::doInitialization(M);
 843
 844   // Emit initial debug information.
 845   DW.BeginModule(&M);
 846
 847   // We need this for Personality functions.
 848   // AsmPrinter::doInitialization should have done this analysis.
 849   MMI = getAnalysisToUpdate<MachineModuleInfo>();
 850   assert(MMI);
 851   DW.SetModuleInfo(MMI);
 852
 853   // Darwin wants symbols to be quoted if they have complex names.
 854   Mang->setUseQuotes(true);
 855
 856   // Prime text sections so they are adjacent.  This reduces the likelihood a
 857   // large data or debug section causes a branch to exceed 16M limit.
 858   SwitchToTextSection("\t.section __TEXT,__textcoal_nt,coalesced,"
 859                       "pure_instructions");
 860   if (TM.getRelocationModel() == Reloc::PIC_) {
 861     SwitchToTextSection("\t.section __TEXT,__picsymbolstub1,symbol_stubs,"
 862                           "pure_instructions,32");
 863   } else if (TM.getRelocationModel() == Reloc::DynamicNoPIC) {
 864     SwitchToTextSection("\t.section __TEXT,__symbol_stub1,symbol_stubs,"
 865                         "pure_instructions,16");
 866   }
 867   SwitchToSection(TAI->getTextSection());
 868
 869   return Result;
 870 }
 871
 872 void PPCDarwinAsmPrinter::printModuleLevelGV(const GlobalVariable* GVar) {
 873   const TargetData *TD = TM.getTargetData();
 874
 875   if (!GVar->hasInitializer())
 876     return;   // External global require no code
 877
 878   // Check to see if this is a special global used by LLVM, if so, emit it.
 879   if (EmitSpecialLLVMGlobal(GVar)) {
 880     if (TM.getRelocationModel() == Reloc::Static) {
 881       if (GVar->getName() == "llvm.global_ctors")
 882         O << ".reference .constructors_used\n";
 883       else if (GVar->getName() == "llvm.global_dtors")
 884         O << ".reference .destructors_used\n";
 885     }
 886     return;
 887   }
 888
 889   std::string name = Mang->getValueName(GVar);
 890
 891   printVisibility(name, GVar->getVisibility());
 892
 893   Constant *C = GVar->getInitializer();
 894   const Type *Type = C->getType();
 895   unsigned Size = TD->getABITypeSize(Type);
 896   unsigned Align = TD->getPreferredAlignmentLog(GVar);
 897
 898   SwitchToSection(TAI->SectionForGlobal(GVar));
 899
 900   if (C->isNullValue() && /* FIXME: Verify correct */
 901       !GVar->hasSection() &&
 902       (GVar->hasInternalLinkage() || GVar->hasExternalLinkage() ||
 903        GVar->mayBeOverridden())) {
 904     if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
 905
 906     if (GVar->hasExternalLinkage()) {
 907       O << "\t.globl " << name << '\n';
 908       O << "\t.zerofill __DATA, __common, " << name << ", "
 909         << Size << ", " << Align;
 910     } else if (GVar->hasInternalLinkage()) {
 911       O << TAI->getLCOMMDirective() << name << ',' << Size << ',' << Align;
 912     } else if (!GVar->hasCommonLinkage()) {
 913       O << "\t.globl " << name << '\n'
 914         << TAI->getWeakDefDirective() << name << '\n';
 915       EmitAlignment(Align, GVar);
 916       O << name << ":\t\t\t\t" << TAI->getCommentString() << " ";
 917       PrintUnmangledNameSafely(GVar, O);
 918       O << '\n';
 919       EmitGlobalConstant(C);
 920       return;
 921     } else {
 922       O << ".comm " << name << ',' << Size;
 923       // Darwin 9 and above support aligned common data.
 924       if (Subtarget.isDarwin9())
 925         O << ',' << Align;
 926     }
 927     O << "\t\t" << TAI->getCommentString() << " '";
 928     PrintUnmangledNameSafely(GVar, O);
 929     O << "'\n";
 930     return;
 931   }
 932
 933   switch (GVar->getLinkage()) {
 934    case GlobalValue::LinkOnceLinkage:
 935    case GlobalValue::WeakLinkage:
 936    case GlobalValue::CommonLinkage:
 937     O << "\t.globl " << name << '\n'
 938       << "\t.weak_definition " << name << '\n';
 939     break;
 940    case GlobalValue::AppendingLinkage:
 941     // FIXME: appending linkage variables should go into a section of
 942     // their name or something.  For now, just emit them as external.
 943    case GlobalValue::ExternalLinkage:
 944     // If external or appending, declare as a global symbol
 945     O << "\t.globl " << name << '\n';
 946     // FALL THROUGH
 947    case GlobalValue::InternalLinkage:
 948     break;
 949    default:
 950     cerr << "Unknown linkage type!";
 951     abort();
 952   }
 953
 954   EmitAlignment(Align, GVar);
 955   O << name << ":\t\t\t\t" << TAI->getCommentString() << " '";
 956   PrintUnmangledNameSafely(GVar, O);
 957   O << "'\n";
 958
 959   // If the initializer is a extern weak symbol, remember to emit the weak
 960   // reference!
 961   if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
 962     if (GV->hasExternalWeakLinkage())
 963       ExtWeakSymbols.insert(GV);
 964
 965   EmitGlobalConstant(C);
 966   O << '\n';
 967 }
 968
 969 bool PPCDarwinAsmPrinter::doFinalization(Module &M) {
 970   const TargetData *TD = TM.getTargetData();
 971
 972   // Print out module-level global variables here.
 973   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 974        I != E; ++I)
 975     printModuleLevelGV(I);
 976
 977   bool isPPC64 = TD->getPointerSizeInBits() == 64;
 978
 979   // Output stubs for dynamically-linked functions
 980   if (TM.getRelocationModel() == Reloc::PIC_) {
 981     for (std::set<std::string>::iterator i = FnStubs.begin(), e = FnStubs.end();
 982          i != e; ++i) {
 983       SwitchToTextSection("\t.section __TEXT,__picsymbolstub1,symbol_stubs,"
 984                           "pure_instructions,32");
 985       EmitAlignment(4);
 986       std::string p = *i;
 987       std::string L0p = (p[0]=='\"') ? "\"L0$" + p.substr(1) : "L0$" + p ;
 988       printSuffixedName(p, "$stub");
 989       O << ":\n";
 990       O << "\t.indirect_symbol " << *i << '\n';
 991       O << "\tmflr r0\n";
 992       O << "\tbcl 20,31," << L0p << '\n';
 993       O << L0p << ":\n";
 994       O << "\tmflr r11\n";
 995       O << "\taddis r11,r11,ha16(";
 996       printSuffixedName(p, "$lazy_ptr");
 997       O << "-" << L0p << ")\n";
 998       O << "\tmtlr r0\n";
 999       if (isPPC64)
1000         O << "\tldu r12,lo16(";
1001       else
1002         O << "\tlwzu r12,lo16(";
1003       printSuffixedName(p, "$lazy_ptr");
1004       O << "-" << L0p << ")(r11)\n";
1005       O << "\tmtctr r12\n";
1006       O << "\tbctr\n";
1007       SwitchToDataSection(".lazy_symbol_pointer");
1008       printSuffixedName(p, "$lazy_ptr");
1009       O << ":\n";
1010       O << "\t.indirect_symbol " << *i << '\n';
1011       if (isPPC64)
1012         O << "\t.quad dyld_stub_binding_helper\n";
1013       else
1014         O << "\t.long dyld_stub_binding_helper\n";
1015     }
1016   } else {
1017     for (std::set<std::string>::iterator i = FnStubs.begin(), e = FnStubs.end();
1018          i != e; ++i) {
1019       SwitchToTextSection("\t.section __TEXT,__symbol_stub1,symbol_stubs,"
1020                           "pure_instructions,16");
1021       EmitAlignment(4);
1022       std::string p = *i;
1023       printSuffixedName(p, "$stub");
1024       O << ":\n";
1025       O << "\t.indirect_symbol " << *i << '\n';
1026       O << "\tlis r11,ha16(";
1027       printSuffixedName(p, "$lazy_ptr");
1028       O << ")\n";
1029       if (isPPC64)
1030         O << "\tldu r12,lo16(";
1031       else
1032         O << "\tlwzu r12,lo16(";
1033       printSuffixedName(p, "$lazy_ptr");
1034       O << ")(r11)\n";
1035       O << "\tmtctr r12\n";
1036       O << "\tbctr\n";
1037       SwitchToDataSection(".lazy_symbol_pointer");
1038       printSuffixedName(p, "$lazy_ptr");
1039       O << ":\n";
1040       O << "\t.indirect_symbol " << *i << '\n';
1041       if (isPPC64)
1042         O << "\t.quad dyld_stub_binding_helper\n";
1043       else
1044         O << "\t.long dyld_stub_binding_helper\n";
1045     }
1046   }
1047
1048   O << '\n';
1049
1050   if (TAI->doesSupportExceptionHandling() && MMI) {
1051     // Add the (possibly multiple) personalities to the set of global values.
1052     // Only referenced functions get into the Personalities list.
1053     const std::vector<Function *>& Personalities = MMI->getPersonalities();
1054
1055     for (std::vector<Function *>::const_iterator I = Personalities.begin(),
1056            E = Personalities.end(); I != E; ++I)
1057       if (*I) GVStubs.insert("_" + (*I)->getName());
1058   }
1059
1060   // Output stubs for external and common global variables.
1061   if (!GVStubs.empty()) {
1062     SwitchToDataSection(".non_lazy_symbol_pointer");
1063     for (std::set<std::string>::iterator I = GVStubs.begin(),
1064          E = GVStubs.end(); I != E; ++I) {
1065       std::string p = *I;
1066       printSuffixedName(p, "$non_lazy_ptr");
1067       O << ":\n";
1068       O << "\t.indirect_symbol " << *I << '\n';
1069       if (isPPC64)
1070         O << "\t.quad\t0\n";
1071       else
1072         O << "\t.long\t0\n";
1073     }
1074   }
1075
1076   // Emit initial debug information.
1077   DW.EndModule();
1078
1079   // Funny Darwin hack: This flag tells the linker that no global symbols
1080   // contain code that falls through to other global symbols (e.g. the obvious
1081   // implementation of multiple entry points).  If this doesn't occur, the
1082   // linker can safely perform dead code stripping.  Since LLVM never generates
1083   // code that does this, it is always safe to set.
1084   O << "\t.subsections_via_symbols\n";
1085
1086   return AsmPrinter::doFinalization(M);
1087 }
1088
1089
1090
1091 /// createPPCAsmPrinterPass - Returns a pass that prints the PPC assembly code
1092 /// for a MachineFunction to the given output stream, in a format that the
1093 /// Darwin assembler can deal with.
1094 ///
1095 FunctionPass *llvm::createPPCAsmPrinterPass(raw_ostream &o,
1096                                             PPCTargetMachine &tm) {
1097   const PPCSubtarget *Subtarget = &tm.getSubtarget<PPCSubtarget>();
1098
1099   if (Subtarget->isDarwin()) {
1100     return new PPCDarwinAsmPrinter(o, tm, tm.getTargetAsmInfo());
1101   } else {
1102     return new PPCLinuxAsmPrinter(o, tm, tm.getTargetAsmInfo());
1103   }
1104 }
1105
1106 namespace {
1107   static struct Register {
1108     Register() {
1109       PPCTargetMachine::registerAsmPrinter(createPPCAsmPrinterPass);
1110     }
1111   } Registrator;
1112 }