1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
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 implements the AsmPrinter class.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/AsmPrinter.h"
15 #include "llvm/Assembly/Writer.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/Constants.h"
18 #include "llvm/Module.h"
19 #include "llvm/CodeGen/GCMetadataPrinter.h"
20 #include "llvm/CodeGen/MachineConstantPool.h"
21 #include "llvm/CodeGen/MachineJumpTableInfo.h"
22 #include "llvm/CodeGen/MachineModuleInfo.h"
23 #include "llvm/CodeGen/DwarfWriter.h"
24 #include "llvm/Analysis/DebugInfo.h"
25 #include "llvm/MC/MCContext.h"
26 #include "llvm/MC/MCStreamer.h"
27 #include "llvm/MC/MCInst.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/FormattedStream.h"
31 #include "llvm/Support/Mangler.h"
32 #include "llvm/Target/TargetAsmInfo.h"
33 #include "llvm/Target/TargetData.h"
34 #include "llvm/Target/TargetLowering.h"
35 #include "llvm/Target/TargetLoweringObjectFile.h"
36 #include "llvm/Target/TargetOptions.h"
37 #include "llvm/Target/TargetRegisterInfo.h"
38 #include "llvm/ADT/SmallPtrSet.h"
39 #include "llvm/ADT/SmallString.h"
40 #include "llvm/ADT/StringExtras.h"
44 static cl::opt<cl::boolOrDefault>
45 AsmVerbose("asm-verbose", cl::desc("Add comments to directives."),
46 cl::init(cl::BOU_UNSET));
48 char AsmPrinter::ID = 0;
49 AsmPrinter::AsmPrinter(formatted_raw_ostream &o, TargetMachine &tm,
50 const TargetAsmInfo *T, bool VDef)
51 : MachineFunctionPass(&ID), FunctionNumber(0), O(o),
52 TM(tm), TAI(T), TRI(tm.getRegisterInfo()),
54 OutContext(*new MCContext()),
55 OutStreamer(*createAsmStreamer(OutContext, O)),
57 IsInTextSection(false), LastMI(0), LastFn(0), Counter(~0U),
58 PrevDLT(0, ~0U, ~0U) {
61 case cl::BOU_UNSET: VerboseAsm = VDef; break;
62 case cl::BOU_TRUE: VerboseAsm = true; break;
63 case cl::BOU_FALSE: VerboseAsm = false; break;
67 AsmPrinter::~AsmPrinter() {
68 for (gcp_iterator I = GCMetadataPrinters.begin(),
69 E = GCMetadataPrinters.end(); I != E; ++I)
76 const TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
77 return TM.getTargetLowering()->getObjFileLowering();
81 /// SwitchToTextSection - Switch to the specified text section of the executable
82 /// if we are not already in it!
84 void AsmPrinter::SwitchToTextSection(const char *NewSection,
85 const GlobalValue *GV) {
87 if (GV && GV->hasSection())
88 NS = TAI->getSwitchToSectionDirective() + GV->getSection();
92 // If we're already in this section, we're done.
93 if (CurrentSection == NS) return;
95 // Close the current section, if applicable.
96 if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
97 O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << '\n';
101 if (!CurrentSection.empty())
102 O << CurrentSection << TAI->getTextSectionStartSuffix() << '\n';
104 IsInTextSection = true;
107 /// SwitchToDataSection - Switch to the specified data section of the executable
108 /// if we are not already in it!
110 void AsmPrinter::SwitchToDataSection(const char *NewSection,
111 const GlobalValue *GV) {
113 if (GV && GV->hasSection())
114 NS = TAI->getSwitchToSectionDirective() + GV->getSection();
118 // If we're already in this section, we're done.
119 if (CurrentSection == NS) return;
121 // Close the current section, if applicable.
122 if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
123 O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << '\n';
127 if (!CurrentSection.empty())
128 O << CurrentSection << TAI->getDataSectionStartSuffix() << '\n';
130 IsInTextSection = false;
133 /// SwitchToSection - Switch to the specified section of the executable if we
134 /// are not already in it!
135 void AsmPrinter::SwitchToSection(const Section *NS) {
136 const std::string &NewSection = NS->getName();
138 // If we're already in this section, we're done.
139 if (CurrentSection == NewSection) return;
141 // Close the current section, if applicable.
142 if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
143 O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << '\n';
145 // FIXME: Make CurrentSection a Section* in the future
146 CurrentSection = NewSection;
147 CurrentSection_ = NS;
149 if (!CurrentSection.empty()) {
150 // If section is named we need to switch into it via special '.section'
151 // directive and also append funky flags. Otherwise - section name is just
152 // some magic assembler directive.
153 if (NS->getKind().hasExplicitSection()) {
154 SmallString<32> FlagsStr;
156 getObjFileLowering().getSectionFlagsAsString(NS->getKind(), FlagsStr);
158 O << TAI->getSwitchToSectionDirective()
164 O << TAI->getDataSectionStartSuffix() << '\n';
167 IsInTextSection = NS->getKind().isText();
170 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
171 MachineFunctionPass::getAnalysisUsage(AU);
172 AU.addRequired<GCModuleInfo>();
175 bool AsmPrinter::doInitialization(Module &M) {
176 // Initialize TargetLoweringObjectFile.
177 const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
178 .Initialize(OutContext, TM);
180 Mang = new Mangler(M, TAI->getGlobalPrefix(), TAI->getPrivateGlobalPrefix(),
181 TAI->getLinkerPrivateGlobalPrefix());
183 if (TAI->doesAllowQuotesInName())
184 Mang->setUseQuotes(true);
186 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
187 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
189 if (TAI->hasSingleParameterDotFile()) {
190 /* Very minimal debug info. It is ignored if we emit actual
191 debug info. If we don't, this at helps the user find where
192 a function came from. */
193 O << "\t.file\t\"" << M.getModuleIdentifier() << "\"\n";
196 for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
197 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
198 MP->beginAssembly(O, *this, *TAI);
200 if (!M.getModuleInlineAsm().empty())
201 O << TAI->getCommentString() << " Start of file scope inline assembly\n"
202 << M.getModuleInlineAsm()
203 << '\n' << TAI->getCommentString()
204 << " End of file scope inline assembly\n";
206 SwitchToDataSection(""); // Reset back to no section.
208 if (TAI->doesSupportDebugInformation() ||
209 TAI->doesSupportExceptionHandling()) {
210 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
212 MMI->AnalyzeModule(M);
213 DW = getAnalysisIfAvailable<DwarfWriter>();
215 DW->BeginModule(&M, MMI, O, this, TAI);
221 bool AsmPrinter::doFinalization(Module &M) {
222 // Emit global variables.
223 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
225 PrintGlobalVariable(I);
227 // Emit final debug information.
228 if (TAI->doesSupportDebugInformation() || TAI->doesSupportExceptionHandling())
231 // If the target wants to know about weak references, print them all.
232 if (TAI->getWeakRefDirective()) {
233 // FIXME: This is not lazy, it would be nice to only print weak references
234 // to stuff that is actually used. Note that doing so would require targets
235 // to notice uses in operands (due to constant exprs etc). This should
236 // happen with the MC stuff eventually.
237 SwitchToDataSection("");
239 // Print out module-level global variables here.
240 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
242 if (I->hasExternalWeakLinkage())
243 O << TAI->getWeakRefDirective() << Mang->getMangledName(I) << '\n';
246 for (Module::const_iterator I = M.begin(), E = M.end();
248 if (I->hasExternalWeakLinkage())
249 O << TAI->getWeakRefDirective() << Mang->getMangledName(I) << '\n';
253 if (TAI->getSetDirective()) {
255 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
257 std::string Name = Mang->getMangledName(I);
259 const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
260 std::string Target = Mang->getMangledName(GV);
262 if (I->hasExternalLinkage() || !TAI->getWeakRefDirective())
263 O << "\t.globl\t" << Name << '\n';
264 else if (I->hasWeakLinkage())
265 O << TAI->getWeakRefDirective() << Name << '\n';
266 else if (!I->hasLocalLinkage())
267 llvm_unreachable("Invalid alias linkage");
269 printVisibility(Name, I->getVisibility());
271 O << TAI->getSetDirective() << ' ' << Name << ", " << Target << '\n';
275 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
276 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
277 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
278 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
279 MP->finishAssembly(O, *this, *TAI);
281 // If we don't have any trampolines, then we don't require stack memory
282 // to be executable. Some targets have a directive to declare this.
283 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
284 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
285 if (TAI->getNonexecutableStackDirective())
286 O << TAI->getNonexecutableStackDirective() << '\n';
288 delete Mang; Mang = 0;
291 OutStreamer.Finish();
296 AsmPrinter::getCurrentFunctionEHName(const MachineFunction *MF) const {
297 assert(MF && "No machine function?");
298 return Mang->getMangledName(MF->getFunction(), ".eh",
299 TAI->is_EHSymbolPrivate());
302 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
303 // What's my mangled name?
304 CurrentFnName = Mang->getMangledName(MF.getFunction());
305 IncrementFunctionNumber();
309 // SectionCPs - Keep track the alignment, constpool entries per Section.
313 SmallVector<unsigned, 4> CPEs;
314 SectionCPs(const Section *s, unsigned a) : S(s), Alignment(a) {};
318 /// EmitConstantPool - Print to the current output stream assembly
319 /// representations of the constants in the constant pool MCP. This is
320 /// used to print out constants which have been "spilled to memory" by
321 /// the code generator.
323 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
324 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
325 if (CP.empty()) return;
327 // Calculate sections for constant pool entries. We collect entries to go into
328 // the same section together to reduce amount of section switch statements.
329 SmallVector<SectionCPs, 4> CPSections;
330 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
331 const MachineConstantPoolEntry &CPE = CP[i];
332 unsigned Align = CPE.getAlignment();
335 switch (CPE.getRelocationInfo()) {
336 default: llvm_unreachable("Unknown section kind");
337 case 2: Kind = SectionKind::get(SectionKind::ReadOnlyWithRel, false); break;
339 Kind = SectionKind::get(SectionKind::ReadOnlyWithRelLocal,false);
342 switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
343 case 4: Kind = SectionKind::get(SectionKind::MergeableConst4,false); break;
344 case 8: Kind = SectionKind::get(SectionKind::MergeableConst8,false); break;
345 case 16: Kind = SectionKind::get(SectionKind::MergeableConst16,false);break;
346 default: Kind = SectionKind::get(SectionKind::MergeableConst,false); break;
350 const Section *S =getObjFileLowering().getSectionForMergeableConstant(Kind);
352 // The number of sections are small, just do a linear search from the
353 // last section to the first.
355 unsigned SecIdx = CPSections.size();
356 while (SecIdx != 0) {
357 if (CPSections[--SecIdx].S == S) {
363 SecIdx = CPSections.size();
364 CPSections.push_back(SectionCPs(S, Align));
367 if (Align > CPSections[SecIdx].Alignment)
368 CPSections[SecIdx].Alignment = Align;
369 CPSections[SecIdx].CPEs.push_back(i);
372 // Now print stuff into the calculated sections.
373 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
374 SwitchToSection(CPSections[i].S);
375 EmitAlignment(Log2_32(CPSections[i].Alignment));
378 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
379 unsigned CPI = CPSections[i].CPEs[j];
380 MachineConstantPoolEntry CPE = CP[CPI];
382 // Emit inter-object padding for alignment.
383 unsigned AlignMask = CPE.getAlignment() - 1;
384 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
385 EmitZeros(NewOffset - Offset);
387 const Type *Ty = CPE.getType();
388 Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
390 O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << '_'
391 << CPI << ":\t\t\t\t\t";
393 O << TAI->getCommentString() << ' ';
394 WriteTypeSymbolic(O, CPE.getType(), 0);
397 if (CPE.isMachineConstantPoolEntry())
398 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
400 EmitGlobalConstant(CPE.Val.ConstVal);
405 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
406 /// by the current function to the current output stream.
408 void AsmPrinter::EmitJumpTableInfo(MachineJumpTableInfo *MJTI,
409 MachineFunction &MF) {
410 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
411 if (JT.empty()) return;
413 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
415 // Pick the directive to use to print the jump table entries, and switch to
416 // the appropriate section.
417 TargetLowering *LoweringInfo = TM.getTargetLowering();
419 const char *JumpTableDataSection = TAI->getJumpTableDataSection();
420 const Function *F = MF.getFunction();
422 const Section *FuncSection =
423 getObjFileLowering().SectionForGlobal(F, Mang, TM);
425 bool JTInDiffSection = false;
426 if ((IsPic && !(LoweringInfo && LoweringInfo->usesGlobalOffsetTable())) ||
427 !JumpTableDataSection ||
428 FuncSection->getKind().isWeak()) {
429 // In PIC mode, we need to emit the jump table to the same section as the
430 // function body itself, otherwise the label differences won't make sense.
431 // We should also do if the section name is NULL or function is declared in
432 // discardable section.
433 SwitchToSection(FuncSection);
435 SwitchToDataSection(JumpTableDataSection);
436 JTInDiffSection = true;
439 EmitAlignment(Log2_32(MJTI->getAlignment()));
441 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
442 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
444 // If this jump table was deleted, ignore it.
445 if (JTBBs.empty()) continue;
447 // For PIC codegen, if possible we want to use the SetDirective to reduce
448 // the number of relocations the assembler will generate for the jump table.
449 // Set directives are all printed before the jump table itself.
450 SmallPtrSet<MachineBasicBlock*, 16> EmittedSets;
451 if (TAI->getSetDirective() && IsPic)
452 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
453 if (EmittedSets.insert(JTBBs[ii]))
454 printPICJumpTableSetLabel(i, JTBBs[ii]);
456 // On some targets (e.g. darwin) we want to emit two consequtive labels
457 // before each jump table. The first label is never referenced, but tells
458 // the assembler and linker the extents of the jump table object. The
459 // second label is actually referenced by the code.
460 if (JTInDiffSection) {
461 if (const char *JTLabelPrefix = TAI->getJumpTableSpecialLabelPrefix())
462 O << JTLabelPrefix << "JTI" << getFunctionNumber() << '_' << i << ":\n";
465 O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
466 << '_' << i << ":\n";
468 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
469 printPICJumpTableEntry(MJTI, JTBBs[ii], i);
475 void AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
476 const MachineBasicBlock *MBB,
477 unsigned uid) const {
478 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
480 // Use JumpTableDirective otherwise honor the entry size from the jump table
482 const char *JTEntryDirective = TAI->getJumpTableDirective();
483 bool HadJTEntryDirective = JTEntryDirective != NULL;
484 if (!HadJTEntryDirective) {
485 JTEntryDirective = MJTI->getEntrySize() == 4 ?
486 TAI->getData32bitsDirective() : TAI->getData64bitsDirective();
489 O << JTEntryDirective << ' ';
491 // If we have emitted set directives for the jump table entries, print
492 // them rather than the entries themselves. If we're emitting PIC, then
493 // emit the table entries as differences between two text section labels.
494 // If we're emitting non-PIC code, then emit the entries as direct
495 // references to the target basic blocks.
497 if (TAI->getSetDirective()) {
498 O << TAI->getPrivateGlobalPrefix() << getFunctionNumber()
499 << '_' << uid << "_set_" << MBB->getNumber();
501 printBasicBlockLabel(MBB, false, false, false);
502 // If the arch uses custom Jump Table directives, don't calc relative to
504 if (!HadJTEntryDirective)
505 O << '-' << TAI->getPrivateGlobalPrefix() << "JTI"
506 << getFunctionNumber() << '_' << uid;
509 printBasicBlockLabel(MBB, false, false, false);
514 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
515 /// special global used by LLVM. If so, emit it and return true, otherwise
516 /// do nothing and return false.
517 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
518 if (GV->getName() == "llvm.used") {
519 if (TAI->getUsedDirective() != 0) // No need to emit this at all.
520 EmitLLVMUsedList(GV->getInitializer());
524 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
525 if (GV->getSection() == "llvm.metadata" ||
526 GV->hasAvailableExternallyLinkage())
529 if (!GV->hasAppendingLinkage()) return false;
531 assert(GV->hasInitializer() && "Not a special LLVM global!");
533 const TargetData *TD = TM.getTargetData();
534 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
535 if (GV->getName() == "llvm.global_ctors") {
536 SwitchToDataSection(TAI->getStaticCtorsSection());
537 EmitAlignment(Align, 0);
538 EmitXXStructorList(GV->getInitializer());
542 if (GV->getName() == "llvm.global_dtors") {
543 SwitchToDataSection(TAI->getStaticDtorsSection());
544 EmitAlignment(Align, 0);
545 EmitXXStructorList(GV->getInitializer());
552 /// EmitLLVMUsedList - For targets that define a TAI::UsedDirective, mark each
553 /// global in the specified llvm.used list for which emitUsedDirectiveFor
554 /// is true, as being used with this directive.
555 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
556 const char *Directive = TAI->getUsedDirective();
558 // Should be an array of 'i8*'.
559 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
560 if (InitList == 0) return;
562 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
563 const GlobalValue *GV =
564 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
565 if (GV && TAI->emitUsedDirectiveFor(GV, Mang)) {
567 EmitConstantValueOnly(InitList->getOperand(i));
573 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
574 /// function pointers, ignoring the init priority.
575 void AsmPrinter::EmitXXStructorList(Constant *List) {
576 // Should be an array of '{ int, void ()* }' structs. The first value is the
577 // init priority, which we ignore.
578 if (!isa<ConstantArray>(List)) return;
579 ConstantArray *InitList = cast<ConstantArray>(List);
580 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
581 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
582 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
584 if (CS->getOperand(1)->isNullValue())
585 return; // Found a null terminator, exit printing.
586 // Emit the function pointer.
587 EmitGlobalConstant(CS->getOperand(1));
591 /// getGlobalLinkName - Returns the asm/link name of of the specified
592 /// global variable. Should be overridden by each target asm printer to
593 /// generate the appropriate value.
594 const std::string &AsmPrinter::getGlobalLinkName(const GlobalVariable *GV,
595 std::string &LinkName) const {
596 if (isa<Function>(GV)) {
597 LinkName += TAI->getFunctionAddrPrefix();
598 LinkName += Mang->getMangledName(GV);
599 LinkName += TAI->getFunctionAddrSuffix();
601 LinkName += TAI->getGlobalVarAddrPrefix();
602 LinkName += Mang->getMangledName(GV);
603 LinkName += TAI->getGlobalVarAddrSuffix();
609 /// EmitExternalGlobal - Emit the external reference to a global variable.
610 /// Should be overridden if an indirect reference should be used.
611 void AsmPrinter::EmitExternalGlobal(const GlobalVariable *GV) {
613 O << getGlobalLinkName(GV, GLN);
618 //===----------------------------------------------------------------------===//
619 /// LEB 128 number encoding.
621 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
622 /// representing an unsigned leb128 value.
623 void AsmPrinter::PrintULEB128(unsigned Value) const {
626 unsigned char Byte = static_cast<unsigned char>(Value & 0x7f);
628 if (Value) Byte |= 0x80;
629 O << "0x" << utohex_buffer(Byte, Buffer+20);
630 if (Value) O << ", ";
634 /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
635 /// representing a signed leb128 value.
636 void AsmPrinter::PrintSLEB128(int Value) const {
637 int Sign = Value >> (8 * sizeof(Value) - 1);
642 unsigned char Byte = static_cast<unsigned char>(Value & 0x7f);
644 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
645 if (IsMore) Byte |= 0x80;
646 O << "0x" << utohex_buffer(Byte, Buffer+20);
647 if (IsMore) O << ", ";
651 //===--------------------------------------------------------------------===//
652 // Emission and print routines
655 /// PrintHex - Print a value as a hexidecimal value.
657 void AsmPrinter::PrintHex(int Value) const {
659 O << "0x" << utohex_buffer(static_cast<unsigned>(Value), Buffer+20);
662 /// EOL - Print a newline character to asm stream. If a comment is present
663 /// then it will be printed first. Comments should not contain '\n'.
664 void AsmPrinter::EOL() const {
668 void AsmPrinter::EOL(const std::string &Comment) const {
669 if (VerboseAsm && !Comment.empty()) {
671 << TAI->getCommentString()
678 void AsmPrinter::EOL(const char* Comment) const {
679 if (VerboseAsm && *Comment) {
681 << TAI->getCommentString()
688 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
689 /// unsigned leb128 value.
690 void AsmPrinter::EmitULEB128Bytes(unsigned Value) const {
691 if (TAI->hasLEB128()) {
695 O << TAI->getData8bitsDirective();
700 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
701 /// signed leb128 value.
702 void AsmPrinter::EmitSLEB128Bytes(int Value) const {
703 if (TAI->hasLEB128()) {
707 O << TAI->getData8bitsDirective();
712 /// EmitInt8 - Emit a byte directive and value.
714 void AsmPrinter::EmitInt8(int Value) const {
715 O << TAI->getData8bitsDirective();
716 PrintHex(Value & 0xFF);
719 /// EmitInt16 - Emit a short directive and value.
721 void AsmPrinter::EmitInt16(int Value) const {
722 O << TAI->getData16bitsDirective();
723 PrintHex(Value & 0xFFFF);
726 /// EmitInt32 - Emit a long directive and value.
728 void AsmPrinter::EmitInt32(int Value) const {
729 O << TAI->getData32bitsDirective();
733 /// EmitInt64 - Emit a long long directive and value.
735 void AsmPrinter::EmitInt64(uint64_t Value) const {
736 if (TAI->getData64bitsDirective()) {
737 O << TAI->getData64bitsDirective();
740 if (TM.getTargetData()->isBigEndian()) {
741 EmitInt32(unsigned(Value >> 32)); O << '\n';
742 EmitInt32(unsigned(Value));
744 EmitInt32(unsigned(Value)); O << '\n';
745 EmitInt32(unsigned(Value >> 32));
750 /// toOctal - Convert the low order bits of X into an octal digit.
752 static inline char toOctal(int X) {
756 /// printStringChar - Print a char, escaped if necessary.
758 static void printStringChar(formatted_raw_ostream &O, unsigned char C) {
761 } else if (C == '\\') {
763 } else if (isprint((unsigned char)C)) {
767 case '\b': O << "\\b"; break;
768 case '\f': O << "\\f"; break;
769 case '\n': O << "\\n"; break;
770 case '\r': O << "\\r"; break;
771 case '\t': O << "\\t"; break;
774 O << toOctal(C >> 6);
775 O << toOctal(C >> 3);
776 O << toOctal(C >> 0);
782 /// EmitString - Emit a string with quotes and a null terminator.
783 /// Special characters are emitted properly.
784 /// \literal (Eg. '\t') \endliteral
785 void AsmPrinter::EmitString(const std::string &String) const {
786 EmitString(String.c_str(), String.size());
789 void AsmPrinter::EmitString(const char *String, unsigned Size) const {
790 const char* AscizDirective = TAI->getAscizDirective();
794 O << TAI->getAsciiDirective();
796 for (unsigned i = 0; i < Size; ++i)
797 printStringChar(O, String[i]);
805 /// EmitFile - Emit a .file directive.
806 void AsmPrinter::EmitFile(unsigned Number, const std::string &Name) const {
807 O << "\t.file\t" << Number << " \"";
808 for (unsigned i = 0, N = Name.size(); i < N; ++i)
809 printStringChar(O, Name[i]);
814 //===----------------------------------------------------------------------===//
816 // EmitAlignment - Emit an alignment directive to the specified power of
817 // two boundary. For example, if you pass in 3 here, you will get an 8
818 // byte alignment. If a global value is specified, and if that global has
819 // an explicit alignment requested, it will unconditionally override the
820 // alignment request. However, if ForcedAlignBits is specified, this value
821 // has final say: the ultimate alignment will be the max of ForcedAlignBits
822 // and the alignment computed with NumBits and the global.
826 // if (GV && GV->hasalignment) Align = GV->getalignment();
827 // Align = std::max(Align, ForcedAlignBits);
829 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
830 unsigned ForcedAlignBits,
831 bool UseFillExpr) const {
832 if (GV && GV->getAlignment())
833 NumBits = Log2_32(GV->getAlignment());
834 NumBits = std::max(NumBits, ForcedAlignBits);
836 if (NumBits == 0) return; // No need to emit alignment.
837 if (TAI->getAlignmentIsInBytes()) NumBits = 1 << NumBits;
838 O << TAI->getAlignDirective() << NumBits;
840 unsigned FillValue = TAI->getTextAlignFillValue();
841 UseFillExpr &= IsInTextSection && FillValue;
850 /// EmitZeros - Emit a block of zeros.
852 void AsmPrinter::EmitZeros(uint64_t NumZeros, unsigned AddrSpace) const {
854 if (TAI->getZeroDirective()) {
855 O << TAI->getZeroDirective() << NumZeros;
856 if (TAI->getZeroDirectiveSuffix())
857 O << TAI->getZeroDirectiveSuffix();
860 for (; NumZeros; --NumZeros)
861 O << TAI->getData8bitsDirective(AddrSpace) << "0\n";
866 // Print out the specified constant, without a storage class. Only the
867 // constants valid in constant expressions can occur here.
868 void AsmPrinter::EmitConstantValueOnly(const Constant *CV) {
869 if (CV->isNullValue() || isa<UndefValue>(CV))
871 else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
872 O << CI->getZExtValue();
873 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV)) {
874 // This is a constant address for a global variable or function. Use the
875 // name of the variable or function as the address value, possibly
876 // decorating it with GlobalVarAddrPrefix/Suffix or
877 // FunctionAddrPrefix/Suffix (these all default to "" )
878 if (isa<Function>(GV)) {
879 O << TAI->getFunctionAddrPrefix()
880 << Mang->getMangledName(GV)
881 << TAI->getFunctionAddrSuffix();
883 O << TAI->getGlobalVarAddrPrefix()
884 << Mang->getMangledName(GV)
885 << TAI->getGlobalVarAddrSuffix();
887 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
888 const TargetData *TD = TM.getTargetData();
889 unsigned Opcode = CE->getOpcode();
891 case Instruction::GetElementPtr: {
892 // generate a symbolic expression for the byte address
893 const Constant *ptrVal = CE->getOperand(0);
894 SmallVector<Value*, 8> idxVec(CE->op_begin()+1, CE->op_end());
895 if (int64_t Offset = TD->getIndexedOffset(ptrVal->getType(), &idxVec[0],
897 // Truncate/sext the offset to the pointer size.
898 if (TD->getPointerSizeInBits() != 64) {
899 int SExtAmount = 64-TD->getPointerSizeInBits();
900 Offset = (Offset << SExtAmount) >> SExtAmount;
905 EmitConstantValueOnly(ptrVal);
907 O << ") + " << Offset;
909 O << ") - " << -Offset;
911 EmitConstantValueOnly(ptrVal);
915 case Instruction::Trunc:
916 case Instruction::ZExt:
917 case Instruction::SExt:
918 case Instruction::FPTrunc:
919 case Instruction::FPExt:
920 case Instruction::UIToFP:
921 case Instruction::SIToFP:
922 case Instruction::FPToUI:
923 case Instruction::FPToSI:
924 llvm_unreachable("FIXME: Don't yet support this kind of constant cast expr");
926 case Instruction::BitCast:
927 return EmitConstantValueOnly(CE->getOperand(0));
929 case Instruction::IntToPtr: {
930 // Handle casts to pointers by changing them into casts to the appropriate
931 // integer type. This promotes constant folding and simplifies this code.
932 Constant *Op = CE->getOperand(0);
933 Op = ConstantExpr::getIntegerCast(Op, TD->getIntPtrType(), false/*ZExt*/);
934 return EmitConstantValueOnly(Op);
938 case Instruction::PtrToInt: {
939 // Support only foldable casts to/from pointers that can be eliminated by
940 // changing the pointer to the appropriately sized integer type.
941 Constant *Op = CE->getOperand(0);
942 const Type *Ty = CE->getType();
944 // We can emit the pointer value into this slot if the slot is an
945 // integer slot greater or equal to the size of the pointer.
946 if (TD->getTypeAllocSize(Ty) >= TD->getTypeAllocSize(Op->getType()))
947 return EmitConstantValueOnly(Op);
950 EmitConstantValueOnly(Op);
951 APInt ptrMask = APInt::getAllOnesValue(TD->getTypeAllocSizeInBits(Ty));
954 ptrMask.toStringUnsigned(S);
955 O << ") & " << S.c_str() << ')';
958 case Instruction::Add:
959 case Instruction::Sub:
960 case Instruction::And:
961 case Instruction::Or:
962 case Instruction::Xor:
964 EmitConstantValueOnly(CE->getOperand(0));
967 case Instruction::Add:
970 case Instruction::Sub:
973 case Instruction::And:
976 case Instruction::Or:
979 case Instruction::Xor:
986 EmitConstantValueOnly(CE->getOperand(1));
990 llvm_unreachable("Unsupported operator!");
993 llvm_unreachable("Unknown constant value!");
997 /// printAsCString - Print the specified array as a C compatible string, only if
998 /// the predicate isString is true.
1000 static void printAsCString(formatted_raw_ostream &O, const ConstantArray *CVA,
1002 assert(CVA->isString() && "Array is not string compatible!");
1005 for (unsigned i = 0; i != LastElt; ++i) {
1007 (unsigned char)cast<ConstantInt>(CVA->getOperand(i))->getZExtValue();
1008 printStringChar(O, C);
1013 /// EmitString - Emit a zero-byte-terminated string constant.
1015 void AsmPrinter::EmitString(const ConstantArray *CVA) const {
1016 unsigned NumElts = CVA->getNumOperands();
1017 if (TAI->getAscizDirective() && NumElts &&
1018 cast<ConstantInt>(CVA->getOperand(NumElts-1))->getZExtValue() == 0) {
1019 O << TAI->getAscizDirective();
1020 printAsCString(O, CVA, NumElts-1);
1022 O << TAI->getAsciiDirective();
1023 printAsCString(O, CVA, NumElts);
1028 void AsmPrinter::EmitGlobalConstantArray(const ConstantArray *CVA,
1029 unsigned AddrSpace) {
1030 if (CVA->isString()) {
1032 } else { // Not a string. Print the values in successive locations
1033 for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
1034 EmitGlobalConstant(CVA->getOperand(i), AddrSpace);
1038 void AsmPrinter::EmitGlobalConstantVector(const ConstantVector *CP) {
1039 const VectorType *PTy = CP->getType();
1041 for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
1042 EmitGlobalConstant(CP->getOperand(I));
1045 void AsmPrinter::EmitGlobalConstantStruct(const ConstantStruct *CVS,
1046 unsigned AddrSpace) {
1047 // Print the fields in successive locations. Pad to align if needed!
1048 const TargetData *TD = TM.getTargetData();
1049 unsigned Size = TD->getTypeAllocSize(CVS->getType());
1050 const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
1051 uint64_t sizeSoFar = 0;
1052 for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
1053 const Constant* field = CVS->getOperand(i);
1055 // Check if padding is needed and insert one or more 0s.
1056 uint64_t fieldSize = TD->getTypeAllocSize(field->getType());
1057 uint64_t padSize = ((i == e-1 ? Size : cvsLayout->getElementOffset(i+1))
1058 - cvsLayout->getElementOffset(i)) - fieldSize;
1059 sizeSoFar += fieldSize + padSize;
1061 // Now print the actual field value.
1062 EmitGlobalConstant(field, AddrSpace);
1064 // Insert padding - this may include padding to increase the size of the
1065 // current field up to the ABI size (if the struct is not packed) as well
1066 // as padding to ensure that the next field starts at the right offset.
1067 EmitZeros(padSize, AddrSpace);
1069 assert(sizeSoFar == cvsLayout->getSizeInBytes() &&
1070 "Layout of constant struct may be incorrect!");
1073 void AsmPrinter::EmitGlobalConstantFP(const ConstantFP *CFP,
1074 unsigned AddrSpace) {
1075 // FP Constants are printed as integer constants to avoid losing
1077 const TargetData *TD = TM.getTargetData();
1078 if (CFP->getType() == Type::DoubleTy) {
1079 double Val = CFP->getValueAPF().convertToDouble(); // for comment only
1080 uint64_t i = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1081 if (TAI->getData64bitsDirective(AddrSpace)) {
1082 O << TAI->getData64bitsDirective(AddrSpace) << i;
1084 O << '\t' << TAI->getCommentString() << " double value: " << Val;
1086 } else if (TD->isBigEndian()) {
1087 O << TAI->getData32bitsDirective(AddrSpace) << unsigned(i >> 32);
1089 O << '\t' << TAI->getCommentString()
1090 << " double most significant word " << Val;
1092 O << TAI->getData32bitsDirective(AddrSpace) << unsigned(i);
1094 O << '\t' << TAI->getCommentString()
1095 << " double least significant word " << Val;
1098 O << TAI->getData32bitsDirective(AddrSpace) << unsigned(i);
1100 O << '\t' << TAI->getCommentString()
1101 << " double least significant word " << Val;
1103 O << TAI->getData32bitsDirective(AddrSpace) << unsigned(i >> 32);
1105 O << '\t' << TAI->getCommentString()
1106 << " double most significant word " << Val;
1110 } else if (CFP->getType() == Type::FloatTy) {
1111 float Val = CFP->getValueAPF().convertToFloat(); // for comment only
1112 O << TAI->getData32bitsDirective(AddrSpace)
1113 << CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1115 O << '\t' << TAI->getCommentString() << " float " << Val;
1118 } else if (CFP->getType() == Type::X86_FP80Ty) {
1119 // all long double variants are printed as hex
1120 // api needed to prevent premature destruction
1121 APInt api = CFP->getValueAPF().bitcastToAPInt();
1122 const uint64_t *p = api.getRawData();
1123 // Convert to double so we can print the approximate val as a comment.
1124 APFloat DoubleVal = CFP->getValueAPF();
1126 DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1128 if (TD->isBigEndian()) {
1129 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[1]);
1131 O << '\t' << TAI->getCommentString()
1132 << " long double most significant halfword of ~"
1133 << DoubleVal.convertToDouble();
1135 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 48);
1137 O << '\t' << TAI->getCommentString() << " long double next halfword";
1139 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 32);
1141 O << '\t' << TAI->getCommentString() << " long double next halfword";
1143 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 16);
1145 O << '\t' << TAI->getCommentString() << " long double next halfword";
1147 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0]);
1149 O << '\t' << TAI->getCommentString()
1150 << " long double least significant halfword";
1153 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0]);
1155 O << '\t' << TAI->getCommentString()
1156 << " long double least significant halfword of ~"
1157 << DoubleVal.convertToDouble();
1159 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 16);
1161 O << '\t' << TAI->getCommentString()
1162 << " long double next halfword";
1164 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 32);
1166 O << '\t' << TAI->getCommentString()
1167 << " long double next halfword";
1169 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 48);
1171 O << '\t' << TAI->getCommentString()
1172 << " long double next halfword";
1174 O << TAI->getData16bitsDirective(AddrSpace) << uint16_t(p[1]);
1176 O << '\t' << TAI->getCommentString()
1177 << " long double most significant halfword";
1180 EmitZeros(TD->getTypeAllocSize(Type::X86_FP80Ty) -
1181 TD->getTypeStoreSize(Type::X86_FP80Ty), AddrSpace);
1183 } else if (CFP->getType() == Type::PPC_FP128Ty) {
1184 // all long double variants are printed as hex
1185 // api needed to prevent premature destruction
1186 APInt api = CFP->getValueAPF().bitcastToAPInt();
1187 const uint64_t *p = api.getRawData();
1188 if (TD->isBigEndian()) {
1189 O << TAI->getData32bitsDirective(AddrSpace) << uint32_t(p[0] >> 32);
1191 O << '\t' << TAI->getCommentString()
1192 << " long double most significant word";
1194 O << TAI->getData32bitsDirective(AddrSpace) << uint32_t(p[0]);
1196 O << '\t' << TAI->getCommentString()
1197 << " long double next word";
1199 O << TAI->getData32bitsDirective(AddrSpace) << uint32_t(p[1] >> 32);
1201 O << '\t' << TAI->getCommentString()
1202 << " long double next word";
1204 O << TAI->getData32bitsDirective(AddrSpace) << uint32_t(p[1]);
1206 O << '\t' << TAI->getCommentString()
1207 << " long double least significant word";
1210 O << TAI->getData32bitsDirective(AddrSpace) << uint32_t(p[1]);
1212 O << '\t' << TAI->getCommentString()
1213 << " long double least significant word";
1215 O << TAI->getData32bitsDirective(AddrSpace) << uint32_t(p[1] >> 32);
1217 O << '\t' << TAI->getCommentString()
1218 << " long double next word";
1220 O << TAI->getData32bitsDirective(AddrSpace) << uint32_t(p[0]);
1222 O << '\t' << TAI->getCommentString()
1223 << " long double next word";
1225 O << TAI->getData32bitsDirective(AddrSpace) << uint32_t(p[0] >> 32);
1227 O << '\t' << TAI->getCommentString()
1228 << " long double most significant word";
1232 } else llvm_unreachable("Floating point constant type not handled");
1235 void AsmPrinter::EmitGlobalConstantLargeInt(const ConstantInt *CI,
1236 unsigned AddrSpace) {
1237 const TargetData *TD = TM.getTargetData();
1238 unsigned BitWidth = CI->getBitWidth();
1239 assert(isPowerOf2_32(BitWidth) &&
1240 "Non-power-of-2-sized integers not handled!");
1242 // We don't expect assemblers to support integer data directives
1243 // for more than 64 bits, so we emit the data in at most 64-bit
1244 // quantities at a time.
1245 const uint64_t *RawData = CI->getValue().getRawData();
1246 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1248 if (TD->isBigEndian())
1249 Val = RawData[e - i - 1];
1253 if (TAI->getData64bitsDirective(AddrSpace))
1254 O << TAI->getData64bitsDirective(AddrSpace) << Val << '\n';
1255 else if (TD->isBigEndian()) {
1256 O << TAI->getData32bitsDirective(AddrSpace) << unsigned(Val >> 32);
1258 O << '\t' << TAI->getCommentString()
1259 << " Double-word most significant word " << Val;
1261 O << TAI->getData32bitsDirective(AddrSpace) << unsigned(Val);
1263 O << '\t' << TAI->getCommentString()
1264 << " Double-word least significant word " << Val;
1267 O << TAI->getData32bitsDirective(AddrSpace) << unsigned(Val);
1269 O << '\t' << TAI->getCommentString()
1270 << " Double-word least significant word " << Val;
1272 O << TAI->getData32bitsDirective(AddrSpace) << unsigned(Val >> 32);
1274 O << '\t' << TAI->getCommentString()
1275 << " Double-word most significant word " << Val;
1281 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1282 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1283 const TargetData *TD = TM.getTargetData();
1284 const Type *type = CV->getType();
1285 unsigned Size = TD->getTypeAllocSize(type);
1287 if (CV->isNullValue() || isa<UndefValue>(CV)) {
1288 EmitZeros(Size, AddrSpace);
1290 } else if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
1291 EmitGlobalConstantArray(CVA , AddrSpace);
1293 } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
1294 EmitGlobalConstantStruct(CVS, AddrSpace);
1296 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1297 EmitGlobalConstantFP(CFP, AddrSpace);
1299 } else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1300 // Small integers are handled below; large integers are handled here.
1302 EmitGlobalConstantLargeInt(CI, AddrSpace);
1305 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
1306 EmitGlobalConstantVector(CP);
1310 printDataDirective(type, AddrSpace);
1311 EmitConstantValueOnly(CV);
1313 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1315 CI->getValue().toStringUnsigned(S, 16);
1316 O << "\t\t\t" << TAI->getCommentString() << " 0x" << S.c_str();
1322 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1323 // Target doesn't support this yet!
1324 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1327 /// PrintSpecial - Print information related to the specified machine instr
1328 /// that is independent of the operand, and may be independent of the instr
1329 /// itself. This can be useful for portably encoding the comment character
1330 /// or other bits of target-specific knowledge into the asmstrings. The
1331 /// syntax used is ${:comment}. Targets can override this to add support
1332 /// for their own strange codes.
1333 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1334 if (!strcmp(Code, "private")) {
1335 O << TAI->getPrivateGlobalPrefix();
1336 } else if (!strcmp(Code, "comment")) {
1338 O << TAI->getCommentString();
1339 } else if (!strcmp(Code, "uid")) {
1340 // Comparing the address of MI isn't sufficient, because machineinstrs may
1341 // be allocated to the same address across functions.
1342 const Function *ThisF = MI->getParent()->getParent()->getFunction();
1344 // If this is a new LastFn instruction, bump the counter.
1345 if (LastMI != MI || LastFn != ThisF) {
1353 raw_string_ostream Msg(msg);
1354 Msg << "Unknown special formatter '" << Code
1355 << "' for machine instr: " << *MI;
1356 llvm_report_error(Msg.str());
1360 /// processDebugLoc - Processes the debug information of each machine
1361 /// instruction's DebugLoc.
1362 void AsmPrinter::processDebugLoc(DebugLoc DL) {
1363 if (TAI->doesSupportDebugInformation() && DW->ShouldEmitDwarfDebug()) {
1364 if (!DL.isUnknown()) {
1365 DebugLocTuple CurDLT = MF->getDebugLocTuple(DL);
1367 if (CurDLT.CompileUnit != 0 && PrevDLT != CurDLT)
1368 printLabel(DW->RecordSourceLine(CurDLT.Line, CurDLT.Col,
1369 DICompileUnit(CurDLT.CompileUnit)));
1376 /// printInlineAsm - This method formats and prints the specified machine
1377 /// instruction that is an inline asm.
1378 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1379 unsigned NumOperands = MI->getNumOperands();
1381 // Count the number of register definitions.
1382 unsigned NumDefs = 0;
1383 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1385 assert(NumDefs != NumOperands-1 && "No asm string?");
1387 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1389 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1390 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1392 // If this asmstr is empty, just print the #APP/#NOAPP markers.
1393 // These are useful to see where empty asm's wound up.
1394 if (AsmStr[0] == 0) {
1395 O << TAI->getInlineAsmStart() << "\n\t" << TAI->getInlineAsmEnd() << '\n';
1399 O << TAI->getInlineAsmStart() << "\n\t";
1401 // The variant of the current asmprinter.
1402 int AsmPrinterVariant = TAI->getAssemblerDialect();
1404 int CurVariant = -1; // The number of the {.|.|.} region we are in.
1405 const char *LastEmitted = AsmStr; // One past the last character emitted.
1407 while (*LastEmitted) {
1408 switch (*LastEmitted) {
1410 // Not a special case, emit the string section literally.
1411 const char *LiteralEnd = LastEmitted+1;
1412 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1413 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1415 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1416 O.write(LastEmitted, LiteralEnd-LastEmitted);
1417 LastEmitted = LiteralEnd;
1421 ++LastEmitted; // Consume newline character.
1422 O << '\n'; // Indent code with newline.
1425 ++LastEmitted; // Consume '$' character.
1429 switch (*LastEmitted) {
1430 default: Done = false; break;
1431 case '$': // $$ -> $
1432 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1434 ++LastEmitted; // Consume second '$' character.
1436 case '(': // $( -> same as GCC's { character.
1437 ++LastEmitted; // Consume '(' character.
1438 if (CurVariant != -1) {
1439 llvm_report_error("Nested variants found in inline asm string: '"
1440 + std::string(AsmStr) + "'");
1442 CurVariant = 0; // We're in the first variant now.
1445 ++LastEmitted; // consume '|' character.
1446 if (CurVariant == -1)
1447 O << '|'; // this is gcc's behavior for | outside a variant
1449 ++CurVariant; // We're in the next variant.
1451 case ')': // $) -> same as GCC's } char.
1452 ++LastEmitted; // consume ')' character.
1453 if (CurVariant == -1)
1454 O << '}'; // this is gcc's behavior for } outside a variant
1461 bool HasCurlyBraces = false;
1462 if (*LastEmitted == '{') { // ${variable}
1463 ++LastEmitted; // Consume '{' character.
1464 HasCurlyBraces = true;
1467 // If we have ${:foo}, then this is not a real operand reference, it is a
1468 // "magic" string reference, just like in .td files. Arrange to call
1470 if (HasCurlyBraces && *LastEmitted == ':') {
1472 const char *StrStart = LastEmitted;
1473 const char *StrEnd = strchr(StrStart, '}');
1475 llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1476 + std::string(AsmStr) + "'");
1479 std::string Val(StrStart, StrEnd);
1480 PrintSpecial(MI, Val.c_str());
1481 LastEmitted = StrEnd+1;
1485 const char *IDStart = LastEmitted;
1488 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1489 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1490 llvm_report_error("Bad $ operand number in inline asm string: '"
1491 + std::string(AsmStr) + "'");
1493 LastEmitted = IDEnd;
1495 char Modifier[2] = { 0, 0 };
1497 if (HasCurlyBraces) {
1498 // If we have curly braces, check for a modifier character. This
1499 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1500 if (*LastEmitted == ':') {
1501 ++LastEmitted; // Consume ':' character.
1502 if (*LastEmitted == 0) {
1503 llvm_report_error("Bad ${:} expression in inline asm string: '"
1504 + std::string(AsmStr) + "'");
1507 Modifier[0] = *LastEmitted;
1508 ++LastEmitted; // Consume modifier character.
1511 if (*LastEmitted != '}') {
1512 llvm_report_error("Bad ${} expression in inline asm string: '"
1513 + std::string(AsmStr) + "'");
1515 ++LastEmitted; // Consume '}' character.
1518 if ((unsigned)Val >= NumOperands-1) {
1519 llvm_report_error("Invalid $ operand number in inline asm string: '"
1520 + std::string(AsmStr) + "'");
1523 // Okay, we finally have a value number. Ask the target to print this
1525 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1530 // Scan to find the machine operand number for the operand.
1531 for (; Val; --Val) {
1532 if (OpNo >= MI->getNumOperands()) break;
1533 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1534 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1537 if (OpNo >= MI->getNumOperands()) {
1540 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1541 ++OpNo; // Skip over the ID number.
1543 if (Modifier[0]=='l') // labels are target independent
1544 printBasicBlockLabel(MI->getOperand(OpNo).getMBB(),
1545 false, false, false);
1547 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1548 if ((OpFlags & 7) == 4) {
1549 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1550 Modifier[0] ? Modifier : 0);
1552 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1553 Modifier[0] ? Modifier : 0);
1559 raw_string_ostream Msg(msg);
1560 Msg << "Invalid operand found in inline asm: '"
1563 llvm_report_error(Msg.str());
1570 O << "\n\t" << TAI->getInlineAsmEnd() << '\n';
1573 /// printImplicitDef - This method prints the specified machine instruction
1574 /// that is an implicit def.
1575 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1577 O << '\t' << TAI->getCommentString() << " implicit-def: "
1578 << TRI->getAsmName(MI->getOperand(0).getReg()) << '\n';
1581 /// printLabel - This method prints a local label used by debug and
1582 /// exception handling tables.
1583 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1584 printLabel(MI->getOperand(0).getImm());
1587 void AsmPrinter::printLabel(unsigned Id) const {
1588 O << TAI->getPrivateGlobalPrefix() << "label" << Id << ":\n";
1591 /// printDeclare - This method prints a local variable declaration used by
1593 /// FIXME: It doesn't really print anything rather it inserts a DebugVariable
1594 /// entry into dwarf table.
1595 void AsmPrinter::printDeclare(const MachineInstr *MI) const {
1596 unsigned FI = MI->getOperand(0).getIndex();
1597 GlobalValue *GV = MI->getOperand(1).getGlobal();
1598 DW->RecordVariable(cast<GlobalVariable>(GV), FI, MI);
1601 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1602 /// instruction, using the specified assembler variant. Targets should
1603 /// overried this to format as appropriate.
1604 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1605 unsigned AsmVariant, const char *ExtraCode) {
1606 // Target doesn't support this yet!
1610 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1611 unsigned AsmVariant,
1612 const char *ExtraCode) {
1613 // Target doesn't support this yet!
1617 /// printBasicBlockLabel - This method prints the label for the specified
1618 /// MachineBasicBlock
1619 void AsmPrinter::printBasicBlockLabel(const MachineBasicBlock *MBB,
1622 bool printComment) const {
1624 unsigned Align = MBB->getAlignment();
1626 EmitAlignment(Log2_32(Align));
1629 O << TAI->getPrivateGlobalPrefix() << "BB" << getFunctionNumber() << '_'
1630 << MBB->getNumber();
1633 if (printComment && MBB->getBasicBlock())
1634 O << '\t' << TAI->getCommentString() << ' '
1635 << MBB->getBasicBlock()->getNameStr();
1638 /// printPICJumpTableSetLabel - This method prints a set label for the
1639 /// specified MachineBasicBlock for a jumptable entry.
1640 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
1641 const MachineBasicBlock *MBB) const {
1642 if (!TAI->getSetDirective())
1645 O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
1646 << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ',';
1647 printBasicBlockLabel(MBB, false, false, false);
1648 O << '-' << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1649 << '_' << uid << '\n';
1652 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
1653 const MachineBasicBlock *MBB) const {
1654 if (!TAI->getSetDirective())
1657 O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
1658 << getFunctionNumber() << '_' << uid << '_' << uid2
1659 << "_set_" << MBB->getNumber() << ',';
1660 printBasicBlockLabel(MBB, false, false, false);
1661 O << '-' << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1662 << '_' << uid << '_' << uid2 << '\n';
1665 /// printDataDirective - This method prints the asm directive for the
1667 void AsmPrinter::printDataDirective(const Type *type, unsigned AddrSpace) {
1668 const TargetData *TD = TM.getTargetData();
1669 switch (type->getTypeID()) {
1670 case Type::FloatTyID: case Type::DoubleTyID:
1671 case Type::X86_FP80TyID: case Type::FP128TyID: case Type::PPC_FP128TyID:
1672 assert(0 && "Should have already output floating point constant.");
1674 assert(0 && "Can't handle printing this type of thing");
1675 case Type::IntegerTyID: {
1676 unsigned BitWidth = cast<IntegerType>(type)->getBitWidth();
1678 O << TAI->getData8bitsDirective(AddrSpace);
1679 else if (BitWidth <= 16)
1680 O << TAI->getData16bitsDirective(AddrSpace);
1681 else if (BitWidth <= 32)
1682 O << TAI->getData32bitsDirective(AddrSpace);
1683 else if (BitWidth <= 64) {
1684 assert(TAI->getData64bitsDirective(AddrSpace) &&
1685 "Target cannot handle 64-bit constant exprs!");
1686 O << TAI->getData64bitsDirective(AddrSpace);
1688 llvm_unreachable("Target cannot handle given data directive width!");
1692 case Type::PointerTyID:
1693 if (TD->getPointerSize() == 8) {
1694 assert(TAI->getData64bitsDirective(AddrSpace) &&
1695 "Target cannot handle 64-bit pointer exprs!");
1696 O << TAI->getData64bitsDirective(AddrSpace);
1697 } else if (TD->getPointerSize() == 2) {
1698 O << TAI->getData16bitsDirective(AddrSpace);
1699 } else if (TD->getPointerSize() == 1) {
1700 O << TAI->getData8bitsDirective(AddrSpace);
1702 O << TAI->getData32bitsDirective(AddrSpace);
1708 void AsmPrinter::printVisibility(const std::string& Name,
1709 unsigned Visibility) const {
1710 if (Visibility == GlobalValue::HiddenVisibility) {
1711 if (const char *Directive = TAI->getHiddenDirective())
1712 O << Directive << Name << '\n';
1713 } else if (Visibility == GlobalValue::ProtectedVisibility) {
1714 if (const char *Directive = TAI->getProtectedDirective())
1715 O << Directive << Name << '\n';
1719 void AsmPrinter::printOffset(int64_t Offset) const {
1722 else if (Offset < 0)
1726 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1727 if (!S->usesMetadata())
1730 gcp_iterator GCPI = GCMetadataPrinters.find(S);
1731 if (GCPI != GCMetadataPrinters.end())
1732 return GCPI->second;
1734 const char *Name = S->getName().c_str();
1736 for (GCMetadataPrinterRegistry::iterator
1737 I = GCMetadataPrinterRegistry::begin(),
1738 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1739 if (strcmp(Name, I->getName()) == 0) {
1740 GCMetadataPrinter *GMP = I->instantiate();
1742 GCMetadataPrinters.insert(std::make_pair(S, GMP));
1746 cerr << "no GCMetadataPrinter registered for GC: " << Name << "\n";
1747 llvm_unreachable(0);
1750 /// EmitComments - Pretty-print comments for instructions
1751 void AsmPrinter::EmitComments(const MachineInstr &MI) const
1754 if (!MI.getDebugLoc().isUnknown()) {
1755 DebugLocTuple DLT = MF->getDebugLocTuple(MI.getDebugLoc());
1757 // Print source line info
1758 O.PadToColumn(TAI->getCommentColumn(), 1);
1759 O << TAI->getCommentString() << " SrcLine ";
1760 if (DLT.CompileUnit->hasInitializer()) {
1761 Constant *Name = DLT.CompileUnit->getInitializer();
1762 if (ConstantArray *NameString = dyn_cast<ConstantArray>(Name))
1763 if (NameString->isString()) {
1764 O << NameString->getAsString() << " ";
1769 O << ":" << DLT.Col;
1774 /// EmitComments - Pretty-print comments for instructions
1775 void AsmPrinter::EmitComments(const MCInst &MI) const
1778 if (!MI.getDebugLoc().isUnknown()) {
1779 DebugLocTuple DLT = MF->getDebugLocTuple(MI.getDebugLoc());
1781 // Print source line info
1782 O.PadToColumn(TAI->getCommentColumn(), 1);
1783 O << TAI->getCommentString() << " SrcLine ";
1784 if (DLT.CompileUnit->hasInitializer()) {
1785 Constant *Name = DLT.CompileUnit->getInitializer();
1786 if (ConstantArray *NameString = dyn_cast<ConstantArray>(Name))
1787 if (NameString->isString()) {
1788 O << NameString->getAsString() << " ";
1793 O << ":" << DLT.Col;