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 // Very minimal debug info. It is ignored if we emit actual debug info. If we
119 // don't, this at least helps the user find where a global came from.
120 if (MAI->hasSingleParameterDotFile()) {
122 OutStreamer.EmitFileDirective(M.getModuleIdentifier());
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 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
162 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
164 const TargetData *TD = TM.getTargetData();
165 unsigned Size = TD->getTypeAllocSize(GV->getType()->getElementType());
166 unsigned AlignLog = TD->getPreferredAlignmentLog(GV);
168 // Handle common and BSS local symbols (.lcomm).
169 if (GVKind.isCommon() || GVKind.isBSSLocal()) {
170 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
173 WriteAsOperand(OutStreamer.GetCommentOS(), GV,
174 /*PrintType=*/false, GV->getParent());
175 OutStreamer.GetCommentOS() << '\n';
178 // Handle common symbols.
179 if (GVKind.isCommon()) {
181 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
185 // Handle local BSS symbols.
186 if (MAI->hasMachoZeroFillDirective()) {
187 const MCSection *TheSection =
188 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
189 // .zerofill __DATA, __bss, _foo, 400, 5
190 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
194 if (MAI->hasLCOMMDirective()) {
196 OutStreamer.EmitLocalCommonSymbol(GVSym, Size);
201 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
203 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
207 const MCSection *TheSection =
208 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
210 // Handle the zerofill directive on darwin, which is a special form of BSS
212 if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
214 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
215 // .zerofill __DATA, __common, _foo, 400, 5
216 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
220 OutStreamer.SwitchSection(TheSection);
222 // TODO: Factor into an 'emit linkage' thing that is shared with function
224 switch (GV->getLinkage()) {
225 case GlobalValue::CommonLinkage:
226 case GlobalValue::LinkOnceAnyLinkage:
227 case GlobalValue::LinkOnceODRLinkage:
228 case GlobalValue::WeakAnyLinkage:
229 case GlobalValue::WeakODRLinkage:
230 case GlobalValue::LinkerPrivateLinkage:
231 if (MAI->getWeakDefDirective() != 0) {
233 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
234 // .weak_definition _foo
235 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
236 } else if (const char *LinkOnce = MAI->getLinkOnceDirective()) {
238 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
239 // FIXME: linkonce should be a section attribute, handled by COFF Section
241 // http://sourceware.org/binutils/docs-2.20/as/Linkonce.html#Linkonce
242 // .linkonce same_size
246 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
249 case GlobalValue::DLLExportLinkage:
250 case GlobalValue::AppendingLinkage:
251 // FIXME: appending linkage variables should go into a section of
252 // their name or something. For now, just emit them as external.
253 case GlobalValue::ExternalLinkage:
254 // If external or appending, declare as a global symbol.
256 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
258 case GlobalValue::PrivateLinkage:
259 case GlobalValue::InternalLinkage:
262 llvm_unreachable("Unknown linkage type!");
265 EmitAlignment(AlignLog, GV);
267 WriteAsOperand(OutStreamer.GetCommentOS(), GV,
268 /*PrintType=*/false, GV->getParent());
269 OutStreamer.GetCommentOS() << '\n';
271 OutStreamer.EmitLabel(GVSym);
273 EmitGlobalConstant(GV->getInitializer());
275 if (MAI->hasDotTypeDotSizeDirective())
277 OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
279 OutStreamer.AddBlankLine();
283 bool AsmPrinter::doFinalization(Module &M) {
284 // Emit global variables.
285 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
287 EmitGlobalVariable(I);
289 // Emit final debug information.
290 if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
293 // If the target wants to know about weak references, print them all.
294 if (MAI->getWeakRefDirective()) {
295 // FIXME: This is not lazy, it would be nice to only print weak references
296 // to stuff that is actually used. Note that doing so would require targets
297 // to notice uses in operands (due to constant exprs etc). This should
298 // happen with the MC stuff eventually.
300 // Print out module-level global variables here.
301 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
303 if (!I->hasExternalWeakLinkage()) continue;
304 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
308 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
309 if (!I->hasExternalWeakLinkage()) continue;
310 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
315 if (MAI->getSetDirective()) {
316 OutStreamer.AddBlankLine();
317 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
319 MCSymbol *Name = GetGlobalValueSymbol(I);
321 const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
322 MCSymbol *Target = GetGlobalValueSymbol(GV);
324 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
325 OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
326 else if (I->hasWeakLinkage())
327 OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
329 assert(I->hasLocalLinkage() && "Invalid alias linkage");
331 printVisibility(Name, I->getVisibility());
333 O << MAI->getSetDirective() << ' ' << *Name << ", " << *Target << '\n';
337 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
338 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
339 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
340 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
341 MP->finishAssembly(O, *this, *MAI);
343 // If we don't have any trampolines, then we don't require stack memory
344 // to be executable. Some targets have a directive to declare this.
345 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
346 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
347 if (MCSection *S = MAI->getNonexecutableStackSection(OutContext))
348 OutStreamer.SwitchSection(S);
350 // Allow the target to emit any magic that it wants at the end of the file,
351 // after everything else has gone out.
354 delete Mang; Mang = 0;
357 OutStreamer.Finish();
361 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
362 // Get the function symbol.
363 CurrentFnSym = GetGlobalValueSymbol(MF.getFunction());
364 IncrementFunctionNumber();
367 LI = &getAnalysis<MachineLoopInfo>();
371 // SectionCPs - Keep track the alignment, constpool entries per Section.
375 SmallVector<unsigned, 4> CPEs;
376 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
380 /// EmitConstantPool - Print to the current output stream assembly
381 /// representations of the constants in the constant pool MCP. This is
382 /// used to print out constants which have been "spilled to memory" by
383 /// the code generator.
385 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
386 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
387 if (CP.empty()) return;
389 // Calculate sections for constant pool entries. We collect entries to go into
390 // the same section together to reduce amount of section switch statements.
391 SmallVector<SectionCPs, 4> CPSections;
392 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
393 const MachineConstantPoolEntry &CPE = CP[i];
394 unsigned Align = CPE.getAlignment();
397 switch (CPE.getRelocationInfo()) {
398 default: llvm_unreachable("Unknown section kind");
399 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
401 Kind = SectionKind::getReadOnlyWithRelLocal();
404 switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
405 case 4: Kind = SectionKind::getMergeableConst4(); break;
406 case 8: Kind = SectionKind::getMergeableConst8(); break;
407 case 16: Kind = SectionKind::getMergeableConst16();break;
408 default: Kind = SectionKind::getMergeableConst(); break;
412 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
414 // The number of sections are small, just do a linear search from the
415 // last section to the first.
417 unsigned SecIdx = CPSections.size();
418 while (SecIdx != 0) {
419 if (CPSections[--SecIdx].S == S) {
425 SecIdx = CPSections.size();
426 CPSections.push_back(SectionCPs(S, Align));
429 if (Align > CPSections[SecIdx].Alignment)
430 CPSections[SecIdx].Alignment = Align;
431 CPSections[SecIdx].CPEs.push_back(i);
434 // Now print stuff into the calculated sections.
435 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
436 OutStreamer.SwitchSection(CPSections[i].S);
437 EmitAlignment(Log2_32(CPSections[i].Alignment));
440 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
441 unsigned CPI = CPSections[i].CPEs[j];
442 MachineConstantPoolEntry CPE = CP[CPI];
444 // Emit inter-object padding for alignment.
445 unsigned AlignMask = CPE.getAlignment() - 1;
446 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
447 OutStreamer.EmitFill(NewOffset - Offset, 0/*fillval*/, 0/*addrspace*/);
449 const Type *Ty = CPE.getType();
450 Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
452 // Emit the label with a comment on it.
454 OutStreamer.GetCommentOS() << "constant pool ";
455 WriteTypeSymbolic(OutStreamer.GetCommentOS(), CPE.getType(),
456 MF->getFunction()->getParent());
457 OutStreamer.GetCommentOS() << '\n';
459 OutStreamer.EmitLabel(GetCPISymbol(CPI));
461 if (CPE.isMachineConstantPoolEntry())
462 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
464 EmitGlobalConstant(CPE.Val.ConstVal);
469 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
470 /// by the current function to the current output stream.
472 void AsmPrinter::EmitJumpTableInfo(MachineJumpTableInfo *MJTI,
473 MachineFunction &MF) {
474 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
475 if (JT.empty()) return;
477 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
479 // Pick the directive to use to print the jump table entries, and switch to
480 // the appropriate section.
481 TargetLowering *LoweringInfo = TM.getTargetLowering();
483 const Function *F = MF.getFunction();
484 bool JTInDiffSection = false;
485 if (F->isWeakForLinker() ||
486 (IsPic && !LoweringInfo->usesGlobalOffsetTable())) {
487 // In PIC mode, we need to emit the jump table to the same section as the
488 // function body itself, otherwise the label differences won't make sense.
489 // We should also do if the section name is NULL or function is declared in
490 // discardable section.
491 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang,
494 // Otherwise, drop it in the readonly section.
495 const MCSection *ReadOnlySection =
496 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
497 OutStreamer.SwitchSection(ReadOnlySection);
498 JTInDiffSection = true;
501 EmitAlignment(Log2_32(MJTI->getAlignment()));
503 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
504 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
506 // If this jump table was deleted, ignore it.
507 if (JTBBs.empty()) continue;
509 // For PIC codegen, if possible we want to use the SetDirective to reduce
510 // the number of relocations the assembler will generate for the jump table.
511 // Set directives are all printed before the jump table itself.
512 SmallPtrSet<MachineBasicBlock*, 16> EmittedSets;
513 if (MAI->getSetDirective() && IsPic)
514 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
515 if (EmittedSets.insert(JTBBs[ii]))
516 printPICJumpTableSetLabel(i, JTBBs[ii]);
518 // On some targets (e.g. Darwin) we want to emit two consequtive labels
519 // before each jump table. The first label is never referenced, but tells
520 // the assembler and linker the extents of the jump table object. The
521 // second label is actually referenced by the code.
522 if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
523 OutStreamer.EmitLabel(GetJTISymbol(i, true));
525 OutStreamer.EmitLabel(GetJTISymbol(i));
527 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
528 printPICJumpTableEntry(MJTI, JTBBs[ii], i);
534 void AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
535 const MachineBasicBlock *MBB,
536 unsigned uid) const {
537 bool isPIC = TM.getRelocationModel() == Reloc::PIC_;
539 // Use JumpTableDirective otherwise honor the entry size from the jump table
541 const char *JTEntryDirective = MAI->getJumpTableDirective(isPIC);
542 bool HadJTEntryDirective = JTEntryDirective != NULL;
543 if (!HadJTEntryDirective) {
544 JTEntryDirective = MJTI->getEntrySize() == 4 ?
545 MAI->getData32bitsDirective() : MAI->getData64bitsDirective();
548 O << JTEntryDirective << ' ';
550 // If we have emitted set directives for the jump table entries, print
551 // them rather than the entries themselves. If we're emitting PIC, then
552 // emit the table entries as differences between two text section labels.
553 // If we're emitting non-PIC code, then emit the entries as direct
554 // references to the target basic blocks.
556 O << *GetMBBSymbol(MBB->getNumber());
557 } else if (MAI->getSetDirective()) {
558 O << MAI->getPrivateGlobalPrefix() << getFunctionNumber()
559 << '_' << uid << "_set_" << MBB->getNumber();
561 O << *GetMBBSymbol(MBB->getNumber());
562 // If the arch uses custom Jump Table directives, don't calc relative to
564 if (!HadJTEntryDirective)
565 O << '-' << *GetJTISymbol(uid);
570 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
571 /// special global used by LLVM. If so, emit it and return true, otherwise
572 /// do nothing and return false.
573 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
574 if (GV->getName() == "llvm.used") {
575 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
576 EmitLLVMUsedList(GV->getInitializer());
580 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
581 if (GV->getSection() == "llvm.metadata" ||
582 GV->hasAvailableExternallyLinkage())
585 if (!GV->hasAppendingLinkage()) return false;
587 assert(GV->hasInitializer() && "Not a special LLVM global!");
589 const TargetData *TD = TM.getTargetData();
590 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
591 if (GV->getName() == "llvm.global_ctors") {
592 OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
593 EmitAlignment(Align, 0);
594 EmitXXStructorList(GV->getInitializer());
596 if (TM.getRelocationModel() == Reloc::Static &&
597 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
598 StringRef Sym(".constructors_used");
599 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
605 if (GV->getName() == "llvm.global_dtors") {
606 OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
607 EmitAlignment(Align, 0);
608 EmitXXStructorList(GV->getInitializer());
610 if (TM.getRelocationModel() == Reloc::Static &&
611 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
612 StringRef Sym(".destructors_used");
613 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
622 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
623 /// global in the specified llvm.used list for which emitUsedDirectiveFor
624 /// is true, as being used with this directive.
625 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
626 // Should be an array of 'i8*'.
627 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
628 if (InitList == 0) return;
630 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
631 const GlobalValue *GV =
632 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
633 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
634 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(GV),
639 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
640 /// function pointers, ignoring the init priority.
641 void AsmPrinter::EmitXXStructorList(Constant *List) {
642 // Should be an array of '{ int, void ()* }' structs. The first value is the
643 // init priority, which we ignore.
644 if (!isa<ConstantArray>(List)) return;
645 ConstantArray *InitList = cast<ConstantArray>(List);
646 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
647 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
648 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
650 if (CS->getOperand(1)->isNullValue())
651 return; // Found a null terminator, exit printing.
652 // Emit the function pointer.
653 EmitGlobalConstant(CS->getOperand(1));
657 //===--------------------------------------------------------------------===//
658 // Emission and print routines
661 /// EmitInt8 - Emit a byte directive and value.
663 void AsmPrinter::EmitInt8(int Value) const {
664 OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
667 /// EmitInt16 - Emit a short directive and value.
669 void AsmPrinter::EmitInt16(int Value) const {
670 OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
673 /// EmitInt32 - Emit a long directive and value.
675 void AsmPrinter::EmitInt32(int Value) const {
676 OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
679 /// EmitInt64 - Emit a long long directive and value.
681 void AsmPrinter::EmitInt64(uint64_t Value) const {
682 OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
685 //===----------------------------------------------------------------------===//
687 // EmitAlignment - Emit an alignment directive to the specified power of
688 // two boundary. For example, if you pass in 3 here, you will get an 8
689 // byte alignment. If a global value is specified, and if that global has
690 // an explicit alignment requested, it will unconditionally override the
691 // alignment request. However, if ForcedAlignBits is specified, this value
692 // has final say: the ultimate alignment will be the max of ForcedAlignBits
693 // and the alignment computed with NumBits and the global.
697 // if (GV && GV->hasalignment) Align = GV->getalignment();
698 // Align = std::max(Align, ForcedAlignBits);
700 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
701 unsigned ForcedAlignBits,
702 bool UseFillExpr) const {
703 if (GV && GV->getAlignment())
704 NumBits = Log2_32(GV->getAlignment());
705 NumBits = std::max(NumBits, ForcedAlignBits);
707 if (NumBits == 0) return; // No need to emit alignment.
709 unsigned FillValue = 0;
710 if (getCurrentSection()->getKind().isText())
711 FillValue = MAI->getTextAlignFillValue();
713 OutStreamer.EmitValueToAlignment(1 << NumBits, FillValue, 1, 0);
716 /// LowerConstant - Lower the specified LLVM Constant to an MCExpr.
718 static const MCExpr *LowerConstant(const Constant *CV, AsmPrinter &AP) {
719 MCContext &Ctx = AP.OutContext;
721 if (CV->isNullValue() || isa<UndefValue>(CV))
722 return MCConstantExpr::Create(0, Ctx);
724 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
725 return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
727 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
728 return MCSymbolRefExpr::Create(AP.GetGlobalValueSymbol(GV), Ctx);
729 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
730 return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
732 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
734 llvm_unreachable("Unknown constant value to lower!");
735 return MCConstantExpr::Create(0, Ctx);
738 switch (CE->getOpcode()) {
739 case Instruction::ZExt:
740 case Instruction::SExt:
741 case Instruction::FPTrunc:
742 case Instruction::FPExt:
743 case Instruction::UIToFP:
744 case Instruction::SIToFP:
745 case Instruction::FPToUI:
746 case Instruction::FPToSI:
747 default: llvm_unreachable("FIXME: Don't support this constant cast expr");
748 case Instruction::GetElementPtr: {
749 const TargetData &TD = *AP.TM.getTargetData();
750 // Generate a symbolic expression for the byte address
751 const Constant *PtrVal = CE->getOperand(0);
752 SmallVector<Value*, 8> IdxVec(CE->op_begin()+1, CE->op_end());
753 int64_t Offset = TD.getIndexedOffset(PtrVal->getType(), &IdxVec[0],
756 const MCExpr *Base = LowerConstant(CE->getOperand(0), AP);
760 // Truncate/sext the offset to the pointer size.
761 if (TD.getPointerSizeInBits() != 64) {
762 int SExtAmount = 64-TD.getPointerSizeInBits();
763 Offset = (Offset << SExtAmount) >> SExtAmount;
766 return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
770 case Instruction::Trunc:
771 // We emit the value and depend on the assembler to truncate the generated
772 // expression properly. This is important for differences between
773 // blockaddress labels. Since the two labels are in the same function, it
774 // is reasonable to treat their delta as a 32-bit value.
776 case Instruction::BitCast:
777 return LowerConstant(CE->getOperand(0), AP);
779 case Instruction::IntToPtr: {
780 const TargetData &TD = *AP.TM.getTargetData();
781 // Handle casts to pointers by changing them into casts to the appropriate
782 // integer type. This promotes constant folding and simplifies this code.
783 Constant *Op = CE->getOperand(0);
784 Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
786 return LowerConstant(Op, AP);
789 case Instruction::PtrToInt: {
790 const TargetData &TD = *AP.TM.getTargetData();
791 // Support only foldable casts to/from pointers that can be eliminated by
792 // changing the pointer to the appropriately sized integer type.
793 Constant *Op = CE->getOperand(0);
794 const Type *Ty = CE->getType();
796 const MCExpr *OpExpr = LowerConstant(Op, AP);
798 // We can emit the pointer value into this slot if the slot is an
799 // integer slot equal to the size of the pointer.
800 if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
803 // Otherwise the pointer is smaller than the resultant integer, mask off
804 // the high bits so we are sure to get a proper truncation if the input is
806 unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
807 const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
808 return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
811 case Instruction::Add:
812 case Instruction::Sub:
813 case Instruction::And:
814 case Instruction::Or:
815 case Instruction::Xor: {
816 const MCExpr *LHS = LowerConstant(CE->getOperand(0), AP);
817 const MCExpr *RHS = LowerConstant(CE->getOperand(1), AP);
818 switch (CE->getOpcode()) {
819 default: llvm_unreachable("Unknown binary operator constant cast expr");
820 case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
821 case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
822 case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
823 case Instruction::Or: return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
824 case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
830 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
832 if (AddrSpace != 0 || !CA->isString()) {
833 // Not a string. Print the values in successive locations
834 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
835 AP.EmitGlobalConstant(CA->getOperand(i), AddrSpace);
839 // Otherwise, it can be emitted as .ascii.
840 SmallVector<char, 128> TmpVec;
841 TmpVec.reserve(CA->getNumOperands());
842 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
843 TmpVec.push_back(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
845 AP.OutStreamer.EmitBytes(StringRef(TmpVec.data(), TmpVec.size()), AddrSpace);
848 static void EmitGlobalConstantVector(const ConstantVector *CV,
849 unsigned AddrSpace, AsmPrinter &AP) {
850 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
851 AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
854 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
855 unsigned AddrSpace, AsmPrinter &AP) {
856 // Print the fields in successive locations. Pad to align if needed!
857 const TargetData *TD = AP.TM.getTargetData();
858 unsigned Size = TD->getTypeAllocSize(CS->getType());
859 const StructLayout *Layout = TD->getStructLayout(CS->getType());
860 uint64_t SizeSoFar = 0;
861 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
862 const Constant *Field = CS->getOperand(i);
864 // Check if padding is needed and insert one or more 0s.
865 uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
866 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
867 - Layout->getElementOffset(i)) - FieldSize;
868 SizeSoFar += FieldSize + PadSize;
870 // Now print the actual field value.
871 AP.EmitGlobalConstant(Field, AddrSpace);
873 // Insert padding - this may include padding to increase the size of the
874 // current field up to the ABI size (if the struct is not packed) as well
875 // as padding to ensure that the next field starts at the right offset.
876 AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
878 assert(SizeSoFar == Layout->getSizeInBytes() &&
879 "Layout of constant struct may be incorrect!");
882 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
884 // FP Constants are printed as integer constants to avoid losing
886 if (CFP->getType()->isDoubleTy()) {
888 double Val = CFP->getValueAPF().convertToDouble();
889 AP.OutStreamer.GetCommentOS() << "double " << Val << '\n';
892 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
893 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
897 if (CFP->getType()->isFloatTy()) {
899 float Val = CFP->getValueAPF().convertToFloat();
900 AP.OutStreamer.GetCommentOS() << "float " << Val << '\n';
902 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
903 AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
907 if (CFP->getType()->isX86_FP80Ty()) {
908 // all long double variants are printed as hex
909 // api needed to prevent premature destruction
910 APInt API = CFP->getValueAPF().bitcastToAPInt();
911 const uint64_t *p = API.getRawData();
913 // Convert to double so we can print the approximate val as a comment.
914 APFloat DoubleVal = CFP->getValueAPF();
916 DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
918 AP.OutStreamer.GetCommentOS() << "x86_fp80 ~= "
919 << DoubleVal.convertToDouble() << '\n';
922 if (AP.TM.getTargetData()->isBigEndian()) {
923 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
924 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
926 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
927 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
930 // Emit the tail padding for the long double.
931 const TargetData &TD = *AP.TM.getTargetData();
932 AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
933 TD.getTypeStoreSize(CFP->getType()), AddrSpace);
937 assert(CFP->getType()->isPPC_FP128Ty() &&
938 "Floating point constant type not handled");
939 // All long double variants are printed as hex api needed to prevent
940 // premature destruction.
941 APInt API = CFP->getValueAPF().bitcastToAPInt();
942 const uint64_t *p = API.getRawData();
943 if (AP.TM.getTargetData()->isBigEndian()) {
944 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
945 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
947 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
948 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
952 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
953 unsigned AddrSpace, AsmPrinter &AP) {
954 const TargetData *TD = AP.TM.getTargetData();
955 unsigned BitWidth = CI->getBitWidth();
956 assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
958 // We don't expect assemblers to support integer data directives
959 // for more than 64 bits, so we emit the data in at most 64-bit
960 // quantities at a time.
961 const uint64_t *RawData = CI->getValue().getRawData();
962 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
963 uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
964 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
968 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
969 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
970 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
971 uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
972 return OutStreamer.EmitZeros(Size, AddrSpace);
975 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
976 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
983 OutStreamer.GetCommentOS() << format("0x%llx\n", CI->getZExtValue());
984 OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
987 EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
992 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
993 return EmitGlobalConstantArray(CVA, AddrSpace, *this);
995 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
996 return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
998 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
999 return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1001 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1002 return EmitGlobalConstantVector(V, AddrSpace, *this);
1004 if (isa<ConstantPointerNull>(CV)) {
1005 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1006 OutStreamer.EmitIntValue(0, Size, AddrSpace);
1010 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
1011 // thread the streamer with EmitValue.
1012 OutStreamer.EmitValue(LowerConstant(CV, *this),
1013 TM.getTargetData()->getTypeAllocSize(CV->getType()),
1017 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1018 // Target doesn't support this yet!
1019 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1022 /// PrintSpecial - Print information related to the specified machine instr
1023 /// that is independent of the operand, and may be independent of the instr
1024 /// itself. This can be useful for portably encoding the comment character
1025 /// or other bits of target-specific knowledge into the asmstrings. The
1026 /// syntax used is ${:comment}. Targets can override this to add support
1027 /// for their own strange codes.
1028 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1029 if (!strcmp(Code, "private")) {
1030 O << MAI->getPrivateGlobalPrefix();
1031 } else if (!strcmp(Code, "comment")) {
1033 O << MAI->getCommentString();
1034 } else if (!strcmp(Code, "uid")) {
1035 // Comparing the address of MI isn't sufficient, because machineinstrs may
1036 // be allocated to the same address across functions.
1037 const Function *ThisF = MI->getParent()->getParent()->getFunction();
1039 // If this is a new LastFn instruction, bump the counter.
1040 if (LastMI != MI || LastFn != ThisF) {
1048 raw_string_ostream Msg(msg);
1049 Msg << "Unknown special formatter '" << Code
1050 << "' for machine instr: " << *MI;
1051 llvm_report_error(Msg.str());
1055 /// processDebugLoc - Processes the debug information of each machine
1056 /// instruction's DebugLoc.
1057 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1058 bool BeforePrintingInsn) {
1059 if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1060 || !DW->ShouldEmitDwarfDebug())
1062 DebugLoc DL = MI->getDebugLoc();
1065 DILocation CurDLT = MF->getDILocation(DL);
1066 if (CurDLT.getScope().isNull())
1069 if (!BeforePrintingInsn) {
1070 // After printing instruction
1072 } else if (CurDLT.getNode() != PrevDLT) {
1073 unsigned L = DW->RecordSourceLine(CurDLT.getLineNumber(),
1074 CurDLT.getColumnNumber(),
1075 CurDLT.getScope().getNode());
1078 DW->BeginScope(MI, L);
1079 PrevDLT = CurDLT.getNode();
1084 /// printInlineAsm - This method formats and prints the specified machine
1085 /// instruction that is an inline asm.
1086 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1087 unsigned NumOperands = MI->getNumOperands();
1089 // Count the number of register definitions.
1090 unsigned NumDefs = 0;
1091 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1093 assert(NumDefs != NumOperands-1 && "No asm string?");
1095 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1097 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1098 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1102 // If this asmstr is empty, just print the #APP/#NOAPP markers.
1103 // These are useful to see where empty asm's wound up.
1104 if (AsmStr[0] == 0) {
1105 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1106 O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1110 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1112 // The variant of the current asmprinter.
1113 int AsmPrinterVariant = MAI->getAssemblerDialect();
1115 int CurVariant = -1; // The number of the {.|.|.} region we are in.
1116 const char *LastEmitted = AsmStr; // One past the last character emitted.
1118 while (*LastEmitted) {
1119 switch (*LastEmitted) {
1121 // Not a special case, emit the string section literally.
1122 const char *LiteralEnd = LastEmitted+1;
1123 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1124 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1126 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1127 O.write(LastEmitted, LiteralEnd-LastEmitted);
1128 LastEmitted = LiteralEnd;
1132 ++LastEmitted; // Consume newline character.
1133 O << '\n'; // Indent code with newline.
1136 ++LastEmitted; // Consume '$' character.
1140 switch (*LastEmitted) {
1141 default: Done = false; break;
1142 case '$': // $$ -> $
1143 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1145 ++LastEmitted; // Consume second '$' character.
1147 case '(': // $( -> same as GCC's { character.
1148 ++LastEmitted; // Consume '(' character.
1149 if (CurVariant != -1) {
1150 llvm_report_error("Nested variants found in inline asm string: '"
1151 + std::string(AsmStr) + "'");
1153 CurVariant = 0; // We're in the first variant now.
1156 ++LastEmitted; // consume '|' character.
1157 if (CurVariant == -1)
1158 O << '|'; // this is gcc's behavior for | outside a variant
1160 ++CurVariant; // We're in the next variant.
1162 case ')': // $) -> same as GCC's } char.
1163 ++LastEmitted; // consume ')' character.
1164 if (CurVariant == -1)
1165 O << '}'; // this is gcc's behavior for } outside a variant
1172 bool HasCurlyBraces = false;
1173 if (*LastEmitted == '{') { // ${variable}
1174 ++LastEmitted; // Consume '{' character.
1175 HasCurlyBraces = true;
1178 // If we have ${:foo}, then this is not a real operand reference, it is a
1179 // "magic" string reference, just like in .td files. Arrange to call
1181 if (HasCurlyBraces && *LastEmitted == ':') {
1183 const char *StrStart = LastEmitted;
1184 const char *StrEnd = strchr(StrStart, '}');
1186 llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1187 + std::string(AsmStr) + "'");
1190 std::string Val(StrStart, StrEnd);
1191 PrintSpecial(MI, Val.c_str());
1192 LastEmitted = StrEnd+1;
1196 const char *IDStart = LastEmitted;
1199 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1200 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1201 llvm_report_error("Bad $ operand number in inline asm string: '"
1202 + std::string(AsmStr) + "'");
1204 LastEmitted = IDEnd;
1206 char Modifier[2] = { 0, 0 };
1208 if (HasCurlyBraces) {
1209 // If we have curly braces, check for a modifier character. This
1210 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1211 if (*LastEmitted == ':') {
1212 ++LastEmitted; // Consume ':' character.
1213 if (*LastEmitted == 0) {
1214 llvm_report_error("Bad ${:} expression in inline asm string: '"
1215 + std::string(AsmStr) + "'");
1218 Modifier[0] = *LastEmitted;
1219 ++LastEmitted; // Consume modifier character.
1222 if (*LastEmitted != '}') {
1223 llvm_report_error("Bad ${} expression in inline asm string: '"
1224 + std::string(AsmStr) + "'");
1226 ++LastEmitted; // Consume '}' character.
1229 if ((unsigned)Val >= NumOperands-1) {
1230 llvm_report_error("Invalid $ operand number in inline asm string: '"
1231 + std::string(AsmStr) + "'");
1234 // Okay, we finally have a value number. Ask the target to print this
1236 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1241 // Scan to find the machine operand number for the operand.
1242 for (; Val; --Val) {
1243 if (OpNo >= MI->getNumOperands()) break;
1244 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1245 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1248 if (OpNo >= MI->getNumOperands()) {
1251 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1252 ++OpNo; // Skip over the ID number.
1254 if (Modifier[0] == 'l') // labels are target independent
1255 O << *GetMBBSymbol(MI->getOperand(OpNo).getMBB()->getNumber());
1257 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1258 if ((OpFlags & 7) == 4) {
1259 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1260 Modifier[0] ? Modifier : 0);
1262 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1263 Modifier[0] ? Modifier : 0);
1269 raw_string_ostream Msg(msg);
1270 Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1272 llvm_report_error(Msg.str());
1279 O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1282 /// printImplicitDef - This method prints the specified machine instruction
1283 /// that is an implicit def.
1284 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1285 if (!VerboseAsm) return;
1286 O.PadToColumn(MAI->getCommentColumn());
1287 O << MAI->getCommentString() << " implicit-def: "
1288 << TRI->getName(MI->getOperand(0).getReg());
1291 void AsmPrinter::printKill(const MachineInstr *MI) const {
1292 if (!VerboseAsm) return;
1293 O.PadToColumn(MAI->getCommentColumn());
1294 O << MAI->getCommentString() << " kill:";
1295 for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1296 const MachineOperand &op = MI->getOperand(n);
1297 assert(op.isReg() && "KILL instruction must have only register operands");
1298 O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1302 /// printLabel - This method prints a local label used by debug and
1303 /// exception handling tables.
1304 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1305 printLabel(MI->getOperand(0).getImm());
1308 void AsmPrinter::printLabel(unsigned Id) const {
1309 O << MAI->getPrivateGlobalPrefix() << "label" << Id << ':';
1312 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1313 /// instruction, using the specified assembler variant. Targets should
1314 /// override this to format as appropriate.
1315 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1316 unsigned AsmVariant, const char *ExtraCode) {
1317 // Target doesn't support this yet!
1321 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1322 unsigned AsmVariant,
1323 const char *ExtraCode) {
1324 // Target doesn't support this yet!
1328 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA,
1329 const char *Suffix) const {
1330 return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock(), Suffix);
1333 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1334 const BasicBlock *BB,
1335 const char *Suffix) const {
1336 assert(BB->hasName() &&
1337 "Address of anonymous basic block not supported yet!");
1339 // This code must use the function name itself, and not the function number,
1340 // since it must be possible to generate the label name from within other
1342 SmallString<60> FnName;
1343 Mang->getNameWithPrefix(FnName, F, false);
1345 // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1346 SmallString<60> NameResult;
1347 Mang->getNameWithPrefix(NameResult,
1348 StringRef("BA") + Twine((unsigned)FnName.size()) +
1349 "_" + FnName.str() + "_" + BB->getName() + Suffix,
1352 return OutContext.GetOrCreateSymbol(NameResult.str());
1355 MCSymbol *AsmPrinter::GetMBBSymbol(unsigned MBBID) const {
1356 SmallString<60> Name;
1357 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "BB"
1358 << getFunctionNumber() << '_' << MBBID;
1359 return OutContext.GetOrCreateSymbol(Name.str());
1362 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1363 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1364 SmallString<60> Name;
1365 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "CPI"
1366 << getFunctionNumber() << '_' << CPID;
1367 return OutContext.GetOrCreateSymbol(Name.str());
1370 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1371 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1372 const char *Prefix = isLinkerPrivate ? MAI->getLinkerPrivateGlobalPrefix() :
1373 MAI->getPrivateGlobalPrefix();
1374 SmallString<60> Name;
1375 raw_svector_ostream(Name) << Prefix << "JTI" << getFunctionNumber() << '_'
1377 return OutContext.GetOrCreateSymbol(Name.str());
1380 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
1382 MCSymbol *AsmPrinter::GetGlobalValueSymbol(const GlobalValue *GV) const {
1383 SmallString<60> NameStr;
1384 Mang->getNameWithPrefix(NameStr, GV, false);
1385 return OutContext.GetOrCreateSymbol(NameStr.str());
1388 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1389 /// global value name as its base, with the specified suffix, and where the
1390 /// symbol is forced to have private linkage if ForcePrivate is true.
1391 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1393 bool ForcePrivate) const {
1394 SmallString<60> NameStr;
1395 Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1396 NameStr.append(Suffix.begin(), Suffix.end());
1397 return OutContext.GetOrCreateSymbol(NameStr.str());
1400 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1402 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1403 SmallString<60> NameStr;
1404 Mang->getNameWithPrefix(NameStr, Sym);
1405 return OutContext.GetOrCreateSymbol(NameStr.str());
1410 /// PrintParentLoopComment - Print comments about parent loops of this one.
1411 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1412 unsigned FunctionNumber) {
1413 if (Loop == 0) return;
1414 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
1415 OS.indent(Loop->getLoopDepth()*2)
1416 << "Parent Loop BB" << FunctionNumber << "_"
1417 << Loop->getHeader()->getNumber()
1418 << " Depth=" << Loop->getLoopDepth() << '\n';
1422 /// PrintChildLoopComment - Print comments about child loops within
1423 /// the loop for this basic block, with nesting.
1424 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1425 unsigned FunctionNumber) {
1426 // Add child loop information
1427 for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
1428 OS.indent((*CL)->getLoopDepth()*2)
1429 << "Child Loop BB" << FunctionNumber << "_"
1430 << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
1432 PrintChildLoopComment(OS, *CL, FunctionNumber);
1436 /// EmitComments - Pretty-print comments for basic blocks.
1437 static void PrintBasicBlockLoopComments(const MachineBasicBlock &MBB,
1438 const MachineLoopInfo *LI,
1439 const AsmPrinter &AP) {
1440 // Add loop depth information
1441 const MachineLoop *Loop = LI->getLoopFor(&MBB);
1442 if (Loop == 0) return;
1444 MachineBasicBlock *Header = Loop->getHeader();
1445 assert(Header && "No header for loop");
1447 // If this block is not a loop header, just print out what is the loop header
1449 if (Header != &MBB) {
1450 AP.OutStreamer.AddComment(" in Loop: Header=BB" +
1451 Twine(AP.getFunctionNumber())+"_" +
1452 Twine(Loop->getHeader()->getNumber())+
1453 " Depth="+Twine(Loop->getLoopDepth()));
1457 // Otherwise, it is a loop header. Print out information about child and
1459 raw_ostream &OS = AP.OutStreamer.GetCommentOS();
1461 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
1464 OS.indent(Loop->getLoopDepth()*2-2);
1469 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
1471 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
1475 /// EmitBasicBlockStart - This method prints the label for the specified
1476 /// MachineBasicBlock, an alignment (if present) and a comment describing
1477 /// it if appropriate.
1478 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1479 // Emit an alignment directive for this block, if needed.
1480 if (unsigned Align = MBB->getAlignment())
1481 EmitAlignment(Log2_32(Align));
1483 // If the block has its address taken, emit a special label to satisfy
1484 // references to the block. This is done so that we don't need to
1485 // remember the number of this label, and so that we can make
1486 // forward references to labels without knowing what their numbers
1488 if (MBB->hasAddressTaken()) {
1489 const BasicBlock *BB = MBB->getBasicBlock();
1491 OutStreamer.AddComment("Address Taken");
1492 OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1495 // Print the main label for the block.
1496 if (MBB->pred_empty() || MBB->isOnlyReachableByFallthrough()) {
1498 // NOTE: Want this comment at start of line.
1499 O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1500 if (const BasicBlock *BB = MBB->getBasicBlock())
1502 OutStreamer.AddComment("%" + BB->getName());
1504 PrintBasicBlockLoopComments(*MBB, LI, *this);
1505 OutStreamer.AddBlankLine();
1509 if (const BasicBlock *BB = MBB->getBasicBlock())
1511 OutStreamer.AddComment("%" + BB->getName());
1512 PrintBasicBlockLoopComments(*MBB, LI, *this);
1515 OutStreamer.EmitLabel(GetMBBSymbol(MBB->getNumber()));
1519 /// printPICJumpTableSetLabel - This method prints a set label for the
1520 /// specified MachineBasicBlock for a jumptable entry.
1521 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
1522 const MachineBasicBlock *MBB) const {
1523 if (!MAI->getSetDirective())
1526 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1527 << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ','
1528 << *GetMBBSymbol(MBB->getNumber())
1529 << '-' << *GetJTISymbol(uid) << '\n';
1532 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
1533 const MachineBasicBlock *MBB) const {
1534 if (!MAI->getSetDirective())
1537 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1538 << getFunctionNumber() << '_' << uid << '_' << uid2
1539 << "_set_" << MBB->getNumber() << ','
1540 << *GetMBBSymbol(MBB->getNumber())
1541 << '-' << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1542 << '_' << uid << '_' << uid2 << '\n';
1545 void AsmPrinter::printVisibility(MCSymbol *Sym, unsigned Visibility) const {
1546 MCSymbolAttr Attr = MCSA_Invalid;
1548 switch (Visibility) {
1550 case GlobalValue::HiddenVisibility:
1551 Attr = MAI->getHiddenVisibilityAttr();
1553 case GlobalValue::ProtectedVisibility:
1554 Attr = MAI->getProtectedVisibilityAttr();
1558 if (Attr != MCSA_Invalid)
1559 OutStreamer.EmitSymbolAttribute(Sym, Attr);
1562 void AsmPrinter::printOffset(int64_t Offset) const {
1565 else if (Offset < 0)
1569 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1570 if (!S->usesMetadata())
1573 gcp_iterator GCPI = GCMetadataPrinters.find(S);
1574 if (GCPI != GCMetadataPrinters.end())
1575 return GCPI->second;
1577 const char *Name = S->getName().c_str();
1579 for (GCMetadataPrinterRegistry::iterator
1580 I = GCMetadataPrinterRegistry::begin(),
1581 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1582 if (strcmp(Name, I->getName()) == 0) {
1583 GCMetadataPrinter *GMP = I->instantiate();
1585 GCMetadataPrinters.insert(std::make_pair(S, GMP));
1589 llvm_report_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
1593 /// EmitComments - Pretty-print comments for instructions
1594 void AsmPrinter::EmitComments(const MachineInstr &MI) const {
1598 bool Newline = false;
1600 if (!MI.getDebugLoc().isUnknown()) {
1601 DILocation DLT = MF->getDILocation(MI.getDebugLoc());
1603 // Print source line info.
1604 O.PadToColumn(MAI->getCommentColumn());
1605 O << MAI->getCommentString() << ' ';
1606 DIScope Scope = DLT.getScope();
1607 // Omit the directory, because it's likely to be long and uninteresting.
1608 if (!Scope.isNull())
1609 O << Scope.getFilename();
1612 O << ':' << DLT.getLineNumber();
1613 if (DLT.getColumnNumber() != 0)
1614 O << ':' << DLT.getColumnNumber();
1618 // Check for spills and reloads
1621 const MachineFrameInfo *FrameInfo =
1622 MI.getParent()->getParent()->getFrameInfo();
1624 // We assume a single instruction only has a spill or reload, not
1626 const MachineMemOperand *MMO;
1627 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
1628 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1629 MMO = *MI.memoperands_begin();
1630 if (Newline) O << '\n';
1631 O.PadToColumn(MAI->getCommentColumn());
1632 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Reload";
1636 else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
1637 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1638 if (Newline) O << '\n';
1639 O.PadToColumn(MAI->getCommentColumn());
1640 O << MAI->getCommentString() << ' '
1641 << MMO->getSize() << "-byte Folded Reload";
1645 else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
1646 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1647 MMO = *MI.memoperands_begin();
1648 if (Newline) O << '\n';
1649 O.PadToColumn(MAI->getCommentColumn());
1650 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Spill";
1654 else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
1655 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1656 if (Newline) O << '\n';
1657 O.PadToColumn(MAI->getCommentColumn());
1658 O << MAI->getCommentString() << ' '
1659 << MMO->getSize() << "-byte Folded Spill";
1664 // Check for spill-induced copies
1665 unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1666 if (TM.getInstrInfo()->isMoveInstr(MI, SrcReg, DstReg,
1667 SrcSubIdx, DstSubIdx)) {
1668 if (MI.getAsmPrinterFlag(ReloadReuse)) {
1669 if (Newline) O << '\n';
1670 O.PadToColumn(MAI->getCommentColumn());
1671 O << MAI->getCommentString() << " Reload Reuse";