lib/Target/CellSPU/AsmPrinter/SPUAsmPrinter.cpp

   1 //===-- SPUAsmPrinter.cpp - Print machine instrs to Cell SPU 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 Cell SPU assembly language. This printer
  12 // is the output mechanism used by `llc'.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #define DEBUG_TYPE "asmprinter"
  17 #include "SPU.h"
  18 #include "SPUTargetMachine.h"
  19 #include "llvm/Constants.h"
  20 #include "llvm/DerivedTypes.h"
  21 #include "llvm/Module.h"
  22 #include "llvm/Assembly/Writer.h"
  23 #include "llvm/CodeGen/AsmPrinter.h"
  24 #include "llvm/CodeGen/DwarfWriter.h"
  25 #include "llvm/CodeGen/MachineModuleInfo.h"
  26 #include "llvm/CodeGen/MachineFunctionPass.h"
  27 #include "llvm/CodeGen/MachineInstr.h"
  28 #include "llvm/Support/Mangler.h"
  29 #include "llvm/Support/MathExtras.h"
  30 #include "llvm/Support/CommandLine.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/Support/Compiler.h"
  33 #include "llvm/Support/raw_ostream.h"
  34 #include "llvm/Target/TargetAsmInfo.h"
  35 #include "llvm/Target/TargetRegisterInfo.h"
  36 #include "llvm/Target/TargetInstrInfo.h"
  37 #include "llvm/Target/TargetOptions.h"
  38 #include "llvm/ADT/Statistic.h"
  39 #include "llvm/ADT/StringExtras.h"
  40 #include <set>
  41 using namespace llvm;
  42
  43 namespace {
  44   STATISTIC(EmittedInsts, "Number of machine instrs printed");
  45
  46   const std::string bss_section(".bss");
  47
  48   struct VISIBILITY_HIDDEN SPUAsmPrinter : public AsmPrinter {
  49     std::set<std::string> FnStubs, GVStubs;
  50
  51     SPUAsmPrinter(raw_ostream &O, TargetMachine &TM, const TargetAsmInfo *T) :
  52       AsmPrinter(O, TM, T)
  53     {
  54     }
  55
  56     virtual const char *getPassName() const {
  57       return "STI CBEA SPU Assembly Printer";
  58     }
  59
  60     SPUTargetMachine &getTM() {
  61       return static_cast<SPUTargetMachine&>(TM);
  62     }
  63
  64     /// printInstruction - This method is automatically generated by tablegen
  65     /// from the instruction set description.  This method returns true if the
  66     /// machine instruction was sufficiently described to print it, otherwise it
  67     /// returns false.
  68     bool printInstruction(const MachineInstr *MI);
  69
  70     void printMachineInstruction(const MachineInstr *MI);
  71     void printOp(const MachineOperand &MO);
  72
  73     /// printRegister - Print register according to target requirements.
  74     ///
  75     void printRegister(const MachineOperand &MO, bool R0AsZero) {
  76       unsigned RegNo = MO.getReg();
  77       assert(TargetRegisterInfo::isPhysicalRegister(RegNo) &&
  78              "Not physreg??");
  79       O << TM.getRegisterInfo()->get(RegNo).AsmName;
  80     }
  81
  82     void printOperand(const MachineInstr *MI, unsigned OpNo) {
  83       const MachineOperand &MO = MI->getOperand(OpNo);
  84       if (MO.isReg()) {
  85         assert(TargetRegisterInfo::isPhysicalRegister(MO.getReg())&&"Not physreg??");
  86         O << TM.getRegisterInfo()->get(MO.getReg()).AsmName;
  87       } else if (MO.isImm()) {
  88         O << MO.getImm();
  89       } else {
  90         printOp(MO);
  91       }
  92     }
  93
  94     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  95                          unsigned AsmVariant, const char *ExtraCode);
  96     bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
  97                                unsigned AsmVariant, const char *ExtraCode);
  98
  99
 100     void
 101     printS7ImmOperand(const MachineInstr *MI, unsigned OpNo)
 102     {
 103       int value = MI->getOperand(OpNo).getImm();
 104       value = (value << (32 - 7)) >> (32 - 7);
 105
 106       assert((value >= -(1 << 8) && value <= (1 << 7) - 1)
 107              && "Invalid s7 argument");
 108       O << value;
 109     }
 110
 111     void
 112     printU7ImmOperand(const MachineInstr *MI, unsigned OpNo)
 113     {
 114       unsigned int value = MI->getOperand(OpNo).getImm();
 115       assert(value < (1 << 8) && "Invalid u7 argument");
 116       O << value;
 117     }
 118
 119     void
 120     printShufAddr(const MachineInstr *MI, unsigned OpNo)
 121     {
 122       char value = MI->getOperand(OpNo).getImm();
 123       O << (int) value;
 124       O << "(";
 125       printOperand(MI, OpNo+1);
 126       O << ")";
 127     }
 128
 129     void
 130     printS16ImmOperand(const MachineInstr *MI, unsigned OpNo)
 131     {
 132       O << (short) MI->getOperand(OpNo).getImm();
 133     }
 134
 135     void
 136     printU16ImmOperand(const MachineInstr *MI, unsigned OpNo)
 137     {
 138       O << (unsigned short)MI->getOperand(OpNo).getImm();
 139     }
 140
 141     void
 142     printU32ImmOperand(const MachineInstr *MI, unsigned OpNo)
 143     {
 144       O << (unsigned)MI->getOperand(OpNo).getImm();
 145     }
 146
 147     void
 148     printMemRegReg(const MachineInstr *MI, unsigned OpNo) {
 149       // When used as the base register, r0 reads constant zero rather than
 150       // the value contained in the register.  For this reason, the darwin
 151       // assembler requires that we print r0 as 0 (no r) when used as the base.
 152       const MachineOperand &MO = MI->getOperand(OpNo);
 153       O << TM.getRegisterInfo()->get(MO.getReg()).AsmName;
 154       O << ", ";
 155       printOperand(MI, OpNo+1);
 156     }
 157
 158     void
 159     printU18ImmOperand(const MachineInstr *MI, unsigned OpNo)
 160     {
 161       unsigned int value = MI->getOperand(OpNo).getImm();
 162       assert(value <= (1 << 19) - 1 && "Invalid u18 argument");
 163       O << value;
 164     }
 165
 166     void
 167     printS10ImmOperand(const MachineInstr *MI, unsigned OpNo)
 168     {
 169       short value = (short) (((int) MI->getOperand(OpNo).getImm() << 16)
 170                              >> 16);
 171       assert((value >= -(1 << 9) && value <= (1 << 9) - 1)
 172              && "Invalid s10 argument");
 173       O << value;
 174     }
 175
 176     void
 177     printU10ImmOperand(const MachineInstr *MI, unsigned OpNo)
 178     {
 179       short value = (short) (((int) MI->getOperand(OpNo).getImm() << 16)
 180                              >> 16);
 181       assert((value <= (1 << 10) - 1) && "Invalid u10 argument");
 182       O << value;
 183     }
 184
 185     void
 186     printDFormAddr(const MachineInstr *MI, unsigned OpNo)
 187     {
 188       const MachineOperand &MO = MI->getOperand(OpNo);
 189       assert(MO.isImm() &&
 190              "printDFormAddr first operand is not immedate");
 191       int64_t value = int64_t(MI->getOperand(OpNo).getImm());
 192       int16_t value16 = int16_t(value);
 193       assert((value16 >= -(1 << (9+4)) && value16 <= (1 << (9+4)) - 1)
 194              && "Invalid dform s10 offset argument");
 195       O << (value16 & ~0xf) << "(";
 196       printOperand(MI, OpNo+1);
 197       O << ")";
 198     }
 199
 200     void
 201     printAddr256K(const MachineInstr *MI, unsigned OpNo)
 202     {
 203       /* Note: operand 1 is an offset or symbol name. */
 204       if (MI->getOperand(OpNo).isImm()) {
 205         printS16ImmOperand(MI, OpNo);
 206       } else {
 207         printOp(MI->getOperand(OpNo));
 208         if (MI->getOperand(OpNo+1).isImm()) {
 209           int displ = int(MI->getOperand(OpNo+1).getImm());
 210           if (displ > 0)
 211             O << "+" << displ;
 212           else if (displ < 0)
 213             O << displ;
 214         }
 215       }
 216     }
 217
 218     void printCallOperand(const MachineInstr *MI, unsigned OpNo) {
 219       printOp(MI->getOperand(OpNo));
 220     }
 221
 222     void printPCRelativeOperand(const MachineInstr *MI, unsigned OpNo) {
 223       // Used to generate a ".-<target>", but it turns out that the assembler
 224       // really wants the target.
 225       //
 226       // N.B.: This operand is used for call targets. Branch hints are another
 227       // animal entirely.
 228       printOp(MI->getOperand(OpNo));
 229     }
 230
 231     void printHBROperand(const MachineInstr *MI, unsigned OpNo) {
 232       // HBR operands are generated in front of branches, hence, the
 233       // program counter plus the target.
 234       O << ".+";
 235       printOp(MI->getOperand(OpNo));
 236     }
 237
 238     void printSymbolHi(const MachineInstr *MI, unsigned OpNo) {
 239       if (MI->getOperand(OpNo).isImm()) {
 240         printS16ImmOperand(MI, OpNo);
 241       } else {
 242         printOp(MI->getOperand(OpNo));
 243         O << "@h";
 244       }
 245     }
 246
 247     void printSymbolLo(const MachineInstr *MI, unsigned OpNo) {
 248       if (MI->getOperand(OpNo).isImm()) {
 249         printS16ImmOperand(MI, OpNo);
 250       } else {
 251         printOp(MI->getOperand(OpNo));
 252         O << "@l";
 253       }
 254     }
 255
 256     /// Print local store address
 257     void printSymbolLSA(const MachineInstr *MI, unsigned OpNo) {
 258       printOp(MI->getOperand(OpNo));
 259     }
 260
 261     void printROTHNeg7Imm(const MachineInstr *MI, unsigned OpNo) {
 262       if (MI->getOperand(OpNo).isImm()) {
 263         int value = (int) MI->getOperand(OpNo).getImm();
 264         assert((value >= 0 && value < 16)
 265                && "Invalid negated immediate rotate 7-bit argument");
 266         O << -value;
 267       } else {
 268         assert(0 &&"Invalid/non-immediate rotate amount in printRotateNeg7Imm");
 269       }
 270     }
 271
 272     void printROTNeg7Imm(const MachineInstr *MI, unsigned OpNo) {
 273       if (MI->getOperand(OpNo).isImm()) {
 274         int value = (int) MI->getOperand(OpNo).getImm();
 275         assert((value >= 0 && value <= 32)
 276                && "Invalid negated immediate rotate 7-bit argument");
 277         O << -value;
 278       } else {
 279         assert(0 &&"Invalid/non-immediate rotate amount in printRotateNeg7Imm");
 280       }
 281     }
 282
 283     virtual bool runOnMachineFunction(MachineFunction &F) = 0;
 284     //! Assembly printer cleanup after function has been emitted
 285     virtual bool doFinalization(Module &M) = 0;
 286   };
 287
 288   /// LinuxAsmPrinter - SPU assembly printer, customized for Linux
 289   struct VISIBILITY_HIDDEN LinuxAsmPrinter : public SPUAsmPrinter {
 290
 291     DwarfWriter DW;
 292     MachineModuleInfo *MMI;
 293
 294     LinuxAsmPrinter(raw_ostream &O, SPUTargetMachine &TM,
 295                     const TargetAsmInfo *T) :
 296       SPUAsmPrinter(O, TM, T),
 297       DW(O, this, T),
 298       MMI(0)
 299     { }
 300
 301     virtual const char *getPassName() const {
 302       return "STI CBEA SPU Assembly Printer";
 303     }
 304
 305     bool runOnMachineFunction(MachineFunction &F);
 306     bool doInitialization(Module &M);
 307     //! Dump globals, perform cleanup after function emission
 308     bool doFinalization(Module &M);
 309
 310     void getAnalysisUsage(AnalysisUsage &AU) const {
 311       AU.setPreservesAll();
 312       AU.addRequired<MachineModuleInfo>();
 313       SPUAsmPrinter::getAnalysisUsage(AU);
 314     }
 315
 316     //! Emit a global variable according to its section and type
 317     void printModuleLevelGV(const GlobalVariable* GVar);
 318   };
 319 } // end of anonymous namespace
 320
 321 // Include the auto-generated portion of the assembly writer
 322 #include "SPUGenAsmWriter.inc"
 323
 324 void SPUAsmPrinter::printOp(const MachineOperand &MO) {
 325   switch (MO.getType()) {
 326   case MachineOperand::MO_Immediate:
 327     cerr << "printOp() does not handle immediate values\n";
 328     abort();
 329     return;
 330
 331   case MachineOperand::MO_MachineBasicBlock:
 332     printBasicBlockLabel(MO.getMBB());
 333     return;
 334   case MachineOperand::MO_JumpTableIndex:
 335     O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 336       << '_' << MO.getIndex();
 337     return;
 338   case MachineOperand::MO_ConstantPoolIndex:
 339     O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber()
 340       << '_' << MO.getIndex();
 341     return;
 342   case MachineOperand::MO_ExternalSymbol:
 343     // Computing the address of an external symbol, not calling it.
 344     if (TM.getRelocationModel() != Reloc::Static) {
 345       std::string Name(TAI->getGlobalPrefix()); Name += MO.getSymbolName();
 346       GVStubs.insert(Name);
 347       O << "L" << Name << "$non_lazy_ptr";
 348       return;
 349     }
 350     O << TAI->getGlobalPrefix() << MO.getSymbolName();
 351     return;
 352   case MachineOperand::MO_GlobalAddress: {
 353     // Computing the address of a global symbol, not calling it.
 354     GlobalValue *GV = MO.getGlobal();
 355     std::string Name = Mang->getValueName(GV);
 356
 357     // External or weakly linked global variables need non-lazily-resolved
 358     // stubs
 359     if (TM.getRelocationModel() != Reloc::Static) {
 360       if (((GV->isDeclaration() || GV->hasWeakLinkage() ||
 361             GV->hasLinkOnceLinkage() || GV->hasCommonLinkage()))) {
 362         GVStubs.insert(Name);
 363         O << "L" << Name << "$non_lazy_ptr";
 364         return;
 365       }
 366     }
 367     O << Name;
 368
 369     if (GV->hasExternalWeakLinkage())
 370       ExtWeakSymbols.insert(GV);
 371     return;
 372   }
 373
 374   default:
 375     O << "<unknown operand type: " << MO.getType() << ">";
 376     return;
 377   }
 378 }
 379
 380 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 381 ///
 382 bool SPUAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 383                                     unsigned AsmVariant,
 384                                     const char *ExtraCode) {
 385   // Does this asm operand have a single letter operand modifier?
 386   if (ExtraCode && ExtraCode[0]) {
 387     if (ExtraCode[1] != 0) return true; // Unknown modifier.
 388
 389     switch (ExtraCode[0]) {
 390     default: return true;  // Unknown modifier.
 391     case 'L': // Write second word of DImode reference.
 392       // Verify that this operand has two consecutive registers.
 393       if (!MI->getOperand(OpNo).isReg() ||
 394           OpNo+1 == MI->getNumOperands() ||
 395           !MI->getOperand(OpNo+1).isReg())
 396         return true;
 397       ++OpNo;   // Return the high-part.
 398       break;
 399     }
 400   }
 401
 402   printOperand(MI, OpNo);
 403   return false;
 404 }
 405
 406 bool SPUAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 407                                           unsigned OpNo,
 408                                           unsigned AsmVariant,
 409                                           const char *ExtraCode) {
 410   if (ExtraCode && ExtraCode[0])
 411     return true; // Unknown modifier.
 412   printMemRegReg(MI, OpNo);
 413   return false;
 414 }
 415
 416 /// printMachineInstruction -- Print out a single PowerPC MI in Darwin syntax
 417 /// to the current output stream.
 418 ///
 419 void SPUAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
 420   ++EmittedInsts;
 421   printInstruction(MI);
 422 }
 423
 424 /// runOnMachineFunction - This uses the printMachineInstruction()
 425 /// method to print assembly for each instruction.
 426 ///
 427 bool
 428 LinuxAsmPrinter::runOnMachineFunction(MachineFunction &MF)
 429 {
 430   SetupMachineFunction(MF);
 431   O << "\n\n";
 432
 433   // Print out constants referenced by the function
 434   EmitConstantPool(MF.getConstantPool());
 435
 436   // Print out labels for the function.
 437   const Function *F = MF.getFunction();
 438
 439   SwitchToSection(TAI->SectionForGlobal(F));
 440   EmitAlignment(3, F);
 441
 442   switch (F->getLinkage()) {
 443   default: assert(0 && "Unknown linkage type!");
 444   case Function::InternalLinkage:  // Symbols default to internal.
 445     break;
 446   case Function::ExternalLinkage:
 447     O << "\t.global\t" << CurrentFnName << "\n"
 448       << "\t.type\t" << CurrentFnName << ", @function\n";
 449     break;
 450   case Function::WeakLinkage:
 451   case Function::LinkOnceLinkage:
 452     O << "\t.global\t" << CurrentFnName << "\n";
 453     O << "\t.weak_definition\t" << CurrentFnName << "\n";
 454     break;
 455   }
 456   O << CurrentFnName << ":\n";
 457
 458   // Emit pre-function debug information.
 459   DW.BeginFunction(&MF);
 460
 461   // Print out code for the function.
 462   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 463        I != E; ++I) {
 464     // Print a label for the basic block.
 465     if (I != MF.begin()) {
 466       printBasicBlockLabel(I, true, true);
 467       O << '\n';
 468     }
 469     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 470          II != E; ++II) {
 471       // Print the assembly for the instruction.
 472       printMachineInstruction(II);
 473     }
 474   }
 475
 476   O << "\t.size\t" << CurrentFnName << ",.-" << CurrentFnName << "\n";
 477
 478   // Print out jump tables referenced by the function.
 479   EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
 480
 481   // Emit post-function debug information.
 482   DW.EndFunction(&MF);
 483
 484   // We didn't modify anything.
 485   return false;
 486 }
 487
 488
 489 bool LinuxAsmPrinter::doInitialization(Module &M) {
 490   bool Result = AsmPrinter::doInitialization(M);
 491   SwitchToTextSection("\t.text");
 492   // Emit initial debug information.
 493   DW.BeginModule(&M);
 494   MMI = getAnalysisToUpdate<MachineModuleInfo>();
 495   DW.SetModuleInfo(MMI);
 496   return Result;
 497 }
 498
 499 /// PrintUnmangledNameSafely - Print out the printable characters in the name.
 500 /// Don't print things like \n or \0.
 501 static void PrintUnmangledNameSafely(const Value *V, raw_ostream &OS) {
 502   for (const char *Name = V->getNameStart(), *E = Name+V->getNameLen();
 503        Name != E; ++Name)
 504     if (isprint(*Name))
 505       OS << *Name;
 506 }
 507
 508 /*!
 509   Emit a global variable according to its section, alignment, etc.
 510
 511   \note This code was shamelessly copied from the PowerPC's assembly printer,
 512   which sort of screams for some kind of refactorization of common code.
 513  */
 514 void LinuxAsmPrinter::printModuleLevelGV(const GlobalVariable* GVar) {
 515   const TargetData *TD = TM.getTargetData();
 516
 517   if (!GVar->hasInitializer())
 518     return;
 519
 520   // Check to see if this is a special global used by LLVM, if so, emit it.
 521   if (EmitSpecialLLVMGlobal(GVar))
 522     return;
 523
 524   std::string name = Mang->getValueName(GVar);
 525
 526   printVisibility(name, GVar->getVisibility());
 527
 528   Constant *C = GVar->getInitializer();
 529   const Type *Type = C->getType();
 530   unsigned Size = TD->getABITypeSize(Type);
 531   unsigned Align = TD->getPreferredAlignmentLog(GVar);
 532
 533   SwitchToSection(TAI->SectionForGlobal(GVar));
 534
 535   if (C->isNullValue() && /* FIXME: Verify correct */
 536       !GVar->hasSection() &&
 537       (GVar->hasInternalLinkage() || GVar->hasExternalLinkage() ||
 538        GVar->mayBeOverridden())) {
 539       if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
 540
 541       if (GVar->hasExternalLinkage()) {
 542         O << "\t.global " << name << '\n';
 543         O << "\t.type " << name << ", @object\n";
 544         O << name << ":\n";
 545         O << "\t.zero " << Size << '\n';
 546       } else if (GVar->hasInternalLinkage()) {
 547         O << TAI->getLCOMMDirective() << name << ',' << Size;
 548       } else {
 549         O << ".comm " << name << ',' << Size;
 550       }
 551       O << "\t\t" << TAI->getCommentString() << " '";
 552       PrintUnmangledNameSafely(GVar, O);
 553       O << "'\n";
 554       return;
 555   }
 556
 557   switch (GVar->getLinkage()) {
 558     // Should never be seen for the CellSPU platform...
 559    case GlobalValue::LinkOnceLinkage:
 560    case GlobalValue::WeakLinkage:
 561    case GlobalValue::CommonLinkage:
 562     O << "\t.global " << name << '\n'
 563       << "\t.type " << name << ", @object\n"
 564       << "\t.weak " << name << '\n';
 565     break;
 566    case GlobalValue::AppendingLinkage:
 567     // FIXME: appending linkage variables should go into a section of
 568     // their name or something.  For now, just emit them as external.
 569    case GlobalValue::ExternalLinkage:
 570     // If external or appending, declare as a global symbol
 571     O << "\t.global " << name << '\n'
 572       << "\t.type " << name << ", @object\n";
 573     // FALL THROUGH
 574    case GlobalValue::InternalLinkage:
 575     break;
 576    default:
 577     cerr << "Unknown linkage type!";
 578     abort();
 579   }
 580
 581   EmitAlignment(Align, GVar);
 582   O << name << ":\t\t\t\t" << TAI->getCommentString() << " '";
 583   PrintUnmangledNameSafely(GVar, O);
 584   O << "'\n";
 585
 586   // If the initializer is a extern weak symbol, remember to emit the weak
 587   // reference!
 588   if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
 589     if (GV->hasExternalWeakLinkage())
 590       ExtWeakSymbols.insert(GV);
 591
 592   EmitGlobalConstant(C);
 593   O << '\n';
 594 }
 595
 596 bool LinuxAsmPrinter::doFinalization(Module &M) {
 597   // Print out module-level global variables here.
 598   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 599        I != E; ++I)
 600     printModuleLevelGV(I);
 601
 602   // TODO
 603
 604   // Emit initial debug information.
 605   DW.EndModule();
 606
 607   return AsmPrinter::doFinalization(M);
 608 }
 609
 610 /// createSPUCodePrinterPass - Returns a pass that prints the Cell SPU
 611 /// assembly code for a MachineFunction to the given output stream, in a format
 612 /// that the Linux SPU assembler can deal with.
 613 ///
 614 FunctionPass *llvm::createSPUAsmPrinterPass(raw_ostream &o,
 615                                             SPUTargetMachine &tm) {
 616   return new LinuxAsmPrinter(o, tm, tm.getTargetAsmInfo());
 617 }
 618