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);
85 assert(TargetRegisterInfo::isPhysicalRegister(MO.getReg())&&"Not physreg??");
86 O << TM.getRegisterInfo()->get(MO.getReg()).AsmName;
87 } else if (MO.isImm()) {
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 printShufAddr(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 printDFormAddr(const MachineInstr *MI, unsigned OpNo)
188 assert(MI->getOperand(OpNo).isImm() &&
189 "printDFormAddr first operand is not immediate");
190 int64_t value = int64_t(MI->getOperand(OpNo).getImm());
191 int16_t value16 = int16_t(value);
192 assert((value16 >= -(1 << (9+4)) && value16 <= (1 << (9+4)) - 1)
193 && "Invalid dform s10 offset argument");
194 O << (value16 & ~0xf) << "(";
195 printOperand(MI, OpNo+1);
200 printAddr256K(const MachineInstr *MI, unsigned OpNo)
202 /* Note: operand 1 is an offset or symbol name. */
203 if (MI->getOperand(OpNo).isImm()) {
204 printS16ImmOperand(MI, OpNo);
206 printOp(MI->getOperand(OpNo));
207 if (MI->getOperand(OpNo+1).isImm()) {
208 int displ = int(MI->getOperand(OpNo+1).getImm());
217 void printCallOperand(const MachineInstr *MI, unsigned OpNo) {
218 printOp(MI->getOperand(OpNo));
221 void printPCRelativeOperand(const MachineInstr *MI, unsigned OpNo) {
222 // Used to generate a ".-<target>", but it turns out that the assembler
223 // really wants the target.
225 // N.B.: This operand is used for call targets. Branch hints are another
227 printOp(MI->getOperand(OpNo));
230 void printHBROperand(const MachineInstr *MI, unsigned OpNo) {
231 // HBR operands are generated in front of branches, hence, the
232 // program counter plus the target.
234 printOp(MI->getOperand(OpNo));
237 void printSymbolHi(const MachineInstr *MI, unsigned OpNo) {
238 if (MI->getOperand(OpNo).isImm()) {
239 printS16ImmOperand(MI, OpNo);
241 printOp(MI->getOperand(OpNo));
246 void printSymbolLo(const MachineInstr *MI, unsigned OpNo) {
247 if (MI->getOperand(OpNo).isImm()) {
248 printS16ImmOperand(MI, OpNo);
250 printOp(MI->getOperand(OpNo));
255 /// Print local store address
256 void printSymbolLSA(const MachineInstr *MI, unsigned OpNo) {
257 printOp(MI->getOperand(OpNo));
260 void printROTHNeg7Imm(const MachineInstr *MI, unsigned OpNo) {
261 if (MI->getOperand(OpNo).isImm()) {
262 int value = (int) MI->getOperand(OpNo).getImm();
263 assert((value >= 0 && value < 16)
264 && "Invalid negated immediate rotate 7-bit argument");
267 assert(0 &&"Invalid/non-immediate rotate amount in printRotateNeg7Imm");
271 void printROTNeg7Imm(const MachineInstr *MI, unsigned OpNo) {
272 if (MI->getOperand(OpNo).isImm()) {
273 int value = (int) MI->getOperand(OpNo).getImm();
274 assert((value >= 0 && value <= 32)
275 && "Invalid negated immediate rotate 7-bit argument");
278 assert(0 &&"Invalid/non-immediate rotate amount in printRotateNeg7Imm");
282 virtual bool runOnMachineFunction(MachineFunction &F) = 0;
283 //! Assembly printer cleanup after function has been emitted
284 virtual bool doFinalization(Module &M) = 0;
287 /// LinuxAsmPrinter - SPU assembly printer, customized for Linux
288 struct VISIBILITY_HIDDEN LinuxAsmPrinter : public SPUAsmPrinter {
291 MachineModuleInfo *MMI;
293 LinuxAsmPrinter(raw_ostream &O, SPUTargetMachine &TM,
294 const TargetAsmInfo *T) :
295 SPUAsmPrinter(O, TM, T),
300 virtual const char *getPassName() const {
301 return "STI CBEA SPU Assembly Printer";
304 bool runOnMachineFunction(MachineFunction &F);
305 bool doInitialization(Module &M);
306 //! Dump globals, perform cleanup after function emission
307 bool doFinalization(Module &M);
309 void getAnalysisUsage(AnalysisUsage &AU) const {
310 AU.setPreservesAll();
311 AU.addRequired<MachineModuleInfo>();
312 AU.addRequired<DwarfWriter>();
313 SPUAsmPrinter::getAnalysisUsage(AU);
316 //! Emit a global variable according to its section and type
317 void printModuleLevelGV(const GlobalVariable* GVar);
319 } // end of anonymous namespace
321 // Include the auto-generated portion of the assembly writer
322 #include "SPUGenAsmWriter.inc"
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";
331 case MachineOperand::MO_MachineBasicBlock:
332 printBasicBlockLabel(MO.getMBB());
334 case MachineOperand::MO_JumpTableIndex:
335 O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
336 << '_' << MO.getIndex();
338 case MachineOperand::MO_ConstantPoolIndex:
339 O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber()
340 << '_' << MO.getIndex();
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";
350 O << TAI->getGlobalPrefix() << MO.getSymbolName();
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);
357 // External or weakly linked global variables need non-lazily-resolved
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";
369 if (GV->hasExternalWeakLinkage())
370 ExtWeakSymbols.insert(GV);
375 O << "<unknown operand type: " << MO.getType() << ">";
380 /// PrintAsmOperand - Print out an operand for an inline asm expression.
382 bool SPUAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
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.
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())
397 ++OpNo; // Return the high-part.
402 printOperand(MI, OpNo);
406 bool SPUAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
409 const char *ExtraCode) {
410 if (ExtraCode && ExtraCode[0])
411 return true; // Unknown modifier.
412 printMemRegReg(MI, OpNo);
416 /// printMachineInstruction -- Print out a single PowerPC MI in Darwin syntax
417 /// to the current output stream.
419 void SPUAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
421 printInstruction(MI);
424 /// runOnMachineFunction - This uses the printMachineInstruction()
425 /// method to print assembly for each instruction.
428 LinuxAsmPrinter::runOnMachineFunction(MachineFunction &MF)
430 SetupMachineFunction(MF);
433 // Print out constants referenced by the function
434 EmitConstantPool(MF.getConstantPool());
436 // Print out labels for the function.
437 const Function *F = MF.getFunction();
439 SwitchToSection(TAI->SectionForGlobal(F));
442 switch (F->getLinkage()) {
443 default: assert(0 && "Unknown linkage type!");
444 case Function::PrivateLinkage:
445 case Function::InternalLinkage: // Symbols default to internal.
447 case Function::ExternalLinkage:
448 O << "\t.global\t" << CurrentFnName << "\n"
449 << "\t.type\t" << CurrentFnName << ", @function\n";
451 case Function::WeakLinkage:
452 case Function::LinkOnceLinkage:
453 O << "\t.global\t" << CurrentFnName << "\n";
454 O << "\t.weak_definition\t" << CurrentFnName << "\n";
457 O << CurrentFnName << ":\n";
459 // Emit pre-function debug information.
460 DW->BeginFunction(&MF);
462 // Print out code for the function.
463 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
465 // Print a label for the basic block.
466 if (I != MF.begin()) {
467 printBasicBlockLabel(I, true, true);
470 for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
472 // Print the assembly for the instruction.
473 printMachineInstruction(II);
477 O << "\t.size\t" << CurrentFnName << ",.-" << CurrentFnName << "\n";
479 // Print out jump tables referenced by the function.
480 EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
482 // Emit post-function debug information.
483 DW->EndFunction(&MF);
485 // We didn't modify anything.
490 bool LinuxAsmPrinter::doInitialization(Module &M) {
491 bool Result = AsmPrinter::doInitialization(M);
492 SwitchToTextSection("\t.text");
493 // Emit initial debug information.
494 DW = getAnalysisIfAvailable<DwarfWriter>();
495 assert(DW && "Dwarf Writer is not available");
496 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
497 DW->BeginModule(&M, MMI, O, this, TAI);
501 /// PrintUnmangledNameSafely - Print out the printable characters in the name.
502 /// Don't print things like \n or \0.
503 static void PrintUnmangledNameSafely(const Value *V, raw_ostream &OS) {
504 for (const char *Name = V->getNameStart(), *E = Name+V->getNameLen();
511 Emit a global variable according to its section, alignment, etc.
513 \note This code was shamelessly copied from the PowerPC's assembly printer,
514 which sort of screams for some kind of refactorization of common code.
516 void LinuxAsmPrinter::printModuleLevelGV(const GlobalVariable* GVar) {
517 const TargetData *TD = TM.getTargetData();
519 if (!GVar->hasInitializer())
522 // Check to see if this is a special global used by LLVM, if so, emit it.
523 if (EmitSpecialLLVMGlobal(GVar))
526 std::string name = Mang->getValueName(GVar);
528 printVisibility(name, GVar->getVisibility());
530 Constant *C = GVar->getInitializer();
531 const Type *Type = C->getType();
532 unsigned Size = TD->getTypePaddedSize(Type);
533 unsigned Align = TD->getPreferredAlignmentLog(GVar);
535 SwitchToSection(TAI->SectionForGlobal(GVar));
537 if (C->isNullValue() && /* FIXME: Verify correct */
538 !GVar->hasSection() &&
539 (GVar->hasLocalLinkage() || GVar->hasExternalLinkage() ||
540 GVar->mayBeOverridden())) {
541 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
543 if (GVar->hasExternalLinkage()) {
544 O << "\t.global " << name << '\n';
545 O << "\t.type " << name << ", @object\n";
547 O << "\t.zero " << Size << '\n';
548 } else if (GVar->hasLocalLinkage()) {
549 O << TAI->getLCOMMDirective() << name << ',' << Size;
551 O << ".comm " << name << ',' << Size;
553 O << "\t\t" << TAI->getCommentString() << " '";
554 PrintUnmangledNameSafely(GVar, O);
559 switch (GVar->getLinkage()) {
560 // Should never be seen for the CellSPU platform...
561 case GlobalValue::LinkOnceLinkage:
562 case GlobalValue::WeakLinkage:
563 case GlobalValue::CommonLinkage:
564 O << "\t.global " << name << '\n'
565 << "\t.type " << name << ", @object\n"
566 << "\t.weak " << name << '\n';
568 case GlobalValue::AppendingLinkage:
569 // FIXME: appending linkage variables should go into a section of
570 // their name or something. For now, just emit them as external.
571 case GlobalValue::ExternalLinkage:
572 // If external or appending, declare as a global symbol
573 O << "\t.global " << name << '\n'
574 << "\t.type " << name << ", @object\n";
576 case GlobalValue::PrivateLinkage:
577 case GlobalValue::InternalLinkage:
580 cerr << "Unknown linkage type!";
584 EmitAlignment(Align, GVar);
585 O << name << ":\t\t\t\t" << TAI->getCommentString() << " '";
586 PrintUnmangledNameSafely(GVar, O);
589 // If the initializer is a extern weak symbol, remember to emit the weak
591 if (const GlobalValue *GV = dyn_cast<GlobalValue>(C))
592 if (GV->hasExternalWeakLinkage())
593 ExtWeakSymbols.insert(GV);
595 EmitGlobalConstant(C);
599 bool LinuxAsmPrinter::doFinalization(Module &M) {
600 // Print out module-level global variables here.
601 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
603 printModuleLevelGV(I);
605 // Emit initial debug information.
608 return AsmPrinter::doFinalization(M);
611 /// createSPUCodePrinterPass - Returns a pass that prints the Cell SPU
612 /// assembly code for a MachineFunction to the given output stream, in a format
613 /// that the Linux SPU assembler can deal with.
615 FunctionPass *llvm::createSPUAsmPrinterPass(raw_ostream &o,
616 SPUTargetMachine &tm) {
617 return new LinuxAsmPrinter(o, tm, tm.getTargetAsmInfo());