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/DwarfWriter.h"
20 #include "llvm/CodeGen/GCMetadataPrinter.h"
21 #include "llvm/CodeGen/MachineConstantPool.h"
22 #include "llvm/CodeGen/MachineFrameInfo.h"
23 #include "llvm/CodeGen/MachineFunction.h"
24 #include "llvm/CodeGen/MachineJumpTableInfo.h"
25 #include "llvm/CodeGen/MachineLoopInfo.h"
26 #include "llvm/CodeGen/MachineModuleInfo.h"
27 #include "llvm/Analysis/DebugInfo.h"
28 #include "llvm/MC/MCContext.h"
29 #include "llvm/MC/MCExpr.h"
30 #include "llvm/MC/MCInst.h"
31 #include "llvm/MC/MCSection.h"
32 #include "llvm/MC/MCStreamer.h"
33 #include "llvm/MC/MCSymbol.h"
34 #include "llvm/Support/CommandLine.h"
35 #include "llvm/Support/ErrorHandling.h"
36 #include "llvm/Support/Format.h"
37 #include "llvm/Support/FormattedStream.h"
38 #include "llvm/MC/MCAsmInfo.h"
39 #include "llvm/Target/Mangler.h"
40 #include "llvm/Target/TargetData.h"
41 #include "llvm/Target/TargetInstrInfo.h"
42 #include "llvm/Target/TargetLowering.h"
43 #include "llvm/Target/TargetLoweringObjectFile.h"
44 #include "llvm/Target/TargetOptions.h"
45 #include "llvm/Target/TargetRegisterInfo.h"
46 #include "llvm/ADT/SmallPtrSet.h"
47 #include "llvm/ADT/SmallString.h"
51 static cl::opt<cl::boolOrDefault>
52 AsmVerbose("asm-verbose", cl::desc("Add comments to directives."),
53 cl::init(cl::BOU_UNSET));
55 static bool getVerboseAsm(bool VDef) {
58 case cl::BOU_UNSET: return VDef;
59 case cl::BOU_TRUE: return true;
60 case cl::BOU_FALSE: return false;
64 char AsmPrinter::ID = 0;
65 AsmPrinter::AsmPrinter(formatted_raw_ostream &o, TargetMachine &tm,
66 const MCAsmInfo *T, bool VDef)
67 : MachineFunctionPass(&ID), FunctionNumber(0), O(o),
68 TM(tm), MAI(T), TRI(tm.getRegisterInfo()),
70 OutContext(*new MCContext()),
71 // FIXME: Pass instprinter to streamer.
72 OutStreamer(*createAsmStreamer(OutContext, O, *T,
73 TM.getTargetData()->isLittleEndian(),
74 getVerboseAsm(VDef), 0)),
76 LastMI(0), LastFn(0), Counter(~0U), PrevDLT(NULL) {
78 VerboseAsm = getVerboseAsm(VDef);
81 AsmPrinter::~AsmPrinter() {
82 for (gcp_iterator I = GCMetadataPrinters.begin(),
83 E = GCMetadataPrinters.end(); I != E; ++I)
90 TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
91 return TM.getTargetLowering()->getObjFileLowering();
94 /// getCurrentSection() - Return the current section we are emitting to.
95 const MCSection *AsmPrinter::getCurrentSection() const {
96 return OutStreamer.getCurrentSection();
100 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
101 AU.setPreservesAll();
102 MachineFunctionPass::getAnalysisUsage(AU);
103 AU.addRequired<GCModuleInfo>();
105 AU.addRequired<MachineLoopInfo>();
108 bool AsmPrinter::doInitialization(Module &M) {
109 // Initialize TargetLoweringObjectFile.
110 const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
111 .Initialize(OutContext, TM);
113 Mang = new Mangler(*MAI);
115 // Allow the target to emit any magic that it wants at the start of the file.
116 EmitStartOfAsmFile(M);
118 if (MAI->hasSingleParameterDotFile()) {
119 // Very minimal debug info. It is ignored if we emit actual
120 // debug info. If we don't, this at least helps the user find where
121 // a function came from.
122 O << "\t.file\t\"" << M.getModuleIdentifier() << "\"\n";
125 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
126 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
127 for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
128 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
129 MP->beginAssembly(O, *this, *MAI);
131 if (!M.getModuleInlineAsm().empty())
132 O << MAI->getCommentString() << " Start of file scope inline assembly\n"
133 << M.getModuleInlineAsm()
134 << '\n' << MAI->getCommentString()
135 << " End of file scope inline assembly\n";
137 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
139 MMI->AnalyzeModule(M);
140 DW = getAnalysisIfAvailable<DwarfWriter>();
142 DW->BeginModule(&M, MMI, O, this, MAI);
147 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
148 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
149 if (!GV->hasInitializer()) // External globals require no code.
152 // Check to see if this is a special global used by LLVM, if so, emit it.
153 if (EmitSpecialLLVMGlobal(GV))
156 MCSymbol *GVSym = GetGlobalValueSymbol(GV);
157 printVisibility(GVSym, GV->getVisibility());
159 if (MAI->hasDotTypeDotSizeDirective()) {
160 O << "\t.type\t" << *GVSym;
161 if (MAI->getCommentString()[0] != '@')
167 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
169 const TargetData *TD = TM.getTargetData();
170 unsigned Size = TD->getTypeAllocSize(GV->getType()->getElementType());
171 unsigned AlignLog = TD->getPreferredAlignmentLog(GV);
173 // Handle common and BSS local symbols (.lcomm).
174 if (GVKind.isCommon() || GVKind.isBSSLocal()) {
175 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
178 WriteAsOperand(OutStreamer.GetCommentOS(), GV,
179 /*PrintType=*/false, GV->getParent());
180 OutStreamer.GetCommentOS() << '\n';
183 // Handle common symbols.
184 if (GVKind.isCommon()) {
186 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
190 // Handle local BSS symbols.
191 if (MAI->hasMachoZeroFillDirective()) {
192 const MCSection *TheSection =
193 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
194 // .zerofill __DATA, __bss, _foo, 400, 5
195 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
199 if (const char *LComm = MAI->getLCOMMDirective()) {
201 O << LComm << *GVSym << ',' << Size << '\n';
206 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
208 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
212 const MCSection *TheSection =
213 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
215 // Handle the zerofill directive on darwin, which is a special form of BSS
217 if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
219 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
220 // .zerofill __DATA, __common, _foo, 400, 5
221 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
225 OutStreamer.SwitchSection(TheSection);
227 // TODO: Factor into an 'emit linkage' thing that is shared with function
229 switch (GV->getLinkage()) {
230 case GlobalValue::CommonLinkage:
231 case GlobalValue::LinkOnceAnyLinkage:
232 case GlobalValue::LinkOnceODRLinkage:
233 case GlobalValue::WeakAnyLinkage:
234 case GlobalValue::WeakODRLinkage:
235 case GlobalValue::LinkerPrivateLinkage:
236 if (MAI->getWeakDefDirective() != 0) {
238 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
239 // .weak_definition _foo
240 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
241 } else if (const char *LinkOnce = MAI->getLinkOnceDirective()) {
243 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
244 // .linkonce same_size
248 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
251 case GlobalValue::DLLExportLinkage:
252 case GlobalValue::AppendingLinkage:
253 // FIXME: appending linkage variables should go into a section of
254 // their name or something. For now, just emit them as external.
255 case GlobalValue::ExternalLinkage:
256 // If external or appending, declare as a global symbol.
258 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
260 case GlobalValue::PrivateLinkage:
261 case GlobalValue::InternalLinkage:
264 llvm_unreachable("Unknown linkage type!");
267 EmitAlignment(AlignLog, GV);
269 WriteAsOperand(OutStreamer.GetCommentOS(), GV,
270 /*PrintType=*/false, GV->getParent());
271 OutStreamer.GetCommentOS() << '\n';
273 OutStreamer.EmitLabel(GVSym);
275 EmitGlobalConstant(GV->getInitializer());
277 if (MAI->hasDotTypeDotSizeDirective())
278 O << "\t.size\t" << *GVSym << ", " << Size << '\n';
280 OutStreamer.AddBlankLine();
284 bool AsmPrinter::doFinalization(Module &M) {
285 // Emit global variables.
286 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
288 EmitGlobalVariable(I);
290 // Emit final debug information.
291 if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
294 // If the target wants to know about weak references, print them all.
295 if (MAI->getWeakRefDirective()) {
296 // FIXME: This is not lazy, it would be nice to only print weak references
297 // to stuff that is actually used. Note that doing so would require targets
298 // to notice uses in operands (due to constant exprs etc). This should
299 // happen with the MC stuff eventually.
301 // Print out module-level global variables here.
302 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
304 if (!I->hasExternalWeakLinkage()) continue;
305 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
309 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
310 if (!I->hasExternalWeakLinkage()) continue;
311 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
316 if (MAI->getSetDirective()) {
317 OutStreamer.AddBlankLine();
318 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
320 MCSymbol *Name = GetGlobalValueSymbol(I);
322 const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
323 MCSymbol *Target = GetGlobalValueSymbol(GV);
325 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
326 OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
327 else if (I->hasWeakLinkage())
328 OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
330 assert(I->hasLocalLinkage() && "Invalid alias linkage");
332 printVisibility(Name, I->getVisibility());
334 O << MAI->getSetDirective() << ' ' << *Name << ", " << *Target << '\n';
338 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
339 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
340 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
341 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
342 MP->finishAssembly(O, *this, *MAI);
344 // If we don't have any trampolines, then we don't require stack memory
345 // to be executable. Some targets have a directive to declare this.
346 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
347 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
348 // FIXME: This is actually a section switch on linux/x86 and systemz, use
350 if (MAI->getNonexecutableStackDirective())
351 O << MAI->getNonexecutableStackDirective() << '\n';
354 // Allow the target to emit any magic that it wants at the end of the file,
355 // after everything else has gone out.
358 delete Mang; Mang = 0;
361 OutStreamer.Finish();
365 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
366 // Get the function symbol.
367 CurrentFnSym = GetGlobalValueSymbol(MF.getFunction());
368 IncrementFunctionNumber();
371 LI = &getAnalysis<MachineLoopInfo>();
375 // SectionCPs - Keep track the alignment, constpool entries per Section.
379 SmallVector<unsigned, 4> CPEs;
380 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
384 /// EmitConstantPool - Print to the current output stream assembly
385 /// representations of the constants in the constant pool MCP. This is
386 /// used to print out constants which have been "spilled to memory" by
387 /// the code generator.
389 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
390 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
391 if (CP.empty()) return;
393 // Calculate sections for constant pool entries. We collect entries to go into
394 // the same section together to reduce amount of section switch statements.
395 SmallVector<SectionCPs, 4> CPSections;
396 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
397 const MachineConstantPoolEntry &CPE = CP[i];
398 unsigned Align = CPE.getAlignment();
401 switch (CPE.getRelocationInfo()) {
402 default: llvm_unreachable("Unknown section kind");
403 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
405 Kind = SectionKind::getReadOnlyWithRelLocal();
408 switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
409 case 4: Kind = SectionKind::getMergeableConst4(); break;
410 case 8: Kind = SectionKind::getMergeableConst8(); break;
411 case 16: Kind = SectionKind::getMergeableConst16();break;
412 default: Kind = SectionKind::getMergeableConst(); break;
416 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
418 // The number of sections are small, just do a linear search from the
419 // last section to the first.
421 unsigned SecIdx = CPSections.size();
422 while (SecIdx != 0) {
423 if (CPSections[--SecIdx].S == S) {
429 SecIdx = CPSections.size();
430 CPSections.push_back(SectionCPs(S, Align));
433 if (Align > CPSections[SecIdx].Alignment)
434 CPSections[SecIdx].Alignment = Align;
435 CPSections[SecIdx].CPEs.push_back(i);
438 // Now print stuff into the calculated sections.
439 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
440 OutStreamer.SwitchSection(CPSections[i].S);
441 EmitAlignment(Log2_32(CPSections[i].Alignment));
444 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
445 unsigned CPI = CPSections[i].CPEs[j];
446 MachineConstantPoolEntry CPE = CP[CPI];
448 // Emit inter-object padding for alignment.
449 unsigned AlignMask = CPE.getAlignment() - 1;
450 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
451 OutStreamer.EmitFill(NewOffset - Offset, 0/*fillval*/, 0/*addrspace*/);
453 const Type *Ty = CPE.getType();
454 Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
456 // Emit the label with a comment on it.
458 OutStreamer.GetCommentOS() << "constant pool ";
459 WriteTypeSymbolic(OutStreamer.GetCommentOS(), CPE.getType(),
460 MF->getFunction()->getParent());
461 OutStreamer.GetCommentOS() << '\n';
463 OutStreamer.EmitLabel(GetCPISymbol(CPI));
465 if (CPE.isMachineConstantPoolEntry())
466 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
468 EmitGlobalConstant(CPE.Val.ConstVal);
473 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
474 /// by the current function to the current output stream.
476 void AsmPrinter::EmitJumpTableInfo(MachineJumpTableInfo *MJTI,
477 MachineFunction &MF) {
478 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
479 if (JT.empty()) return;
481 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
483 // Pick the directive to use to print the jump table entries, and switch to
484 // the appropriate section.
485 TargetLowering *LoweringInfo = TM.getTargetLowering();
487 const Function *F = MF.getFunction();
488 bool JTInDiffSection = false;
489 if (F->isWeakForLinker() ||
490 (IsPic && !LoweringInfo->usesGlobalOffsetTable())) {
491 // In PIC mode, we need to emit the jump table to the same section as the
492 // function body itself, otherwise the label differences won't make sense.
493 // We should also do if the section name is NULL or function is declared in
494 // discardable section.
495 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang,
498 // Otherwise, drop it in the readonly section.
499 const MCSection *ReadOnlySection =
500 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
501 OutStreamer.SwitchSection(ReadOnlySection);
502 JTInDiffSection = true;
505 EmitAlignment(Log2_32(MJTI->getAlignment()));
507 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
508 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
510 // If this jump table was deleted, ignore it.
511 if (JTBBs.empty()) continue;
513 // For PIC codegen, if possible we want to use the SetDirective to reduce
514 // the number of relocations the assembler will generate for the jump table.
515 // Set directives are all printed before the jump table itself.
516 SmallPtrSet<MachineBasicBlock*, 16> EmittedSets;
517 if (MAI->getSetDirective() && IsPic)
518 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
519 if (EmittedSets.insert(JTBBs[ii]))
520 printPICJumpTableSetLabel(i, JTBBs[ii]);
522 // On some targets (e.g. Darwin) we want to emit two consequtive labels
523 // before each jump table. The first label is never referenced, but tells
524 // the assembler and linker the extents of the jump table object. The
525 // second label is actually referenced by the code.
526 if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
527 OutStreamer.EmitLabel(GetJTISymbol(i, true));
529 OutStreamer.EmitLabel(GetJTISymbol(i));
531 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
532 printPICJumpTableEntry(MJTI, JTBBs[ii], i);
538 void AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
539 const MachineBasicBlock *MBB,
540 unsigned uid) const {
541 bool isPIC = TM.getRelocationModel() == Reloc::PIC_;
543 // Use JumpTableDirective otherwise honor the entry size from the jump table
545 const char *JTEntryDirective = MAI->getJumpTableDirective(isPIC);
546 bool HadJTEntryDirective = JTEntryDirective != NULL;
547 if (!HadJTEntryDirective) {
548 JTEntryDirective = MJTI->getEntrySize() == 4 ?
549 MAI->getData32bitsDirective() : MAI->getData64bitsDirective();
552 O << JTEntryDirective << ' ';
554 // If we have emitted set directives for the jump table entries, print
555 // them rather than the entries themselves. If we're emitting PIC, then
556 // emit the table entries as differences between two text section labels.
557 // If we're emitting non-PIC code, then emit the entries as direct
558 // references to the target basic blocks.
560 O << *GetMBBSymbol(MBB->getNumber());
561 } else if (MAI->getSetDirective()) {
562 O << MAI->getPrivateGlobalPrefix() << getFunctionNumber()
563 << '_' << uid << "_set_" << MBB->getNumber();
565 O << *GetMBBSymbol(MBB->getNumber());
566 // If the arch uses custom Jump Table directives, don't calc relative to
568 if (!HadJTEntryDirective)
569 O << '-' << *GetJTISymbol(uid);
574 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
575 /// special global used by LLVM. If so, emit it and return true, otherwise
576 /// do nothing and return false.
577 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
578 if (GV->getName() == "llvm.used") {
579 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
580 EmitLLVMUsedList(GV->getInitializer());
584 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
585 if (GV->getSection() == "llvm.metadata" ||
586 GV->hasAvailableExternallyLinkage())
589 if (!GV->hasAppendingLinkage()) return false;
591 assert(GV->hasInitializer() && "Not a special LLVM global!");
593 const TargetData *TD = TM.getTargetData();
594 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
595 if (GV->getName() == "llvm.global_ctors") {
596 OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
597 EmitAlignment(Align, 0);
598 EmitXXStructorList(GV->getInitializer());
600 if (TM.getRelocationModel() == Reloc::Static &&
601 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
602 StringRef Sym(".constructors_used");
603 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
609 if (GV->getName() == "llvm.global_dtors") {
610 OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
611 EmitAlignment(Align, 0);
612 EmitXXStructorList(GV->getInitializer());
614 if (TM.getRelocationModel() == Reloc::Static &&
615 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
616 StringRef Sym(".destructors_used");
617 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
626 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
627 /// global in the specified llvm.used list for which emitUsedDirectiveFor
628 /// is true, as being used with this directive.
629 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
630 // Should be an array of 'i8*'.
631 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
632 if (InitList == 0) return;
634 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
635 const GlobalValue *GV =
636 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
637 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
638 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(GV),
643 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
644 /// function pointers, ignoring the init priority.
645 void AsmPrinter::EmitXXStructorList(Constant *List) {
646 // Should be an array of '{ int, void ()* }' structs. The first value is the
647 // init priority, which we ignore.
648 if (!isa<ConstantArray>(List)) return;
649 ConstantArray *InitList = cast<ConstantArray>(List);
650 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
651 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
652 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
654 if (CS->getOperand(1)->isNullValue())
655 return; // Found a null terminator, exit printing.
656 // Emit the function pointer.
657 EmitGlobalConstant(CS->getOperand(1));
661 //===--------------------------------------------------------------------===//
662 // Emission and print routines
665 /// EmitInt8 - Emit a byte directive and value.
667 void AsmPrinter::EmitInt8(int Value) const {
668 OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
671 /// EmitInt16 - Emit a short directive and value.
673 void AsmPrinter::EmitInt16(int Value) const {
674 OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
677 /// EmitInt32 - Emit a long directive and value.
679 void AsmPrinter::EmitInt32(int Value) const {
680 OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
683 /// EmitInt64 - Emit a long long directive and value.
685 void AsmPrinter::EmitInt64(uint64_t Value) const {
686 OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
690 /// toOctal - Convert the low order bits of X into an octal digit.
692 static inline char toOctal(int X) {
696 /// printStringChar - Print a char, escaped if necessary.
698 static void printStringChar(formatted_raw_ostream &O, unsigned char C) {
701 } else if (C == '\\') {
703 } else if (isprint((unsigned char)C)) {
707 case '\b': O << "\\b"; break;
708 case '\f': O << "\\f"; break;
709 case '\n': O << "\\n"; break;
710 case '\r': O << "\\r"; break;
711 case '\t': O << "\\t"; break;
714 O << toOctal(C >> 6);
715 O << toOctal(C >> 3);
716 O << toOctal(C >> 0);
722 /// EmitFile - Emit a .file directive.
723 void AsmPrinter::EmitFile(unsigned Number, StringRef Name) const {
724 O << "\t.file\t" << Number << " \"";
725 for (unsigned i = 0, N = Name.size(); i < N; ++i)
726 printStringChar(O, Name[i]);
731 //===----------------------------------------------------------------------===//
733 // EmitAlignment - Emit an alignment directive to the specified power of
734 // two boundary. For example, if you pass in 3 here, you will get an 8
735 // byte alignment. If a global value is specified, and if that global has
736 // an explicit alignment requested, it will unconditionally override the
737 // alignment request. However, if ForcedAlignBits is specified, this value
738 // has final say: the ultimate alignment will be the max of ForcedAlignBits
739 // and the alignment computed with NumBits and the global.
743 // if (GV && GV->hasalignment) Align = GV->getalignment();
744 // Align = std::max(Align, ForcedAlignBits);
746 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
747 unsigned ForcedAlignBits,
748 bool UseFillExpr) const {
749 if (GV && GV->getAlignment())
750 NumBits = Log2_32(GV->getAlignment());
751 NumBits = std::max(NumBits, ForcedAlignBits);
753 if (NumBits == 0) return; // No need to emit alignment.
755 unsigned FillValue = 0;
756 if (getCurrentSection()->getKind().isText())
757 FillValue = MAI->getTextAlignFillValue();
759 OutStreamer.EmitValueToAlignment(1 << NumBits, FillValue, 1, 0);
762 /// LowerConstant - Lower the specified LLVM Constant to an MCExpr.
764 static const MCExpr *LowerConstant(const Constant *CV, AsmPrinter &AP) {
765 MCContext &Ctx = AP.OutContext;
767 if (CV->isNullValue() || isa<UndefValue>(CV))
768 return MCConstantExpr::Create(0, Ctx);
770 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
771 return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
773 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
774 return MCSymbolRefExpr::Create(AP.GetGlobalValueSymbol(GV), Ctx);
775 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
776 return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
778 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
780 llvm_unreachable("Unknown constant value to lower!");
781 return MCConstantExpr::Create(0, Ctx);
784 switch (CE->getOpcode()) {
785 case Instruction::ZExt:
786 case Instruction::SExt:
787 case Instruction::FPTrunc:
788 case Instruction::FPExt:
789 case Instruction::UIToFP:
790 case Instruction::SIToFP:
791 case Instruction::FPToUI:
792 case Instruction::FPToSI:
793 default: llvm_unreachable("FIXME: Don't support this constant cast expr");
794 case Instruction::GetElementPtr: {
795 const TargetData &TD = *AP.TM.getTargetData();
796 // Generate a symbolic expression for the byte address
797 const Constant *PtrVal = CE->getOperand(0);
798 SmallVector<Value*, 8> IdxVec(CE->op_begin()+1, CE->op_end());
799 int64_t Offset = TD.getIndexedOffset(PtrVal->getType(), &IdxVec[0],
802 const MCExpr *Base = LowerConstant(CE->getOperand(0), AP);
806 // Truncate/sext the offset to the pointer size.
807 if (TD.getPointerSizeInBits() != 64) {
808 int SExtAmount = 64-TD.getPointerSizeInBits();
809 Offset = (Offset << SExtAmount) >> SExtAmount;
812 return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
816 case Instruction::Trunc:
817 // We emit the value and depend on the assembler to truncate the generated
818 // expression properly. This is important for differences between
819 // blockaddress labels. Since the two labels are in the same function, it
820 // is reasonable to treat their delta as a 32-bit value.
822 case Instruction::BitCast:
823 return LowerConstant(CE->getOperand(0), AP);
825 case Instruction::IntToPtr: {
826 const TargetData &TD = *AP.TM.getTargetData();
827 // Handle casts to pointers by changing them into casts to the appropriate
828 // integer type. This promotes constant folding and simplifies this code.
829 Constant *Op = CE->getOperand(0);
830 Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
832 return LowerConstant(Op, AP);
835 case Instruction::PtrToInt: {
836 const TargetData &TD = *AP.TM.getTargetData();
837 // Support only foldable casts to/from pointers that can be eliminated by
838 // changing the pointer to the appropriately sized integer type.
839 Constant *Op = CE->getOperand(0);
840 const Type *Ty = CE->getType();
842 const MCExpr *OpExpr = LowerConstant(Op, AP);
844 // We can emit the pointer value into this slot if the slot is an
845 // integer slot equal to the size of the pointer.
846 if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
849 // Otherwise the pointer is smaller than the resultant integer, mask off
850 // the high bits so we are sure to get a proper truncation if the input is
852 unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
853 const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
854 return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
857 case Instruction::Add:
858 case Instruction::Sub:
859 case Instruction::And:
860 case Instruction::Or:
861 case Instruction::Xor: {
862 const MCExpr *LHS = LowerConstant(CE->getOperand(0), AP);
863 const MCExpr *RHS = LowerConstant(CE->getOperand(1), AP);
864 switch (CE->getOpcode()) {
865 default: llvm_unreachable("Unknown binary operator constant cast expr");
866 case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
867 case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
868 case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
869 case Instruction::Or: return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
870 case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
876 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
878 if (AddrSpace != 0 || !CA->isString()) {
879 // Not a string. Print the values in successive locations
880 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
881 AP.EmitGlobalConstant(CA->getOperand(i), AddrSpace);
885 // Otherwise, it can be emitted as .ascii.
886 SmallVector<char, 128> TmpVec;
887 TmpVec.reserve(CA->getNumOperands());
888 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
889 TmpVec.push_back(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
891 AP.OutStreamer.EmitBytes(StringRef(TmpVec.data(), TmpVec.size()), AddrSpace);
894 static void EmitGlobalConstantVector(const ConstantVector *CV,
895 unsigned AddrSpace, AsmPrinter &AP) {
896 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
897 AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
900 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
901 unsigned AddrSpace, AsmPrinter &AP) {
902 // Print the fields in successive locations. Pad to align if needed!
903 const TargetData *TD = AP.TM.getTargetData();
904 unsigned Size = TD->getTypeAllocSize(CS->getType());
905 const StructLayout *Layout = TD->getStructLayout(CS->getType());
906 uint64_t SizeSoFar = 0;
907 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
908 const Constant *Field = CS->getOperand(i);
910 // Check if padding is needed and insert one or more 0s.
911 uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
912 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
913 - Layout->getElementOffset(i)) - FieldSize;
914 SizeSoFar += FieldSize + PadSize;
916 // Now print the actual field value.
917 AP.EmitGlobalConstant(Field, AddrSpace);
919 // Insert padding - this may include padding to increase the size of the
920 // current field up to the ABI size (if the struct is not packed) as well
921 // as padding to ensure that the next field starts at the right offset.
922 AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
924 assert(SizeSoFar == Layout->getSizeInBytes() &&
925 "Layout of constant struct may be incorrect!");
928 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
930 // FP Constants are printed as integer constants to avoid losing
932 if (CFP->getType()->isDoubleTy()) {
934 double Val = CFP->getValueAPF().convertToDouble();
935 AP.OutStreamer.GetCommentOS() << "double " << Val << '\n';
938 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
939 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
943 if (CFP->getType()->isFloatTy()) {
945 float Val = CFP->getValueAPF().convertToFloat();
946 AP.OutStreamer.GetCommentOS() << "float " << Val << '\n';
948 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
949 AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
953 if (CFP->getType()->isX86_FP80Ty()) {
954 // all long double variants are printed as hex
955 // api needed to prevent premature destruction
956 APInt API = CFP->getValueAPF().bitcastToAPInt();
957 const uint64_t *p = API.getRawData();
959 // Convert to double so we can print the approximate val as a comment.
960 APFloat DoubleVal = CFP->getValueAPF();
962 DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
964 AP.OutStreamer.GetCommentOS() << "x86_fp80 ~= "
965 << DoubleVal.convertToDouble() << '\n';
968 if (AP.TM.getTargetData()->isBigEndian()) {
969 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
970 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
972 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
973 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
976 // Emit the tail padding for the long double.
977 const TargetData &TD = *AP.TM.getTargetData();
978 AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
979 TD.getTypeStoreSize(CFP->getType()), AddrSpace);
983 assert(CFP->getType()->isPPC_FP128Ty() &&
984 "Floating point constant type not handled");
985 // All long double variants are printed as hex api needed to prevent
986 // premature destruction.
987 APInt API = CFP->getValueAPF().bitcastToAPInt();
988 const uint64_t *p = API.getRawData();
989 if (AP.TM.getTargetData()->isBigEndian()) {
990 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
991 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
993 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
994 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
998 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
999 unsigned AddrSpace, AsmPrinter &AP) {
1000 const TargetData *TD = AP.TM.getTargetData();
1001 unsigned BitWidth = CI->getBitWidth();
1002 assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
1004 // We don't expect assemblers to support integer data directives
1005 // for more than 64 bits, so we emit the data in at most 64-bit
1006 // quantities at a time.
1007 const uint64_t *RawData = CI->getValue().getRawData();
1008 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1009 uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1010 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1014 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1015 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1016 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
1017 uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1018 return OutStreamer.EmitZeros(Size, AddrSpace);
1021 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1022 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1029 OutStreamer.GetCommentOS() << format("0x%llx\n", CI->getZExtValue());
1030 OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1033 EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
1038 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1039 return EmitGlobalConstantArray(CVA, AddrSpace, *this);
1041 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1042 return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
1044 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1045 return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1047 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1048 return EmitGlobalConstantVector(V, AddrSpace, *this);
1050 if (isa<ConstantPointerNull>(CV)) {
1051 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1052 OutStreamer.EmitIntValue(0, Size, AddrSpace);
1056 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
1057 // thread the streamer with EmitValue.
1058 OutStreamer.EmitValue(LowerConstant(CV, *this),
1059 TM.getTargetData()->getTypeAllocSize(CV->getType()),
1063 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1064 // Target doesn't support this yet!
1065 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1068 /// PrintSpecial - Print information related to the specified machine instr
1069 /// that is independent of the operand, and may be independent of the instr
1070 /// itself. This can be useful for portably encoding the comment character
1071 /// or other bits of target-specific knowledge into the asmstrings. The
1072 /// syntax used is ${:comment}. Targets can override this to add support
1073 /// for their own strange codes.
1074 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1075 if (!strcmp(Code, "private")) {
1076 O << MAI->getPrivateGlobalPrefix();
1077 } else if (!strcmp(Code, "comment")) {
1079 O << MAI->getCommentString();
1080 } else if (!strcmp(Code, "uid")) {
1081 // Comparing the address of MI isn't sufficient, because machineinstrs may
1082 // be allocated to the same address across functions.
1083 const Function *ThisF = MI->getParent()->getParent()->getFunction();
1085 // If this is a new LastFn instruction, bump the counter.
1086 if (LastMI != MI || LastFn != ThisF) {
1094 raw_string_ostream Msg(msg);
1095 Msg << "Unknown special formatter '" << Code
1096 << "' for machine instr: " << *MI;
1097 llvm_report_error(Msg.str());
1101 /// processDebugLoc - Processes the debug information of each machine
1102 /// instruction's DebugLoc.
1103 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1104 bool BeforePrintingInsn) {
1105 if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1106 || !DW->ShouldEmitDwarfDebug())
1108 DebugLoc DL = MI->getDebugLoc();
1111 DILocation CurDLT = MF->getDILocation(DL);
1112 if (CurDLT.getScope().isNull())
1115 if (!BeforePrintingInsn) {
1116 // After printing instruction
1118 } else if (CurDLT.getNode() != PrevDLT) {
1119 unsigned L = DW->RecordSourceLine(CurDLT.getLineNumber(),
1120 CurDLT.getColumnNumber(),
1121 CurDLT.getScope().getNode());
1124 DW->BeginScope(MI, L);
1125 PrevDLT = CurDLT.getNode();
1130 /// printInlineAsm - This method formats and prints the specified machine
1131 /// instruction that is an inline asm.
1132 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1133 unsigned NumOperands = MI->getNumOperands();
1135 // Count the number of register definitions.
1136 unsigned NumDefs = 0;
1137 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1139 assert(NumDefs != NumOperands-1 && "No asm string?");
1141 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1143 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1144 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1148 // If this asmstr is empty, just print the #APP/#NOAPP markers.
1149 // These are useful to see where empty asm's wound up.
1150 if (AsmStr[0] == 0) {
1151 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1152 O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1156 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1158 // The variant of the current asmprinter.
1159 int AsmPrinterVariant = MAI->getAssemblerDialect();
1161 int CurVariant = -1; // The number of the {.|.|.} region we are in.
1162 const char *LastEmitted = AsmStr; // One past the last character emitted.
1164 while (*LastEmitted) {
1165 switch (*LastEmitted) {
1167 // Not a special case, emit the string section literally.
1168 const char *LiteralEnd = LastEmitted+1;
1169 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1170 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1172 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1173 O.write(LastEmitted, LiteralEnd-LastEmitted);
1174 LastEmitted = LiteralEnd;
1178 ++LastEmitted; // Consume newline character.
1179 O << '\n'; // Indent code with newline.
1182 ++LastEmitted; // Consume '$' character.
1186 switch (*LastEmitted) {
1187 default: Done = false; break;
1188 case '$': // $$ -> $
1189 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1191 ++LastEmitted; // Consume second '$' character.
1193 case '(': // $( -> same as GCC's { character.
1194 ++LastEmitted; // Consume '(' character.
1195 if (CurVariant != -1) {
1196 llvm_report_error("Nested variants found in inline asm string: '"
1197 + std::string(AsmStr) + "'");
1199 CurVariant = 0; // We're in the first variant now.
1202 ++LastEmitted; // consume '|' character.
1203 if (CurVariant == -1)
1204 O << '|'; // this is gcc's behavior for | outside a variant
1206 ++CurVariant; // We're in the next variant.
1208 case ')': // $) -> same as GCC's } char.
1209 ++LastEmitted; // consume ')' character.
1210 if (CurVariant == -1)
1211 O << '}'; // this is gcc's behavior for } outside a variant
1218 bool HasCurlyBraces = false;
1219 if (*LastEmitted == '{') { // ${variable}
1220 ++LastEmitted; // Consume '{' character.
1221 HasCurlyBraces = true;
1224 // If we have ${:foo}, then this is not a real operand reference, it is a
1225 // "magic" string reference, just like in .td files. Arrange to call
1227 if (HasCurlyBraces && *LastEmitted == ':') {
1229 const char *StrStart = LastEmitted;
1230 const char *StrEnd = strchr(StrStart, '}');
1232 llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1233 + std::string(AsmStr) + "'");
1236 std::string Val(StrStart, StrEnd);
1237 PrintSpecial(MI, Val.c_str());
1238 LastEmitted = StrEnd+1;
1242 const char *IDStart = LastEmitted;
1245 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1246 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1247 llvm_report_error("Bad $ operand number in inline asm string: '"
1248 + std::string(AsmStr) + "'");
1250 LastEmitted = IDEnd;
1252 char Modifier[2] = { 0, 0 };
1254 if (HasCurlyBraces) {
1255 // If we have curly braces, check for a modifier character. This
1256 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1257 if (*LastEmitted == ':') {
1258 ++LastEmitted; // Consume ':' character.
1259 if (*LastEmitted == 0) {
1260 llvm_report_error("Bad ${:} expression in inline asm string: '"
1261 + std::string(AsmStr) + "'");
1264 Modifier[0] = *LastEmitted;
1265 ++LastEmitted; // Consume modifier character.
1268 if (*LastEmitted != '}') {
1269 llvm_report_error("Bad ${} expression in inline asm string: '"
1270 + std::string(AsmStr) + "'");
1272 ++LastEmitted; // Consume '}' character.
1275 if ((unsigned)Val >= NumOperands-1) {
1276 llvm_report_error("Invalid $ operand number in inline asm string: '"
1277 + std::string(AsmStr) + "'");
1280 // Okay, we finally have a value number. Ask the target to print this
1282 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1287 // Scan to find the machine operand number for the operand.
1288 for (; Val; --Val) {
1289 if (OpNo >= MI->getNumOperands()) break;
1290 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1291 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1294 if (OpNo >= MI->getNumOperands()) {
1297 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1298 ++OpNo; // Skip over the ID number.
1300 if (Modifier[0] == 'l') // labels are target independent
1301 O << *GetMBBSymbol(MI->getOperand(OpNo).getMBB()->getNumber());
1303 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1304 if ((OpFlags & 7) == 4) {
1305 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1306 Modifier[0] ? Modifier : 0);
1308 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1309 Modifier[0] ? Modifier : 0);
1315 raw_string_ostream Msg(msg);
1316 Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1318 llvm_report_error(Msg.str());
1325 O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1328 /// printImplicitDef - This method prints the specified machine instruction
1329 /// that is an implicit def.
1330 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1331 if (!VerboseAsm) return;
1332 O.PadToColumn(MAI->getCommentColumn());
1333 O << MAI->getCommentString() << " implicit-def: "
1334 << TRI->getName(MI->getOperand(0).getReg());
1337 void AsmPrinter::printKill(const MachineInstr *MI) const {
1338 if (!VerboseAsm) return;
1339 O.PadToColumn(MAI->getCommentColumn());
1340 O << MAI->getCommentString() << " kill:";
1341 for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1342 const MachineOperand &op = MI->getOperand(n);
1343 assert(op.isReg() && "KILL instruction must have only register operands");
1344 O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1348 /// printLabel - This method prints a local label used by debug and
1349 /// exception handling tables.
1350 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1351 printLabel(MI->getOperand(0).getImm());
1354 void AsmPrinter::printLabel(unsigned Id) const {
1355 O << MAI->getPrivateGlobalPrefix() << "label" << Id << ':';
1358 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1359 /// instruction, using the specified assembler variant. Targets should
1360 /// override this to format as appropriate.
1361 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1362 unsigned AsmVariant, const char *ExtraCode) {
1363 // Target doesn't support this yet!
1367 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1368 unsigned AsmVariant,
1369 const char *ExtraCode) {
1370 // Target doesn't support this yet!
1374 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA,
1375 const char *Suffix) const {
1376 return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock(), Suffix);
1379 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1380 const BasicBlock *BB,
1381 const char *Suffix) const {
1382 assert(BB->hasName() &&
1383 "Address of anonymous basic block not supported yet!");
1385 // This code must use the function name itself, and not the function number,
1386 // since it must be possible to generate the label name from within other
1388 SmallString<60> FnName;
1389 Mang->getNameWithPrefix(FnName, F, false);
1391 // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1392 SmallString<60> NameResult;
1393 Mang->getNameWithPrefix(NameResult,
1394 StringRef("BA") + Twine((unsigned)FnName.size()) +
1395 "_" + FnName.str() + "_" + BB->getName() + Suffix,
1398 return OutContext.GetOrCreateSymbol(NameResult.str());
1401 MCSymbol *AsmPrinter::GetMBBSymbol(unsigned MBBID) const {
1402 SmallString<60> Name;
1403 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "BB"
1404 << getFunctionNumber() << '_' << MBBID;
1405 return OutContext.GetOrCreateSymbol(Name.str());
1408 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1409 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1410 SmallString<60> Name;
1411 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "CPI"
1412 << getFunctionNumber() << '_' << CPID;
1413 return OutContext.GetOrCreateSymbol(Name.str());
1416 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1417 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1418 const char *Prefix = isLinkerPrivate ? MAI->getLinkerPrivateGlobalPrefix() :
1419 MAI->getPrivateGlobalPrefix();
1420 SmallString<60> Name;
1421 raw_svector_ostream(Name) << Prefix << "JTI" << getFunctionNumber() << '_'
1423 return OutContext.GetOrCreateSymbol(Name.str());
1426 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
1428 MCSymbol *AsmPrinter::GetGlobalValueSymbol(const GlobalValue *GV) const {
1429 SmallString<60> NameStr;
1430 Mang->getNameWithPrefix(NameStr, GV, false);
1431 return OutContext.GetOrCreateSymbol(NameStr.str());
1434 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1435 /// global value name as its base, with the specified suffix, and where the
1436 /// symbol is forced to have private linkage if ForcePrivate is true.
1437 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1439 bool ForcePrivate) const {
1440 SmallString<60> NameStr;
1441 Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1442 NameStr.append(Suffix.begin(), Suffix.end());
1443 return OutContext.GetOrCreateSymbol(NameStr.str());
1446 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1448 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1449 SmallString<60> NameStr;
1450 Mang->getNameWithPrefix(NameStr, Sym);
1451 return OutContext.GetOrCreateSymbol(NameStr.str());
1456 /// PrintParentLoopComment - Print comments about parent loops of this one.
1457 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1458 unsigned FunctionNumber) {
1459 if (Loop == 0) return;
1460 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
1461 OS.indent(Loop->getLoopDepth()*2)
1462 << "Parent Loop BB" << FunctionNumber << "_"
1463 << Loop->getHeader()->getNumber()
1464 << " Depth=" << Loop->getLoopDepth() << '\n';
1468 /// PrintChildLoopComment - Print comments about child loops within
1469 /// the loop for this basic block, with nesting.
1470 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1471 unsigned FunctionNumber) {
1472 // Add child loop information
1473 for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
1474 OS.indent((*CL)->getLoopDepth()*2)
1475 << "Child Loop BB" << FunctionNumber << "_"
1476 << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
1478 PrintChildLoopComment(OS, *CL, FunctionNumber);
1482 /// EmitComments - Pretty-print comments for basic blocks.
1483 static void PrintBasicBlockLoopComments(const MachineBasicBlock &MBB,
1484 const MachineLoopInfo *LI,
1485 const AsmPrinter &AP) {
1486 // Add loop depth information
1487 const MachineLoop *Loop = LI->getLoopFor(&MBB);
1488 if (Loop == 0) return;
1490 MachineBasicBlock *Header = Loop->getHeader();
1491 assert(Header && "No header for loop");
1493 // If this block is not a loop header, just print out what is the loop header
1495 if (Header != &MBB) {
1496 AP.OutStreamer.AddComment(" in Loop: Header=BB" +
1497 Twine(AP.getFunctionNumber())+"_" +
1498 Twine(Loop->getHeader()->getNumber())+
1499 " Depth="+Twine(Loop->getLoopDepth()));
1503 // Otherwise, it is a loop header. Print out information about child and
1505 raw_ostream &OS = AP.OutStreamer.GetCommentOS();
1507 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
1510 OS.indent(Loop->getLoopDepth()*2-2);
1515 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
1517 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
1521 /// EmitBasicBlockStart - This method prints the label for the specified
1522 /// MachineBasicBlock, an alignment (if present) and a comment describing
1523 /// it if appropriate.
1524 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1525 // Emit an alignment directive for this block, if needed.
1526 if (unsigned Align = MBB->getAlignment())
1527 EmitAlignment(Log2_32(Align));
1529 // If the block has its address taken, emit a special label to satisfy
1530 // references to the block. This is done so that we don't need to
1531 // remember the number of this label, and so that we can make
1532 // forward references to labels without knowing what their numbers
1534 if (MBB->hasAddressTaken()) {
1535 const BasicBlock *BB = MBB->getBasicBlock();
1537 OutStreamer.AddComment("Address Taken");
1538 OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1541 // Print the main label for the block.
1542 if (MBB->pred_empty() || MBB->isOnlyReachableByFallthrough()) {
1544 // NOTE: Want this comment at start of line.
1545 O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1546 if (const BasicBlock *BB = MBB->getBasicBlock())
1548 OutStreamer.AddComment("%" + BB->getName());
1550 PrintBasicBlockLoopComments(*MBB, LI, *this);
1551 OutStreamer.AddBlankLine();
1555 if (const BasicBlock *BB = MBB->getBasicBlock())
1557 OutStreamer.AddComment("%" + BB->getName());
1558 PrintBasicBlockLoopComments(*MBB, LI, *this);
1561 OutStreamer.EmitLabel(GetMBBSymbol(MBB->getNumber()));
1565 /// printPICJumpTableSetLabel - This method prints a set label for the
1566 /// specified MachineBasicBlock for a jumptable entry.
1567 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
1568 const MachineBasicBlock *MBB) const {
1569 if (!MAI->getSetDirective())
1572 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1573 << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ','
1574 << *GetMBBSymbol(MBB->getNumber())
1575 << '-' << *GetJTISymbol(uid) << '\n';
1578 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
1579 const MachineBasicBlock *MBB) const {
1580 if (!MAI->getSetDirective())
1583 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1584 << getFunctionNumber() << '_' << uid << '_' << uid2
1585 << "_set_" << MBB->getNumber() << ','
1586 << *GetMBBSymbol(MBB->getNumber())
1587 << '-' << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1588 << '_' << uid << '_' << uid2 << '\n';
1591 void AsmPrinter::printVisibility(const MCSymbol *Sym,
1592 unsigned Visibility) const {
1593 if (Visibility == GlobalValue::HiddenVisibility) {
1594 if (const char *Directive = MAI->getHiddenDirective())
1595 O << Directive << *Sym << '\n';
1596 } else if (Visibility == GlobalValue::ProtectedVisibility) {
1597 if (const char *Directive = MAI->getProtectedDirective())
1598 O << Directive << *Sym << '\n';
1602 void AsmPrinter::printOffset(int64_t Offset) const {
1605 else if (Offset < 0)
1609 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1610 if (!S->usesMetadata())
1613 gcp_iterator GCPI = GCMetadataPrinters.find(S);
1614 if (GCPI != GCMetadataPrinters.end())
1615 return GCPI->second;
1617 const char *Name = S->getName().c_str();
1619 for (GCMetadataPrinterRegistry::iterator
1620 I = GCMetadataPrinterRegistry::begin(),
1621 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1622 if (strcmp(Name, I->getName()) == 0) {
1623 GCMetadataPrinter *GMP = I->instantiate();
1625 GCMetadataPrinters.insert(std::make_pair(S, GMP));
1629 llvm_report_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
1633 /// EmitComments - Pretty-print comments for instructions
1634 void AsmPrinter::EmitComments(const MachineInstr &MI) const {
1638 bool Newline = false;
1640 if (!MI.getDebugLoc().isUnknown()) {
1641 DILocation DLT = MF->getDILocation(MI.getDebugLoc());
1643 // Print source line info.
1644 O.PadToColumn(MAI->getCommentColumn());
1645 O << MAI->getCommentString() << ' ';
1646 DIScope Scope = DLT.getScope();
1647 // Omit the directory, because it's likely to be long and uninteresting.
1648 if (!Scope.isNull())
1649 O << Scope.getFilename();
1652 O << ':' << DLT.getLineNumber();
1653 if (DLT.getColumnNumber() != 0)
1654 O << ':' << DLT.getColumnNumber();
1658 // Check for spills and reloads
1661 const MachineFrameInfo *FrameInfo =
1662 MI.getParent()->getParent()->getFrameInfo();
1664 // We assume a single instruction only has a spill or reload, not
1666 const MachineMemOperand *MMO;
1667 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
1668 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1669 MMO = *MI.memoperands_begin();
1670 if (Newline) O << '\n';
1671 O.PadToColumn(MAI->getCommentColumn());
1672 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Reload";
1676 else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
1677 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1678 if (Newline) O << '\n';
1679 O.PadToColumn(MAI->getCommentColumn());
1680 O << MAI->getCommentString() << ' '
1681 << MMO->getSize() << "-byte Folded Reload";
1685 else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
1686 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1687 MMO = *MI.memoperands_begin();
1688 if (Newline) O << '\n';
1689 O.PadToColumn(MAI->getCommentColumn());
1690 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Spill";
1694 else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
1695 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1696 if (Newline) O << '\n';
1697 O.PadToColumn(MAI->getCommentColumn());
1698 O << MAI->getCommentString() << ' '
1699 << MMO->getSize() << "-byte Folded Spill";
1704 // Check for spill-induced copies
1705 unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1706 if (TM.getInstrInfo()->isMoveInstr(MI, SrcReg, DstReg,
1707 SrcSubIdx, DstSubIdx)) {
1708 if (MI.getAsmPrinterFlag(ReloadReuse)) {
1709 if (Newline) O << '\n';
1710 O.PadToColumn(MAI->getCommentColumn());
1711 O << MAI->getCommentString() << " Reload Reuse";