1 //===-- SPUAsmPrinter.cpp - Print machine instrs to Cell SPU assembly -------=//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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'.
14 //===----------------------------------------------------------------------===//
16 #define DEBUG_TYPE "asmprinter"
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"
44 STATISTIC(EmittedInsts, "Number of machine instrs printed");
46 const std::string bss_section(".bss");
48 struct VISIBILITY_HIDDEN SPUAsmPrinter : public AsmPrinter {
49 std::set<std::string> FnStubs, GVStubs;
51 SPUAsmPrinter(raw_ostream &O, TargetMachine &TM, const TargetAsmInfo *T) :
56 virtual const char *getPassName() const {
57 return "STI CBEA SPU Assembly Printer";
60 SPUTargetMachine &getTM() {
61 return static_cast<SPUTargetMachine&>(TM);
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
68 bool printInstruction(const MachineInstr *MI);
70 void printMachineInstruction(const MachineInstr *MI);
71 void printOp(const MachineOperand &MO);
73 /// printRegister - Print register according to target requirements.
75 void printRegister(const MachineOperand &MO, bool R0AsZero) {
76 unsigned RegNo = MO.getReg();
77 assert(TargetRegisterInfo::isPhysicalRegister(RegNo) &&
79 O << TM.getRegisterInfo()->get(RegNo).AsmName;
82 void printOperand(const MachineInstr *MI, unsigned OpNo) {
83 const MachineOperand &MO = MI->getOperand(OpNo);
84 if (MO.isRegister()) {
85 assert(TargetRegisterInfo::isPhysicalRegister(MO.getReg())&&"Not physreg??");
86 O << TM.getRegisterInfo()->get(MO.getReg()).AsmName;
87 } else if (MO.isImmediate()) {
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);
101 printS7ImmOperand(const MachineInstr *MI, unsigned OpNo)
103 int value = MI->getOperand(OpNo).getImm();
104 value = (value << (32 - 7)) >> (32 - 7);
106 assert((value >= -(1 << 8) && value <= (1 << 7) - 1)
107 && "Invalid s7 argument");
112 printU7ImmOperand(const MachineInstr *MI, unsigned OpNo)
114 unsigned int value = MI->getOperand(OpNo).getImm();
115 assert(value < (1 << 8) && "Invalid u7 argument");
120 printMemRegImmS7(const MachineInstr *MI, unsigned OpNo)
122 char value = MI->getOperand(OpNo).getImm();
125 printOperand(MI, OpNo+1);
130 printS16ImmOperand(const MachineInstr *MI, unsigned OpNo)
132 O << (short) MI->getOperand(OpNo).getImm();
136 printU16ImmOperand(const MachineInstr *MI, unsigned OpNo)
138 O << (unsigned short)MI->getOperand(OpNo).getImm();
142 printU32ImmOperand(const MachineInstr *MI, unsigned OpNo)
144 O << (unsigned)MI->getOperand(OpNo).getImm();
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;
155 printOperand(MI, OpNo+1);
159 printU18ImmOperand(const MachineInstr *MI, unsigned OpNo)
161 unsigned int value = MI->getOperand(OpNo).getImm();
162 assert(value <= (1 << 19) - 1 && "Invalid u18 argument");
167 printS10ImmOperand(const MachineInstr *MI, unsigned OpNo)
169 short value = (short) (((int) MI->getOperand(OpNo).getImm() << 16)
171 assert((value >= -(1 << 9) && value <= (1 << 9) - 1)
172 && "Invalid s10 argument");
177 printU10ImmOperand(const MachineInstr *MI, unsigned OpNo)
179 short value = (short) (((int) MI->getOperand(OpNo).getImm() << 16)
181 assert((value <= (1 << 10) - 1) && "Invalid u10 argument");
186 printMemRegImmS10(const MachineInstr *MI, unsigned OpNo)
188 const MachineOperand &MO = MI->getOperand(OpNo);
189 assert(MO.isImmediate()
190 && "printMemRegImmS10 first operand is not immedate");
191 printS10ImmOperand(MI, OpNo);
193 printOperand(MI, OpNo+1);
198 printAddr256K(const MachineInstr *MI, unsigned OpNo)
200 /* Note: operand 1 is an offset or symbol name. */
201 if (MI->getOperand(OpNo).isImmediate()) {
202 printS16ImmOperand(MI, OpNo);
204 printOp(MI->getOperand(OpNo));
205 if (MI->getOperand(OpNo+1).isImmediate()) {
206 int displ = int(MI->getOperand(OpNo+1).getImm());
215 void printCallOperand(const MachineInstr *MI, unsigned OpNo) {
216 printOp(MI->getOperand(OpNo));
219 void printPCRelativeOperand(const MachineInstr *MI, unsigned OpNo) {
220 printOp(MI->getOperand(OpNo));
224 void printSymbolHi(const MachineInstr *MI, unsigned OpNo) {
225 if (MI->getOperand(OpNo).isImmediate()) {
226 printS16ImmOperand(MI, OpNo);
228 printOp(MI->getOperand(OpNo));
233 void printSymbolLo(const MachineInstr *MI, unsigned OpNo) {
234 if (MI->getOperand(OpNo).isImmediate()) {
235 printS16ImmOperand(MI, OpNo);
237 printOp(MI->getOperand(OpNo));
242 /// Print local store address
243 void printSymbolLSA(const MachineInstr *MI, unsigned OpNo) {
244 printOp(MI->getOperand(OpNo));
247 void printROTHNeg7Imm(const MachineInstr *MI, unsigned OpNo) {
248 if (MI->getOperand(OpNo).isImmediate()) {
249 int value = (int) MI->getOperand(OpNo).getImm();
250 assert((value >= 0 && value < 16)
251 && "Invalid negated immediate rotate 7-bit argument");
254 assert(0 &&"Invalid/non-immediate rotate amount in printRotateNeg7Imm");
258 void printROTNeg7Imm(const MachineInstr *MI, unsigned OpNo) {
259 if (MI->getOperand(OpNo).isImmediate()) {
260 int value = (int) MI->getOperand(OpNo).getImm();
261 assert((value >= 0 && value < 32)
262 && "Invalid negated immediate rotate 7-bit argument");
265 assert(0 &&"Invalid/non-immediate rotate amount in printRotateNeg7Imm");
269 virtual bool runOnMachineFunction(MachineFunction &F) = 0;
270 virtual bool doFinalization(Module &M) = 0;
273 /// LinuxAsmPrinter - SPU assembly printer, customized for Linux
274 struct VISIBILITY_HIDDEN LinuxAsmPrinter : public SPUAsmPrinter {
277 MachineModuleInfo *MMI;
279 LinuxAsmPrinter(raw_ostream &O, SPUTargetMachine &TM,
280 const TargetAsmInfo *T) :
281 SPUAsmPrinter(O, TM, T),
286 virtual const char *getPassName() const {
287 return "STI CBEA SPU Assembly Printer";
290 bool runOnMachineFunction(MachineFunction &F);
291 bool doInitialization(Module &M);
292 bool doFinalization(Module &M);
294 void getAnalysisUsage(AnalysisUsage &AU) const {
295 AU.setPreservesAll();
296 AU.addRequired<MachineModuleInfo>();
297 SPUAsmPrinter::getAnalysisUsage(AU);
300 /// getSectionForFunction - Return the section that we should emit the
301 /// specified function body into.
302 virtual std::string getSectionForFunction(const Function &F) const;
304 } // end of anonymous namespace
306 // Include the auto-generated portion of the assembly writer
307 #include "SPUGenAsmWriter.inc"
309 void SPUAsmPrinter::printOp(const MachineOperand &MO) {
310 switch (MO.getType()) {
311 case MachineOperand::MO_Immediate:
312 cerr << "printOp() does not handle immediate values\n";
316 case MachineOperand::MO_MachineBasicBlock:
317 printBasicBlockLabel(MO.getMBB());
319 case MachineOperand::MO_JumpTableIndex:
320 O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
321 << '_' << MO.getIndex();
323 case MachineOperand::MO_ConstantPoolIndex:
324 O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber()
325 << '_' << MO.getIndex();
327 case MachineOperand::MO_ExternalSymbol:
328 // Computing the address of an external symbol, not calling it.
329 if (TM.getRelocationModel() != Reloc::Static) {
330 std::string Name(TAI->getGlobalPrefix()); Name += MO.getSymbolName();
331 GVStubs.insert(Name);
332 O << "L" << Name << "$non_lazy_ptr";
335 O << TAI->getGlobalPrefix() << MO.getSymbolName();
337 case MachineOperand::MO_GlobalAddress: {
338 // Computing the address of a global symbol, not calling it.
339 GlobalValue *GV = MO.getGlobal();
340 std::string Name = Mang->getValueName(GV);
342 // External or weakly linked global variables need non-lazily-resolved
344 if (TM.getRelocationModel() != Reloc::Static) {
345 if (((GV->isDeclaration() || GV->hasWeakLinkage() ||
346 GV->hasLinkOnceLinkage() || GV->hasCommonLinkage()))) {
347 GVStubs.insert(Name);
348 O << "L" << Name << "$non_lazy_ptr";
354 if (GV->hasExternalWeakLinkage())
355 ExtWeakSymbols.insert(GV);
360 O << "<unknown operand type: " << MO.getType() << ">";
365 /// PrintAsmOperand - Print out an operand for an inline asm expression.
367 bool SPUAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
369 const char *ExtraCode) {
370 // Does this asm operand have a single letter operand modifier?
371 if (ExtraCode && ExtraCode[0]) {
372 if (ExtraCode[1] != 0) return true; // Unknown modifier.
374 switch (ExtraCode[0]) {
375 default: return true; // Unknown modifier.
376 case 'L': // Write second word of DImode reference.
377 // Verify that this operand has two consecutive registers.
378 if (!MI->getOperand(OpNo).isRegister() ||
379 OpNo+1 == MI->getNumOperands() ||
380 !MI->getOperand(OpNo+1).isRegister())
382 ++OpNo; // Return the high-part.
387 printOperand(MI, OpNo);
391 bool SPUAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
394 const char *ExtraCode) {
395 if (ExtraCode && ExtraCode[0])
396 return true; // Unknown modifier.
397 printMemRegReg(MI, OpNo);
401 /// printMachineInstruction -- Print out a single PowerPC MI in Darwin syntax
402 /// to the current output stream.
404 void SPUAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
406 printInstruction(MI);
411 std::string LinuxAsmPrinter::getSectionForFunction(const Function &F) const {
412 switch (F.getLinkage()) {
413 default: assert(0 && "Unknown linkage type!");
414 case Function::ExternalLinkage:
415 case Function::InternalLinkage: return TAI->getTextSection();
416 case Function::WeakLinkage:
417 case Function::LinkOnceLinkage:
418 return ""; // Print nothing for the time being...
422 /// runOnMachineFunction - This uses the printMachineInstruction()
423 /// method to print assembly for each instruction.
426 LinuxAsmPrinter::runOnMachineFunction(MachineFunction &MF)
428 SetupMachineFunction(MF);
431 // Print out constants referenced by the function
432 EmitConstantPool(MF.getConstantPool());
434 // Print out labels for the function.
435 const Function *F = MF.getFunction();
437 SwitchToTextSection(getSectionForFunction(*F).c_str(), F);
440 switch (F->getLinkage()) {
441 default: assert(0 && "Unknown linkage type!");
442 case Function::InternalLinkage: // Symbols default to internal.
444 case Function::ExternalLinkage:
445 O << "\t.global\t" << CurrentFnName << "\n"
446 << "\t.type\t" << CurrentFnName << ", @function\n";
448 case Function::WeakLinkage:
449 case Function::LinkOnceLinkage:
450 O << "\t.global\t" << CurrentFnName << "\n";
451 O << "\t.weak_definition\t" << CurrentFnName << "\n";
454 O << CurrentFnName << ":\n";
456 // Emit pre-function debug information.
457 DW.BeginFunction(&MF);
459 // Print out code for the function.
460 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
462 // Print a label for the basic block.
463 if (I != MF.begin()) {
464 printBasicBlockLabel(I, true, true);
467 for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
469 // Print the assembly for the instruction.
470 printMachineInstruction(II);
474 O << "\t.size\t" << CurrentFnName << ",.-" << CurrentFnName << "\n";
476 // Print out jump tables referenced by the function.
477 EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
479 // Emit post-function debug information.
482 // We didn't modify anything.
487 bool LinuxAsmPrinter::doInitialization(Module &M) {
488 bool Result = AsmPrinter::doInitialization(M);
489 SwitchToTextSection("\t.text");
490 // Emit initial debug information.
492 MMI = getAnalysisToUpdate<MachineModuleInfo>();
493 DW.SetModuleInfo(MMI);
497 bool LinuxAsmPrinter::doFinalization(Module &M) {
498 const TargetData *TD = TM.getTargetData();
500 // Print out module-level global variables here.
501 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
503 if (!I->hasInitializer()) continue; // External global require no code
505 // Check to see if this is a special global used by LLVM, if so, emit it.
506 if (EmitSpecialLLVMGlobal(I))
509 std::string name = Mang->getValueName(I);
510 Constant *C = I->getInitializer();
511 unsigned Size = TD->getTypeStoreSize(C->getType());
512 unsigned Align = TD->getPreferredAlignmentLog(I);
514 if (C->isNullValue() && /* FIXME: Verify correct */
515 (I->hasInternalLinkage() || I->hasWeakLinkage() ||
516 I->hasLinkOnceLinkage() || I->hasCommonLinkage() ||
517 (I->hasExternalLinkage() && !I->hasSection()))) {
518 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
519 if (I->hasExternalLinkage()) {
520 // External linkage globals -> .bss section
521 // FIXME: Want to set the global variable's section so that
522 // SwitchToDataSection emits the ".section" directive
523 SwitchToDataSection("\t.section\t.bss", I);
524 O << "\t.global\t" << name << '\n';
525 O << "\t.align\t" << Align << '\n';
526 O << "\t.type\t" << name << ", @object\n";
527 O << "\t.size\t" << name << ", " << Size << '\n';
529 O << "\t.zero\t" << Size;
530 } else if (I->hasInternalLinkage()) {
531 SwitchToDataSection("\t.data", I);
532 O << ".local " << name << "\n";
533 O << TAI->getCOMMDirective() << name << "," << Size << "," << Align << "\n";
535 SwitchToDataSection("\t.data", I);
536 O << ".comm " << name << "," << Size;
538 O << "\t\t# '" << I->getName() << "'\n";
540 switch (I->getLinkage()) {
541 case GlobalValue::LinkOnceLinkage:
542 case GlobalValue::WeakLinkage:
543 case GlobalValue::CommonLinkage:
544 O << "\t.global " << name << '\n'
545 << "\t.weak_definition " << name << '\n';
546 SwitchToDataSection(".section __DATA,__datacoal_nt,coalesced", I);
548 case GlobalValue::AppendingLinkage:
549 // FIXME: appending linkage variables should go into a section of
550 // their name or something. For now, just emit them as external.
551 case GlobalValue::ExternalLinkage:
552 // If external or appending, declare as a global symbol
553 O << "\t.global " << name << "\n";
555 case GlobalValue::InternalLinkage:
556 if (I->isConstant()) {
557 const ConstantArray *CVA = dyn_cast<ConstantArray>(C);
558 if (TAI->getCStringSection() && CVA && CVA->isCString()) {
559 SwitchToDataSection("\t.cstring", I);
564 SwitchToDataSection("\t.data", I);
567 cerr << "Unknown linkage type!";
571 EmitAlignment(Align, I);
572 O << name << ":\t\t\t\t# '" << I->getName() << "'\n";
574 // If the initializer is a extern weak symbol, remember to emit the weak
576 if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
577 if (GV->hasExternalWeakLinkage())
578 ExtWeakSymbols.insert(GV);
580 EmitGlobalConstant(C);
585 // Output stubs for dynamically-linked functions
586 if (TM.getRelocationModel() == Reloc::PIC_) {
587 for (std::set<std::string>::iterator i = FnStubs.begin(), e = FnStubs.end();
589 SwitchToTextSection(".section __TEXT,__picsymbolstub1,symbol_stubs,"
590 "pure_instructions,32");
592 O << "L" << *i << "$stub:\n";
593 O << "\t.indirect_symbol " << *i << "\n";
595 O << "\tbcl 20,31,L0$" << *i << "\n";
596 O << "L0$" << *i << ":\n";
598 O << "\taddis r11,r11,ha16(L" << *i << "$lazy_ptr-L0$" << *i << ")\n";
600 O << "\tlwzu r12,lo16(L" << *i << "$lazy_ptr-L0$" << *i << ")(r11)\n";
601 O << "\tmtctr r12\n";
603 SwitchToDataSection(".lazy_symbol_pointer");
604 O << "L" << *i << "$lazy_ptr:\n";
605 O << "\t.indirect_symbol " << *i << "\n";
606 O << "\t.long dyld_stub_binding_helper\n";
609 for (std::set<std::string>::iterator i = FnStubs.begin(), e = FnStubs.end();
611 SwitchToTextSection(".section __TEXT,__symbol_stub1,symbol_stubs,"
612 "pure_instructions,16");
614 O << "L" << *i << "$stub:\n";
615 O << "\t.indirect_symbol " << *i << "\n";
616 O << "\tlis r11,ha16(L" << *i << "$lazy_ptr)\n";
617 O << "\tlwzu r12,lo16(L" << *i << "$lazy_ptr)(r11)\n";
618 O << "\tmtctr r12\n";
620 SwitchToDataSection(".lazy_symbol_pointer");
621 O << "L" << *i << "$lazy_ptr:\n";
622 O << "\t.indirect_symbol " << *i << "\n";
623 O << "\t.long dyld_stub_binding_helper\n";
629 // Output stubs for external and common global variables.
630 if (GVStubs.begin() != GVStubs.end()) {
631 SwitchToDataSection(".non_lazy_symbol_pointer");
632 for (std::set<std::string>::iterator I = GVStubs.begin(),
633 E = GVStubs.end(); I != E; ++I) {
634 O << "L" << *I << "$non_lazy_ptr:\n";
635 O << "\t.indirect_symbol " << *I << "\n";
640 // Emit initial debug information.
643 // Emit ident information
644 O << "\t.ident\t\"(llvm 2.2+) STI CBEA Cell SPU backend\"\n";
646 return AsmPrinter::doFinalization(M);
651 /// createSPUCodePrinterPass - Returns a pass that prints the Cell SPU
652 /// assembly code for a MachineFunction to the given output stream, in a format
653 /// that the Linux SPU assembler can deal with.
655 FunctionPass *llvm::createSPUAsmPrinterPass(raw_ostream &o,
656 SPUTargetMachine &tm) {
657 return new LinuxAsmPrinter(o, tm, tm.getTargetAsmInfo());