lib/Target/PowerPC/PPCAsmPrinter.cpp

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