1 //===-- PTXAsmPrinter.cpp - PTX LLVM assembly writer ----------------------===//
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 PTX assembly language.
13 //===----------------------------------------------------------------------===//
15 #define DEBUG_TYPE "ptx-asm-printer"
18 #include "PTXMachineFunctionInfo.h"
19 #include "PTXTargetMachine.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/Module.h"
22 #include "llvm/ADT/SmallString.h"
23 #include "llvm/ADT/StringExtras.h"
24 #include "llvm/ADT/Twine.h"
25 #include "llvm/Analysis/DebugInfo.h"
26 #include "llvm/CodeGen/AsmPrinter.h"
27 #include "llvm/CodeGen/MachineFrameInfo.h"
28 #include "llvm/CodeGen/MachineInstr.h"
29 #include "llvm/CodeGen/MachineRegisterInfo.h"
30 #include "llvm/MC/MCContext.h"
31 #include "llvm/MC/MCStreamer.h"
32 #include "llvm/MC/MCSymbol.h"
33 #include "llvm/Target/Mangler.h"
34 #include "llvm/Target/TargetLoweringObjectFile.h"
35 #include "llvm/Support/CommandLine.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/ErrorHandling.h"
38 #include "llvm/Support/MathExtras.h"
39 #include "llvm/Support/Path.h"
40 #include "llvm/Support/TargetRegistry.h"
41 #include "llvm/Support/raw_ostream.h"
46 class PTXAsmPrinter : public AsmPrinter {
48 explicit PTXAsmPrinter(TargetMachine &TM, MCStreamer &Streamer)
49 : AsmPrinter(TM, Streamer) {}
51 const char *getPassName() const { return "PTX Assembly Printer"; }
53 bool doFinalization(Module &M);
55 virtual void EmitStartOfAsmFile(Module &M);
57 virtual bool runOnMachineFunction(MachineFunction &MF);
59 virtual void EmitFunctionBodyStart();
60 virtual void EmitFunctionBodyEnd() { OutStreamer.EmitRawText(Twine("}")); }
62 virtual void EmitInstruction(const MachineInstr *MI);
64 void printOperand(const MachineInstr *MI, int opNum, raw_ostream &OS);
65 void printMemOperand(const MachineInstr *MI, int opNum, raw_ostream &OS,
66 const char *Modifier = 0);
67 void printParamOperand(const MachineInstr *MI, int opNum, raw_ostream &OS,
68 const char *Modifier = 0);
69 void printReturnOperand(const MachineInstr *MI, int opNum, raw_ostream &OS,
70 const char *Modifier = 0);
71 void printPredicateOperand(const MachineInstr *MI, raw_ostream &O);
73 void printCall(const MachineInstr *MI, raw_ostream &O);
75 unsigned GetOrCreateSourceID(StringRef FileName,
79 void printInstruction(const MachineInstr *MI, raw_ostream &OS);
80 static const char *getRegisterName(unsigned RegNo);
83 void EmitVariableDeclaration(const GlobalVariable *gv);
84 void EmitFunctionDeclaration();
86 StringMap<unsigned> SourceIdMap;
87 }; // class PTXAsmPrinter
90 static const char PARAM_PREFIX[] = "__param_";
91 static const char RETURN_PREFIX[] = "__ret_";
93 static const char *getRegisterTypeName(unsigned RegNo) {
94 #define TEST_REGCLS(cls, clsstr) \
95 if (PTX::cls ## RegisterClass->contains(RegNo)) return # clsstr;
96 TEST_REGCLS(RegPred, pred);
97 TEST_REGCLS(RegI16, b16);
98 TEST_REGCLS(RegI32, b32);
99 TEST_REGCLS(RegI64, b64);
100 TEST_REGCLS(RegF32, b32);
101 TEST_REGCLS(RegF64, b64);
104 llvm_unreachable("Not in any register class!");
108 static const char *getStateSpaceName(unsigned addressSpace) {
109 switch (addressSpace) {
110 default: llvm_unreachable("Unknown state space");
111 case PTX::GLOBAL: return "global";
112 case PTX::CONSTANT: return "const";
113 case PTX::LOCAL: return "local";
114 case PTX::PARAMETER: return "param";
115 case PTX::SHARED: return "shared";
120 static const char *getTypeName(Type* type) {
122 switch (type->getTypeID()) {
123 default: llvm_unreachable("Unknown type");
124 case Type::FloatTyID: return ".f32";
125 case Type::DoubleTyID: return ".f64";
126 case Type::IntegerTyID:
127 switch (type->getPrimitiveSizeInBits()) {
128 default: llvm_unreachable("Unknown integer bit-width");
129 case 16: return ".u16";
130 case 32: return ".u32";
131 case 64: return ".u64";
133 case Type::ArrayTyID:
134 case Type::PointerTyID:
135 type = dyn_cast<SequentialType>(type)->getElementType();
142 bool PTXAsmPrinter::doFinalization(Module &M) {
143 // XXX Temproarily remove global variables so that doFinalization() will not
144 // emit them again (global variables are emitted at beginning).
146 Module::GlobalListType &global_list = M.getGlobalList();
147 int i, n = global_list.size();
148 GlobalVariable **gv_array = new GlobalVariable* [n];
150 // first, back-up GlobalVariable in gv_array
152 for (Module::global_iterator I = global_list.begin(), E = global_list.end();
156 // second, empty global_list
157 while (!global_list.empty())
158 global_list.remove(global_list.begin());
160 // call doFinalization
161 bool ret = AsmPrinter::doFinalization(M);
163 // now we restore global variables
164 for (i = 0; i < n; i ++)
165 global_list.insert(global_list.end(), gv_array[i]);
171 void PTXAsmPrinter::EmitStartOfAsmFile(Module &M)
173 const PTXSubtarget& ST = TM.getSubtarget<PTXSubtarget>();
175 OutStreamer.EmitRawText(Twine("\t.version " + ST.getPTXVersionString()));
176 OutStreamer.EmitRawText(Twine("\t.target " + ST.getTargetString() +
177 (ST.supportsDouble() ? ""
178 : ", map_f64_to_f32")));
179 // .address_size directive is optional, but it must immediately follow
180 // the .target directive if present within a module
181 if (ST.supportsPTX23()) {
182 std::string addrSize = ST.is64Bit() ? "64" : "32";
183 OutStreamer.EmitRawText(Twine("\t.address_size " + addrSize));
186 OutStreamer.AddBlankLine();
188 // Define any .file directives
189 DebugInfoFinder DbgFinder;
190 DbgFinder.processModule(M);
192 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
193 E = DbgFinder.compile_unit_end(); I != E; ++I) {
194 DICompileUnit DIUnit(*I);
195 StringRef FN = DIUnit.getFilename();
196 StringRef Dir = DIUnit.getDirectory();
197 GetOrCreateSourceID(FN, Dir);
200 OutStreamer.AddBlankLine();
202 // declare global variables
203 for (Module::const_global_iterator i = M.global_begin(), e = M.global_end();
205 EmitVariableDeclaration(i);
208 bool PTXAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
209 SetupMachineFunction(MF);
210 EmitFunctionDeclaration();
215 void PTXAsmPrinter::EmitFunctionBodyStart() {
216 OutStreamer.EmitRawText(Twine("{"));
218 const PTXMachineFunctionInfo *MFI = MF->getInfo<PTXMachineFunctionInfo>();
220 // Print local variable definition
221 for (PTXMachineFunctionInfo::reg_iterator
222 i = MFI->localVarRegBegin(), e = MFI->localVarRegEnd(); i != e; ++ i) {
225 std::string def = "\t.reg .";
226 def += getRegisterTypeName(reg);
228 def += getRegisterName(reg);
230 OutStreamer.EmitRawText(Twine(def));
233 const MachineFrameInfo* FrameInfo = MF->getFrameInfo();
234 DEBUG(dbgs() << "Have " << FrameInfo->getNumObjects()
235 << " frame object(s)\n");
236 for (unsigned i = 0, e = FrameInfo->getNumObjects(); i != e; ++i) {
237 DEBUG(dbgs() << "Size of object: " << FrameInfo->getObjectSize(i) << "\n");
238 if (FrameInfo->getObjectSize(i) > 0) {
239 std::string def = "\t.reg .b";
240 def += utostr(FrameInfo->getObjectSize(i)*8); // Convert to bits
244 OutStreamer.EmitRawText(Twine(def));
249 // Print parameter passing params
250 for (PTXMachineFunctionInfo::param_iterator
251 i = MFI->paramBegin(), e = MFI->paramEnd(); i != e; ++i) {
252 std::string def = "\t.param .b";
255 def += utostr(Index);
258 OutStreamer.EmitRawText(Twine(def));
262 void PTXAsmPrinter::EmitInstruction(const MachineInstr *MI) {
266 raw_string_ostream OS(str);
268 DebugLoc DL = MI->getDebugLoc();
269 if (!DL.isUnknown()) {
271 const MDNode *S = DL.getScope(MF->getFunction()->getContext());
273 // This is taken from DwarfDebug.cpp, which is conveniently not a public
279 DIDescriptor Scope(S);
280 if (Scope.isCompileUnit()) {
282 Fn = CU.getFilename();
283 Dir = CU.getDirectory();
284 } else if (Scope.isFile()) {
286 Fn = F.getFilename();
287 Dir = F.getDirectory();
288 } else if (Scope.isSubprogram()) {
290 Fn = SP.getFilename();
291 Dir = SP.getDirectory();
292 } else if (Scope.isLexicalBlock()) {
293 DILexicalBlock DB(S);
294 Fn = DB.getFilename();
295 Dir = DB.getDirectory();
297 assert(0 && "Unexpected scope info");
299 Src = GetOrCreateSourceID(Fn, Dir);
301 OutStreamer.EmitDwarfLocDirective(Src, DL.getLine(), DL.getCol(),
304 const MCDwarfLoc& MDL = OutContext.getCurrentDwarfLoc();
307 OS << utostr(MDL.getFileNum());
309 OS << utostr(MDL.getLine());
311 OS << utostr(MDL.getColumn());
317 printPredicateOperand(MI, OS);
319 // Write instruction to str
320 if (MI->getOpcode() == PTX::CALL) {
323 printInstruction(MI, OS);
328 StringRef strref = StringRef(str);
329 OutStreamer.EmitRawText(strref);
332 void PTXAsmPrinter::printOperand(const MachineInstr *MI, int opNum,
334 const MachineOperand &MO = MI->getOperand(opNum);
336 switch (MO.getType()) {
338 llvm_unreachable("<unknown operand type>");
340 case MachineOperand::MO_GlobalAddress:
341 OS << *Mang->getSymbol(MO.getGlobal());
343 case MachineOperand::MO_Immediate:
344 OS << (long) MO.getImm();
346 case MachineOperand::MO_MachineBasicBlock:
347 OS << *MO.getMBB()->getSymbol();
349 case MachineOperand::MO_Register:
350 OS << getRegisterName(MO.getReg());
352 case MachineOperand::MO_FPImmediate:
353 APInt constFP = MO.getFPImm()->getValueAPF().bitcastToAPInt();
354 bool isFloat = MO.getFPImm()->getType()->getTypeID() == Type::FloatTyID;
355 // Emit 0F for 32-bit floats and 0D for 64-bit doubles.
362 // Emit the encoded floating-point value.
363 if (constFP.getZExtValue() > 0) {
364 OS << constFP.toString(16, false);
368 // If We have a double-precision zero, pad to 8-bytes.
377 void PTXAsmPrinter::printMemOperand(const MachineInstr *MI, int opNum,
378 raw_ostream &OS, const char *Modifier) {
379 printOperand(MI, opNum, OS);
381 if (MI->getOperand(opNum+1).isImm() && MI->getOperand(opNum+1).getImm() == 0)
382 return; // don't print "+0"
385 printOperand(MI, opNum+1, OS);
388 void PTXAsmPrinter::printParamOperand(const MachineInstr *MI, int opNum,
389 raw_ostream &OS, const char *Modifier) {
390 OS << PARAM_PREFIX << (int) MI->getOperand(opNum).getImm() + 1;
393 void PTXAsmPrinter::printReturnOperand(const MachineInstr *MI, int opNum,
394 raw_ostream &OS, const char *Modifier) {
395 OS << RETURN_PREFIX << (int) MI->getOperand(opNum).getImm() + 1;
398 void PTXAsmPrinter::EmitVariableDeclaration(const GlobalVariable *gv) {
399 // Check to see if this is a special global used by LLVM, if so, emit it.
400 if (EmitSpecialLLVMGlobal(gv))
403 MCSymbol *gvsym = Mang->getSymbol(gv);
405 assert(gvsym->isUndefined() && "Cannot define a symbol twice!");
409 // check if it is defined in some other translation unit
410 if (gv->isDeclaration())
413 // state space: e.g., .global
415 decl += getStateSpaceName(gv->getType()->getAddressSpace());
418 // alignment (optional)
419 unsigned alignment = gv->getAlignment();
420 if (alignment != 0) {
422 decl += utostr(Log2_32(gv->getAlignment()));
427 if (PointerType::classof(gv->getType())) {
428 PointerType* pointerTy = dyn_cast<PointerType>(gv->getType());
429 Type* elementTy = pointerTy->getElementType();
432 decl += gvsym->getName();
435 if (elementTy->isArrayTy())
437 assert(elementTy->isArrayTy() && "Only pointers to arrays are supported");
439 ArrayType* arrayTy = dyn_cast<ArrayType>(elementTy);
440 elementTy = arrayTy->getElementType();
442 unsigned numElements = arrayTy->getNumElements();
444 while (elementTy->isArrayTy()) {
446 arrayTy = dyn_cast<ArrayType>(elementTy);
447 elementTy = arrayTy->getElementType();
449 numElements *= arrayTy->getNumElements();
452 // FIXME: isPrimitiveType() == false for i16?
453 assert(elementTy->isSingleValueType() &&
454 "Non-primitive types are not handled");
456 // Compute the size of the array, in bytes.
457 uint64_t arraySize = (elementTy->getPrimitiveSizeInBits() >> 3)
460 decl += utostr(arraySize);
465 // handle string constants (assume ConstantArray means string)
467 if (gv->hasInitializer())
469 const Constant *C = gv->getInitializer();
470 if (const ConstantArray *CA = dyn_cast<ConstantArray>(C))
474 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
476 if (i > 0) decl += ",";
479 utohexstr(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
487 // Note: this is currently the fall-through case and most likely generates
489 decl += getTypeName(gv->getType());
492 decl += gvsym->getName();
494 if (ArrayType::classof(gv->getType()) ||
495 PointerType::classof(gv->getType()))
501 OutStreamer.EmitRawText(Twine(decl));
503 OutStreamer.AddBlankLine();
506 void PTXAsmPrinter::EmitFunctionDeclaration() {
507 // The function label could have already been emitted if two symbols end up
508 // conflicting due to asm renaming. Detect this and emit an error.
509 if (!CurrentFnSym->isUndefined()) {
510 report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
511 "' label emitted multiple times to assembly file");
515 const PTXMachineFunctionInfo *MFI = MF->getInfo<PTXMachineFunctionInfo>();
516 const bool isKernel = MFI->isKernel();
517 const PTXSubtarget& ST = TM.getSubtarget<PTXSubtarget>();
519 std::string decl = isKernel ? ".entry" : ".func";
525 for (PTXMachineFunctionInfo::ret_iterator
526 i = MFI->retRegBegin(), e = MFI->retRegEnd(), b = i;
532 decl += getRegisterTypeName(*i);
534 decl += getRegisterName(*i);
539 // Print function name
541 decl += CurrentFnSym->getName().str();
548 for (PTXMachineFunctionInfo::reg_iterator
549 i = MFI->argRegBegin(), e = MFI->argRegEnd(), b = i;
554 if (isKernel || ST.useParamSpaceForDeviceArgs()) {
558 decl += PARAM_PREFIX;
559 decl += utostr(++cnt);
562 decl += getRegisterTypeName(*i);
564 decl += getRegisterName(*i);
569 OutStreamer.EmitRawText(Twine(decl));
573 printPredicateOperand(const MachineInstr *MI, raw_ostream &O) {
574 int i = MI->findFirstPredOperandIdx();
576 llvm_unreachable("missing predicate operand");
578 unsigned reg = MI->getOperand(i).getReg();
579 int predOp = MI->getOperand(i+1).getImm();
581 DEBUG(dbgs() << "predicate: (" << reg << ", " << predOp << ")\n");
583 if (reg != PTX::NoRegister) {
585 if (predOp == PTX::PRED_NEGATE)
587 O << getRegisterName(reg);
592 printCall(const MachineInstr *MI, raw_ostream &O) {
596 const GlobalValue *Address = MI->getOperand(2).getGlobal();
597 O << Address->getName() << ", (";
599 // (0,1) : predicate register/flag
601 for (unsigned i = 3; i < MI->getNumOperands(); ++i) {
602 //const MachineOperand& MO = MI->getOperand(i);
604 printReturnOperand(MI, i, O);
605 if (i < MI->getNumOperands()-1) {
613 unsigned PTXAsmPrinter::GetOrCreateSourceID(StringRef FileName,
615 // If FE did not provide a file name, then assume stdin.
616 if (FileName.empty())
617 return GetOrCreateSourceID("<stdin>", StringRef());
619 // MCStream expects full path name as filename.
620 if (!DirName.empty() && !sys::path::is_absolute(FileName)) {
621 SmallString<128> FullPathName = DirName;
622 sys::path::append(FullPathName, FileName);
623 // Here FullPathName will be copied into StringMap by GetOrCreateSourceID.
624 return GetOrCreateSourceID(StringRef(FullPathName), StringRef());
627 StringMapEntry<unsigned> &Entry = SourceIdMap.GetOrCreateValue(FileName);
628 if (Entry.getValue())
629 return Entry.getValue();
631 unsigned SrcId = SourceIdMap.size();
632 Entry.setValue(SrcId);
634 // Print out a .file directive to specify files for .loc directives.
635 OutStreamer.EmitDwarfFileDirective(SrcId, Entry.getKey());
640 #include "PTXGenAsmWriter.inc"
642 // Force static initialization.
643 extern "C" void LLVMInitializePTXAsmPrinter() {
644 RegisterAsmPrinter<PTXAsmPrinter> X(ThePTX32Target);
645 RegisterAsmPrinter<PTXAsmPrinter> Y(ThePTX64Target);