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), 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 /// getFunctionNumber - Return a unique ID for the current function.
92 unsigned AsmPrinter::getFunctionNumber() const {
93 return MF->getFunctionNumber();
96 TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
97 return TM.getTargetLowering()->getObjFileLowering();
100 /// getCurrentSection() - Return the current section we are emitting to.
101 const MCSection *AsmPrinter::getCurrentSection() const {
102 return OutStreamer.getCurrentSection();
106 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
107 AU.setPreservesAll();
108 MachineFunctionPass::getAnalysisUsage(AU);
109 AU.addRequired<GCModuleInfo>();
111 AU.addRequired<MachineLoopInfo>();
114 bool AsmPrinter::doInitialization(Module &M) {
115 // Initialize TargetLoweringObjectFile.
116 const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
117 .Initialize(OutContext, TM);
119 Mang = new Mangler(*MAI);
121 // Allow the target to emit any magic that it wants at the start of the file.
122 EmitStartOfAsmFile(M);
124 // Very minimal debug info. It is ignored if we emit actual debug info. If we
125 // don't, this at least helps the user find where a global came from.
126 if (MAI->hasSingleParameterDotFile()) {
128 OutStreamer.EmitFileDirective(M.getModuleIdentifier());
131 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
132 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
133 for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
134 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
135 MP->beginAssembly(O, *this, *MAI);
137 if (!M.getModuleInlineAsm().empty())
138 O << MAI->getCommentString() << " Start of file scope inline assembly\n"
139 << M.getModuleInlineAsm()
140 << '\n' << MAI->getCommentString()
141 << " End of file scope inline assembly\n";
143 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
145 MMI->AnalyzeModule(M);
146 DW = getAnalysisIfAvailable<DwarfWriter>();
148 DW->BeginModule(&M, MMI, O, this, MAI);
153 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
154 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
155 if (!GV->hasInitializer()) // External globals require no code.
158 // Check to see if this is a special global used by LLVM, if so, emit it.
159 if (EmitSpecialLLVMGlobal(GV))
162 MCSymbol *GVSym = GetGlobalValueSymbol(GV);
163 printVisibility(GVSym, GV->getVisibility());
165 if (MAI->hasDotTypeDotSizeDirective())
166 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
168 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
170 const TargetData *TD = TM.getTargetData();
171 unsigned Size = TD->getTypeAllocSize(GV->getType()->getElementType());
172 unsigned AlignLog = TD->getPreferredAlignmentLog(GV);
174 // Handle common and BSS local symbols (.lcomm).
175 if (GVKind.isCommon() || GVKind.isBSSLocal()) {
176 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
179 WriteAsOperand(OutStreamer.GetCommentOS(), GV,
180 /*PrintType=*/false, GV->getParent());
181 OutStreamer.GetCommentOS() << '\n';
184 // Handle common symbols.
185 if (GVKind.isCommon()) {
187 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
191 // Handle local BSS symbols.
192 if (MAI->hasMachoZeroFillDirective()) {
193 const MCSection *TheSection =
194 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
195 // .zerofill __DATA, __bss, _foo, 400, 5
196 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
200 if (MAI->hasLCOMMDirective()) {
202 OutStreamer.EmitLocalCommonSymbol(GVSym, Size);
207 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
209 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
213 const MCSection *TheSection =
214 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
216 // Handle the zerofill directive on darwin, which is a special form of BSS
218 if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
220 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
221 // .zerofill __DATA, __common, _foo, 400, 5
222 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
226 OutStreamer.SwitchSection(TheSection);
228 // TODO: Factor into an 'emit linkage' thing that is shared with function
230 switch (GV->getLinkage()) {
231 case GlobalValue::CommonLinkage:
232 case GlobalValue::LinkOnceAnyLinkage:
233 case GlobalValue::LinkOnceODRLinkage:
234 case GlobalValue::WeakAnyLinkage:
235 case GlobalValue::WeakODRLinkage:
236 case GlobalValue::LinkerPrivateLinkage:
237 if (MAI->getWeakDefDirective() != 0) {
239 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
240 // .weak_definition _foo
241 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
242 } else if (const char *LinkOnce = MAI->getLinkOnceDirective()) {
244 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
245 // FIXME: linkonce should be a section attribute, handled by COFF Section
247 // http://sourceware.org/binutils/docs-2.20/as/Linkonce.html#Linkonce
248 // .linkonce same_size
252 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
255 case GlobalValue::DLLExportLinkage:
256 case GlobalValue::AppendingLinkage:
257 // FIXME: appending linkage variables should go into a section of
258 // their name or something. For now, just emit them as external.
259 case GlobalValue::ExternalLinkage:
260 // If external or appending, declare as a global symbol.
262 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
264 case GlobalValue::PrivateLinkage:
265 case GlobalValue::InternalLinkage:
268 llvm_unreachable("Unknown linkage type!");
271 EmitAlignment(AlignLog, GV);
273 WriteAsOperand(OutStreamer.GetCommentOS(), GV,
274 /*PrintType=*/false, GV->getParent());
275 OutStreamer.GetCommentOS() << '\n';
277 OutStreamer.EmitLabel(GVSym);
279 EmitGlobalConstant(GV->getInitializer());
281 if (MAI->hasDotTypeDotSizeDirective())
283 OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
285 OutStreamer.AddBlankLine();
289 bool AsmPrinter::doFinalization(Module &M) {
290 // Emit global variables.
291 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
293 EmitGlobalVariable(I);
295 // Emit final debug information.
296 if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
299 // If the target wants to know about weak references, print them all.
300 if (MAI->getWeakRefDirective()) {
301 // FIXME: This is not lazy, it would be nice to only print weak references
302 // to stuff that is actually used. Note that doing so would require targets
303 // to notice uses in operands (due to constant exprs etc). This should
304 // happen with the MC stuff eventually.
306 // Print out module-level global variables here.
307 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
309 if (!I->hasExternalWeakLinkage()) continue;
310 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
314 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
315 if (!I->hasExternalWeakLinkage()) continue;
316 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
321 if (MAI->getSetDirective()) {
322 OutStreamer.AddBlankLine();
323 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
325 MCSymbol *Name = GetGlobalValueSymbol(I);
327 const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
328 MCSymbol *Target = GetGlobalValueSymbol(GV);
330 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
331 OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
332 else if (I->hasWeakLinkage())
333 OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
335 assert(I->hasLocalLinkage() && "Invalid alias linkage");
337 printVisibility(Name, I->getVisibility());
339 O << MAI->getSetDirective() << ' ' << *Name << ", " << *Target << '\n';
343 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
344 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
345 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
346 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
347 MP->finishAssembly(O, *this, *MAI);
349 // If we don't have any trampolines, then we don't require stack memory
350 // to be executable. Some targets have a directive to declare this.
351 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
352 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
353 if (MCSection *S = MAI->getNonexecutableStackSection(OutContext))
354 OutStreamer.SwitchSection(S);
356 // Allow the target to emit any magic that it wants at the end of the file,
357 // after everything else has gone out.
360 delete Mang; Mang = 0;
363 OutStreamer.Finish();
367 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
369 // Get the function symbol.
370 CurrentFnSym = GetGlobalValueSymbol(MF.getFunction());
373 LI = &getAnalysis<MachineLoopInfo>();
377 // SectionCPs - Keep track the alignment, constpool entries per Section.
381 SmallVector<unsigned, 4> CPEs;
382 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
386 /// EmitConstantPool - Print to the current output stream assembly
387 /// representations of the constants in the constant pool MCP. This is
388 /// used to print out constants which have been "spilled to memory" by
389 /// the code generator.
391 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
392 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
393 if (CP.empty()) return;
395 // Calculate sections for constant pool entries. We collect entries to go into
396 // the same section together to reduce amount of section switch statements.
397 SmallVector<SectionCPs, 4> CPSections;
398 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
399 const MachineConstantPoolEntry &CPE = CP[i];
400 unsigned Align = CPE.getAlignment();
403 switch (CPE.getRelocationInfo()) {
404 default: llvm_unreachable("Unknown section kind");
405 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
407 Kind = SectionKind::getReadOnlyWithRelLocal();
410 switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
411 case 4: Kind = SectionKind::getMergeableConst4(); break;
412 case 8: Kind = SectionKind::getMergeableConst8(); break;
413 case 16: Kind = SectionKind::getMergeableConst16();break;
414 default: Kind = SectionKind::getMergeableConst(); break;
418 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
420 // The number of sections are small, just do a linear search from the
421 // last section to the first.
423 unsigned SecIdx = CPSections.size();
424 while (SecIdx != 0) {
425 if (CPSections[--SecIdx].S == S) {
431 SecIdx = CPSections.size();
432 CPSections.push_back(SectionCPs(S, Align));
435 if (Align > CPSections[SecIdx].Alignment)
436 CPSections[SecIdx].Alignment = Align;
437 CPSections[SecIdx].CPEs.push_back(i);
440 // Now print stuff into the calculated sections.
441 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
442 OutStreamer.SwitchSection(CPSections[i].S);
443 EmitAlignment(Log2_32(CPSections[i].Alignment));
446 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
447 unsigned CPI = CPSections[i].CPEs[j];
448 MachineConstantPoolEntry CPE = CP[CPI];
450 // Emit inter-object padding for alignment.
451 unsigned AlignMask = CPE.getAlignment() - 1;
452 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
453 OutStreamer.EmitFill(NewOffset - Offset, 0/*fillval*/, 0/*addrspace*/);
455 const Type *Ty = CPE.getType();
456 Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
458 // Emit the label with a comment on it.
460 OutStreamer.GetCommentOS() << "constant pool ";
461 WriteTypeSymbolic(OutStreamer.GetCommentOS(), CPE.getType(),
462 MF->getFunction()->getParent());
463 OutStreamer.GetCommentOS() << '\n';
465 OutStreamer.EmitLabel(GetCPISymbol(CPI));
467 if (CPE.isMachineConstantPoolEntry())
468 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
470 EmitGlobalConstant(CPE.Val.ConstVal);
475 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
476 /// by the current function to the current output stream.
478 void AsmPrinter::EmitJumpTableInfo(MachineFunction &MF) {
479 MachineJumpTableInfo *MJTI = MF.getJumpTableInfo();
480 if (MJTI == 0) return;
481 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
482 if (JT.empty()) return;
484 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
486 // Pick the directive to use to print the jump table entries, and switch to
487 // the appropriate section.
488 const Function *F = MF.getFunction();
489 bool JTInDiffSection = false;
490 if (F->isWeakForLinker() ||
491 (IsPic && !TM.getTargetLowering()->usesGlobalOffsetTable())) {
492 // In PIC mode, we need to emit the jump table to the same section as the
493 // function body itself, otherwise the label differences won't make sense.
494 // We should also do if the section name is NULL or function is declared in
495 // discardable section.
496 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang,
499 // Otherwise, drop it in the readonly section.
500 const MCSection *ReadOnlySection =
501 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
502 OutStreamer.SwitchSection(ReadOnlySection);
503 JTInDiffSection = true;
506 unsigned EntrySize = MJTI->getEntrySize(*TM.getTargetData());
507 EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getTargetData())));
509 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
510 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
512 // If this jump table was deleted, ignore it.
513 if (JTBBs.empty()) continue;
515 // For PIC codegen, if possible we want to use the SetDirective to reduce
516 // the number of relocations the assembler will generate for the jump table.
517 // Set directives are all printed before the jump table itself.
518 SmallPtrSet<MachineBasicBlock*, 16> EmittedSets;
519 if (MAI->getSetDirective() && IsPic)
520 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
521 if (EmittedSets.insert(JTBBs[ii]))
522 printPICJumpTableSetLabel(i, JTBBs[ii]);
524 // On some targets (e.g. Darwin) we want to emit two consequtive labels
525 // before each jump table. The first label is never referenced, but tells
526 // the assembler and linker the extents of the jump table object. The
527 // second label is actually referenced by the code.
528 if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
529 OutStreamer.EmitLabel(GetJTISymbol(i, true));
531 OutStreamer.EmitLabel(GetJTISymbol(i));
534 // In non-pic mode, the entries in the jump table are direct references
535 // to the basic blocks.
536 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
537 MCSymbol *MBBSym = JTBBs[ii]->getSymbol(OutContext);
538 OutStreamer.EmitValue(MCSymbolRefExpr::Create(MBBSym, OutContext),
539 EntrySize, /*addrspace*/0);
542 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
543 printPICJumpTableEntry(MJTI, JTBBs[ii], i);
548 void AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
549 const MachineBasicBlock *MBB,
550 unsigned uid) const {
551 const MCExpr *Value = 0;
552 switch (MJTI->getEntryKind()) {
553 case MachineJumpTableInfo::EK_Custom32:
554 Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, uid,
557 case MachineJumpTableInfo::EK_BlockAddress:
558 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
560 Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
562 case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
563 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
564 // with a relocation as gp-relative, e.g.:
566 MCSymbol *MBBSym = MBB->getSymbol(OutContext);
567 OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
571 case MachineJumpTableInfo::EK_LabelDifference32: {
572 // EK_LabelDifference32 - Each entry is the address of the block minus
573 // the address of the jump table. This is used for PIC jump tables where
574 // gprel32 is not supported. e.g.:
575 // .word LBB123 - LJTI1_2
576 // If the .set directive is supported, this is emitted as:
577 // .set L4_5_set_123, LBB123 - LJTI1_2
578 // .word L4_5_set_123
580 // If we have emitted set directives for the jump table entries, print
581 // them rather than the entries themselves. If we're emitting PIC, then
582 // emit the table entries as differences between two text section labels.
583 if (MAI->getSetDirective()) {
584 // If we used .set, reference the .set's symbol.
585 Value = MCSymbolRefExpr::Create(GetJTSetSymbol(uid, MBB->getNumber()),
589 // Otherwise, use the difference as the jump table entry.
590 Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
591 const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(uid), OutContext);
592 Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
597 assert(Value && "Unknown entry kind!");
599 unsigned EntrySize = MJTI->getEntrySize(*TM.getTargetData());
600 OutStreamer.EmitValue(Value, EntrySize, /*addrspace*/0);
604 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
605 /// special global used by LLVM. If so, emit it and return true, otherwise
606 /// do nothing and return false.
607 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
608 if (GV->getName() == "llvm.used") {
609 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
610 EmitLLVMUsedList(GV->getInitializer());
614 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
615 if (GV->getSection() == "llvm.metadata" ||
616 GV->hasAvailableExternallyLinkage())
619 if (!GV->hasAppendingLinkage()) return false;
621 assert(GV->hasInitializer() && "Not a special LLVM global!");
623 const TargetData *TD = TM.getTargetData();
624 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
625 if (GV->getName() == "llvm.global_ctors") {
626 OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
627 EmitAlignment(Align, 0);
628 EmitXXStructorList(GV->getInitializer());
630 if (TM.getRelocationModel() == Reloc::Static &&
631 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
632 StringRef Sym(".constructors_used");
633 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
639 if (GV->getName() == "llvm.global_dtors") {
640 OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
641 EmitAlignment(Align, 0);
642 EmitXXStructorList(GV->getInitializer());
644 if (TM.getRelocationModel() == Reloc::Static &&
645 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
646 StringRef Sym(".destructors_used");
647 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
656 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
657 /// global in the specified llvm.used list for which emitUsedDirectiveFor
658 /// is true, as being used with this directive.
659 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
660 // Should be an array of 'i8*'.
661 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
662 if (InitList == 0) return;
664 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
665 const GlobalValue *GV =
666 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
667 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
668 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(GV),
673 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
674 /// function pointers, ignoring the init priority.
675 void AsmPrinter::EmitXXStructorList(Constant *List) {
676 // Should be an array of '{ int, void ()* }' structs. The first value is the
677 // init priority, which we ignore.
678 if (!isa<ConstantArray>(List)) return;
679 ConstantArray *InitList = cast<ConstantArray>(List);
680 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
681 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
682 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
684 if (CS->getOperand(1)->isNullValue())
685 return; // Found a null terminator, exit printing.
686 // Emit the function pointer.
687 EmitGlobalConstant(CS->getOperand(1));
691 //===--------------------------------------------------------------------===//
692 // Emission and print routines
695 /// EmitInt8 - Emit a byte directive and value.
697 void AsmPrinter::EmitInt8(int Value) const {
698 OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
701 /// EmitInt16 - Emit a short directive and value.
703 void AsmPrinter::EmitInt16(int Value) const {
704 OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
707 /// EmitInt32 - Emit a long directive and value.
709 void AsmPrinter::EmitInt32(int Value) const {
710 OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
713 /// EmitInt64 - Emit a long long directive and value.
715 void AsmPrinter::EmitInt64(uint64_t Value) const {
716 OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
719 //===----------------------------------------------------------------------===//
721 // EmitAlignment - Emit an alignment directive to the specified power of
722 // two boundary. For example, if you pass in 3 here, you will get an 8
723 // byte alignment. If a global value is specified, and if that global has
724 // an explicit alignment requested, it will unconditionally override the
725 // alignment request. However, if ForcedAlignBits is specified, this value
726 // has final say: the ultimate alignment will be the max of ForcedAlignBits
727 // and the alignment computed with NumBits and the global.
731 // if (GV && GV->hasalignment) Align = GV->getalignment();
732 // Align = std::max(Align, ForcedAlignBits);
734 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
735 unsigned ForcedAlignBits,
736 bool UseFillExpr) const {
737 if (GV && GV->getAlignment())
738 NumBits = Log2_32(GV->getAlignment());
739 NumBits = std::max(NumBits, ForcedAlignBits);
741 if (NumBits == 0) return; // No need to emit alignment.
743 unsigned FillValue = 0;
744 if (getCurrentSection()->getKind().isText())
745 FillValue = MAI->getTextAlignFillValue();
747 OutStreamer.EmitValueToAlignment(1 << NumBits, FillValue, 1, 0);
750 /// LowerConstant - Lower the specified LLVM Constant to an MCExpr.
752 static const MCExpr *LowerConstant(const Constant *CV, AsmPrinter &AP) {
753 MCContext &Ctx = AP.OutContext;
755 if (CV->isNullValue() || isa<UndefValue>(CV))
756 return MCConstantExpr::Create(0, Ctx);
758 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
759 return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
761 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
762 return MCSymbolRefExpr::Create(AP.GetGlobalValueSymbol(GV), Ctx);
763 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
764 return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
766 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
768 llvm_unreachable("Unknown constant value to lower!");
769 return MCConstantExpr::Create(0, Ctx);
772 switch (CE->getOpcode()) {
773 case Instruction::ZExt:
774 case Instruction::SExt:
775 case Instruction::FPTrunc:
776 case Instruction::FPExt:
777 case Instruction::UIToFP:
778 case Instruction::SIToFP:
779 case Instruction::FPToUI:
780 case Instruction::FPToSI:
781 default: llvm_unreachable("FIXME: Don't support this constant cast expr");
782 case Instruction::GetElementPtr: {
783 const TargetData &TD = *AP.TM.getTargetData();
784 // Generate a symbolic expression for the byte address
785 const Constant *PtrVal = CE->getOperand(0);
786 SmallVector<Value*, 8> IdxVec(CE->op_begin()+1, CE->op_end());
787 int64_t Offset = TD.getIndexedOffset(PtrVal->getType(), &IdxVec[0],
790 const MCExpr *Base = LowerConstant(CE->getOperand(0), AP);
794 // Truncate/sext the offset to the pointer size.
795 if (TD.getPointerSizeInBits() != 64) {
796 int SExtAmount = 64-TD.getPointerSizeInBits();
797 Offset = (Offset << SExtAmount) >> SExtAmount;
800 return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
804 case Instruction::Trunc:
805 // We emit the value and depend on the assembler to truncate the generated
806 // expression properly. This is important for differences between
807 // blockaddress labels. Since the two labels are in the same function, it
808 // is reasonable to treat their delta as a 32-bit value.
810 case Instruction::BitCast:
811 return LowerConstant(CE->getOperand(0), AP);
813 case Instruction::IntToPtr: {
814 const TargetData &TD = *AP.TM.getTargetData();
815 // Handle casts to pointers by changing them into casts to the appropriate
816 // integer type. This promotes constant folding and simplifies this code.
817 Constant *Op = CE->getOperand(0);
818 Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
820 return LowerConstant(Op, AP);
823 case Instruction::PtrToInt: {
824 const TargetData &TD = *AP.TM.getTargetData();
825 // Support only foldable casts to/from pointers that can be eliminated by
826 // changing the pointer to the appropriately sized integer type.
827 Constant *Op = CE->getOperand(0);
828 const Type *Ty = CE->getType();
830 const MCExpr *OpExpr = LowerConstant(Op, AP);
832 // We can emit the pointer value into this slot if the slot is an
833 // integer slot equal to the size of the pointer.
834 if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
837 // Otherwise the pointer is smaller than the resultant integer, mask off
838 // the high bits so we are sure to get a proper truncation if the input is
840 unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
841 const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
842 return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
845 case Instruction::Add:
846 case Instruction::Sub:
847 case Instruction::And:
848 case Instruction::Or:
849 case Instruction::Xor: {
850 const MCExpr *LHS = LowerConstant(CE->getOperand(0), AP);
851 const MCExpr *RHS = LowerConstant(CE->getOperand(1), AP);
852 switch (CE->getOpcode()) {
853 default: llvm_unreachable("Unknown binary operator constant cast expr");
854 case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
855 case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
856 case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
857 case Instruction::Or: return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
858 case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
864 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
866 if (AddrSpace != 0 || !CA->isString()) {
867 // Not a string. Print the values in successive locations
868 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
869 AP.EmitGlobalConstant(CA->getOperand(i), AddrSpace);
873 // Otherwise, it can be emitted as .ascii.
874 SmallVector<char, 128> TmpVec;
875 TmpVec.reserve(CA->getNumOperands());
876 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
877 TmpVec.push_back(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
879 AP.OutStreamer.EmitBytes(StringRef(TmpVec.data(), TmpVec.size()), AddrSpace);
882 static void EmitGlobalConstantVector(const ConstantVector *CV,
883 unsigned AddrSpace, AsmPrinter &AP) {
884 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
885 AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
888 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
889 unsigned AddrSpace, AsmPrinter &AP) {
890 // Print the fields in successive locations. Pad to align if needed!
891 const TargetData *TD = AP.TM.getTargetData();
892 unsigned Size = TD->getTypeAllocSize(CS->getType());
893 const StructLayout *Layout = TD->getStructLayout(CS->getType());
894 uint64_t SizeSoFar = 0;
895 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
896 const Constant *Field = CS->getOperand(i);
898 // Check if padding is needed and insert one or more 0s.
899 uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
900 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
901 - Layout->getElementOffset(i)) - FieldSize;
902 SizeSoFar += FieldSize + PadSize;
904 // Now print the actual field value.
905 AP.EmitGlobalConstant(Field, AddrSpace);
907 // Insert padding - this may include padding to increase the size of the
908 // current field up to the ABI size (if the struct is not packed) as well
909 // as padding to ensure that the next field starts at the right offset.
910 AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
912 assert(SizeSoFar == Layout->getSizeInBytes() &&
913 "Layout of constant struct may be incorrect!");
916 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
918 // FP Constants are printed as integer constants to avoid losing
920 if (CFP->getType()->isDoubleTy()) {
922 double Val = CFP->getValueAPF().convertToDouble();
923 AP.OutStreamer.GetCommentOS() << "double " << Val << '\n';
926 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
927 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
931 if (CFP->getType()->isFloatTy()) {
933 float Val = CFP->getValueAPF().convertToFloat();
934 AP.OutStreamer.GetCommentOS() << "float " << Val << '\n';
936 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
937 AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
941 if (CFP->getType()->isX86_FP80Ty()) {
942 // all long double variants are printed as hex
943 // api needed to prevent premature destruction
944 APInt API = CFP->getValueAPF().bitcastToAPInt();
945 const uint64_t *p = API.getRawData();
947 // Convert to double so we can print the approximate val as a comment.
948 APFloat DoubleVal = CFP->getValueAPF();
950 DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
952 AP.OutStreamer.GetCommentOS() << "x86_fp80 ~= "
953 << DoubleVal.convertToDouble() << '\n';
956 if (AP.TM.getTargetData()->isBigEndian()) {
957 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
958 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
960 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
961 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
964 // Emit the tail padding for the long double.
965 const TargetData &TD = *AP.TM.getTargetData();
966 AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
967 TD.getTypeStoreSize(CFP->getType()), AddrSpace);
971 assert(CFP->getType()->isPPC_FP128Ty() &&
972 "Floating point constant type not handled");
973 // All long double variants are printed as hex api needed to prevent
974 // premature destruction.
975 APInt API = CFP->getValueAPF().bitcastToAPInt();
976 const uint64_t *p = API.getRawData();
977 if (AP.TM.getTargetData()->isBigEndian()) {
978 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
979 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
981 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
982 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
986 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
987 unsigned AddrSpace, AsmPrinter &AP) {
988 const TargetData *TD = AP.TM.getTargetData();
989 unsigned BitWidth = CI->getBitWidth();
990 assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
992 // We don't expect assemblers to support integer data directives
993 // for more than 64 bits, so we emit the data in at most 64-bit
994 // quantities at a time.
995 const uint64_t *RawData = CI->getValue().getRawData();
996 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
997 uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
998 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1002 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1003 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1004 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
1005 uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1006 return OutStreamer.EmitZeros(Size, AddrSpace);
1009 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1010 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1017 OutStreamer.GetCommentOS() << format("0x%llx\n", CI->getZExtValue());
1018 OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1021 EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
1026 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1027 return EmitGlobalConstantArray(CVA, AddrSpace, *this);
1029 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1030 return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
1032 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1033 return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1035 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1036 return EmitGlobalConstantVector(V, AddrSpace, *this);
1038 if (isa<ConstantPointerNull>(CV)) {
1039 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1040 OutStreamer.EmitIntValue(0, Size, AddrSpace);
1044 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
1045 // thread the streamer with EmitValue.
1046 OutStreamer.EmitValue(LowerConstant(CV, *this),
1047 TM.getTargetData()->getTypeAllocSize(CV->getType()),
1051 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1052 // Target doesn't support this yet!
1053 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1056 /// PrintSpecial - Print information related to the specified machine instr
1057 /// that is independent of the operand, and may be independent of the instr
1058 /// itself. This can be useful for portably encoding the comment character
1059 /// or other bits of target-specific knowledge into the asmstrings. The
1060 /// syntax used is ${:comment}. Targets can override this to add support
1061 /// for their own strange codes.
1062 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1063 if (!strcmp(Code, "private")) {
1064 O << MAI->getPrivateGlobalPrefix();
1065 } else if (!strcmp(Code, "comment")) {
1067 O << MAI->getCommentString();
1068 } else if (!strcmp(Code, "uid")) {
1069 // Comparing the address of MI isn't sufficient, because machineinstrs may
1070 // be allocated to the same address across functions.
1071 const Function *ThisF = MI->getParent()->getParent()->getFunction();
1073 // If this is a new LastFn instruction, bump the counter.
1074 if (LastMI != MI || LastFn != ThisF) {
1082 raw_string_ostream Msg(msg);
1083 Msg << "Unknown special formatter '" << Code
1084 << "' for machine instr: " << *MI;
1085 llvm_report_error(Msg.str());
1089 /// processDebugLoc - Processes the debug information of each machine
1090 /// instruction's DebugLoc.
1091 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1092 bool BeforePrintingInsn) {
1093 if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1094 || !DW->ShouldEmitDwarfDebug())
1096 DebugLoc DL = MI->getDebugLoc();
1099 DILocation CurDLT = MF->getDILocation(DL);
1100 if (CurDLT.getScope().isNull())
1103 if (!BeforePrintingInsn) {
1104 // After printing instruction
1106 } else if (CurDLT.getNode() != PrevDLT) {
1107 unsigned L = DW->RecordSourceLine(CurDLT.getLineNumber(),
1108 CurDLT.getColumnNumber(),
1109 CurDLT.getScope().getNode());
1112 DW->BeginScope(MI, L);
1113 PrevDLT = CurDLT.getNode();
1118 /// printInlineAsm - This method formats and prints the specified machine
1119 /// instruction that is an inline asm.
1120 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1121 unsigned NumOperands = MI->getNumOperands();
1123 // Count the number of register definitions.
1124 unsigned NumDefs = 0;
1125 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1127 assert(NumDefs != NumOperands-1 && "No asm string?");
1129 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1131 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1132 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1136 // If this asmstr is empty, just print the #APP/#NOAPP markers.
1137 // These are useful to see where empty asm's wound up.
1138 if (AsmStr[0] == 0) {
1139 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1140 O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1144 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1146 // The variant of the current asmprinter.
1147 int AsmPrinterVariant = MAI->getAssemblerDialect();
1149 int CurVariant = -1; // The number of the {.|.|.} region we are in.
1150 const char *LastEmitted = AsmStr; // One past the last character emitted.
1152 while (*LastEmitted) {
1153 switch (*LastEmitted) {
1155 // Not a special case, emit the string section literally.
1156 const char *LiteralEnd = LastEmitted+1;
1157 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1158 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1160 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1161 O.write(LastEmitted, LiteralEnd-LastEmitted);
1162 LastEmitted = LiteralEnd;
1166 ++LastEmitted; // Consume newline character.
1167 O << '\n'; // Indent code with newline.
1170 ++LastEmitted; // Consume '$' character.
1174 switch (*LastEmitted) {
1175 default: Done = false; break;
1176 case '$': // $$ -> $
1177 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1179 ++LastEmitted; // Consume second '$' character.
1181 case '(': // $( -> same as GCC's { character.
1182 ++LastEmitted; // Consume '(' character.
1183 if (CurVariant != -1) {
1184 llvm_report_error("Nested variants found in inline asm string: '"
1185 + std::string(AsmStr) + "'");
1187 CurVariant = 0; // We're in the first variant now.
1190 ++LastEmitted; // consume '|' character.
1191 if (CurVariant == -1)
1192 O << '|'; // this is gcc's behavior for | outside a variant
1194 ++CurVariant; // We're in the next variant.
1196 case ')': // $) -> same as GCC's } char.
1197 ++LastEmitted; // consume ')' character.
1198 if (CurVariant == -1)
1199 O << '}'; // this is gcc's behavior for } outside a variant
1206 bool HasCurlyBraces = false;
1207 if (*LastEmitted == '{') { // ${variable}
1208 ++LastEmitted; // Consume '{' character.
1209 HasCurlyBraces = true;
1212 // If we have ${:foo}, then this is not a real operand reference, it is a
1213 // "magic" string reference, just like in .td files. Arrange to call
1215 if (HasCurlyBraces && *LastEmitted == ':') {
1217 const char *StrStart = LastEmitted;
1218 const char *StrEnd = strchr(StrStart, '}');
1220 llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1221 + std::string(AsmStr) + "'");
1224 std::string Val(StrStart, StrEnd);
1225 PrintSpecial(MI, Val.c_str());
1226 LastEmitted = StrEnd+1;
1230 const char *IDStart = LastEmitted;
1233 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1234 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1235 llvm_report_error("Bad $ operand number in inline asm string: '"
1236 + std::string(AsmStr) + "'");
1238 LastEmitted = IDEnd;
1240 char Modifier[2] = { 0, 0 };
1242 if (HasCurlyBraces) {
1243 // If we have curly braces, check for a modifier character. This
1244 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1245 if (*LastEmitted == ':') {
1246 ++LastEmitted; // Consume ':' character.
1247 if (*LastEmitted == 0) {
1248 llvm_report_error("Bad ${:} expression in inline asm string: '"
1249 + std::string(AsmStr) + "'");
1252 Modifier[0] = *LastEmitted;
1253 ++LastEmitted; // Consume modifier character.
1256 if (*LastEmitted != '}') {
1257 llvm_report_error("Bad ${} expression in inline asm string: '"
1258 + std::string(AsmStr) + "'");
1260 ++LastEmitted; // Consume '}' character.
1263 if ((unsigned)Val >= NumOperands-1) {
1264 llvm_report_error("Invalid $ operand number in inline asm string: '"
1265 + std::string(AsmStr) + "'");
1268 // Okay, we finally have a value number. Ask the target to print this
1270 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1275 // Scan to find the machine operand number for the operand.
1276 for (; Val; --Val) {
1277 if (OpNo >= MI->getNumOperands()) break;
1278 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1279 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1282 if (OpNo >= MI->getNumOperands()) {
1285 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1286 ++OpNo; // Skip over the ID number.
1288 if (Modifier[0] == 'l') // labels are target independent
1289 O << *MI->getOperand(OpNo).getMBB()->getSymbol(OutContext);
1291 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1292 if ((OpFlags & 7) == 4) {
1293 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1294 Modifier[0] ? Modifier : 0);
1296 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1297 Modifier[0] ? Modifier : 0);
1303 raw_string_ostream Msg(msg);
1304 Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1306 llvm_report_error(Msg.str());
1313 O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1316 /// printImplicitDef - This method prints the specified machine instruction
1317 /// that is an implicit def.
1318 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1319 if (!VerboseAsm) return;
1320 O.PadToColumn(MAI->getCommentColumn());
1321 O << MAI->getCommentString() << " implicit-def: "
1322 << TRI->getName(MI->getOperand(0).getReg());
1325 void AsmPrinter::printKill(const MachineInstr *MI) const {
1326 if (!VerboseAsm) return;
1327 O.PadToColumn(MAI->getCommentColumn());
1328 O << MAI->getCommentString() << " kill:";
1329 for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1330 const MachineOperand &op = MI->getOperand(n);
1331 assert(op.isReg() && "KILL instruction must have only register operands");
1332 O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1336 /// printLabel - This method prints a local label used by debug and
1337 /// exception handling tables.
1338 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1339 printLabel(MI->getOperand(0).getImm());
1342 void AsmPrinter::printLabel(unsigned Id) const {
1343 O << MAI->getPrivateGlobalPrefix() << "label" << Id << ':';
1346 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1347 /// instruction, using the specified assembler variant. Targets should
1348 /// override this to format as appropriate.
1349 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1350 unsigned AsmVariant, const char *ExtraCode) {
1351 // Target doesn't support this yet!
1355 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1356 unsigned AsmVariant,
1357 const char *ExtraCode) {
1358 // Target doesn't support this yet!
1362 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA,
1363 const char *Suffix) const {
1364 return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock(), Suffix);
1367 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1368 const BasicBlock *BB,
1369 const char *Suffix) const {
1370 assert(BB->hasName() &&
1371 "Address of anonymous basic block not supported yet!");
1373 // This code must use the function name itself, and not the function number,
1374 // since it must be possible to generate the label name from within other
1376 SmallString<60> FnName;
1377 Mang->getNameWithPrefix(FnName, F, false);
1379 // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1380 SmallString<60> NameResult;
1381 Mang->getNameWithPrefix(NameResult,
1382 StringRef("BA") + Twine((unsigned)FnName.size()) +
1383 "_" + FnName.str() + "_" + BB->getName() + Suffix,
1386 return OutContext.GetOrCreateSymbol(NameResult.str());
1389 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1390 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1391 SmallString<60> Name;
1392 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "CPI"
1393 << getFunctionNumber() << '_' << CPID;
1394 return OutContext.GetOrCreateSymbol(Name.str());
1397 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1398 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1399 const char *Prefix = isLinkerPrivate ? MAI->getLinkerPrivateGlobalPrefix() :
1400 MAI->getPrivateGlobalPrefix();
1401 SmallString<60> Name;
1402 raw_svector_ostream(Name) << Prefix << "JTI" << getFunctionNumber() << '_'
1404 return OutContext.GetOrCreateSymbol(Name.str());
1407 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
1408 /// FIXME: privatize to AsmPrinter.
1409 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
1410 SmallString<60> Name;
1411 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix()
1412 << getFunctionNumber() << '_' << UID << "_set_" << MBBID;
1413 return OutContext.GetOrCreateSymbol(Name.str());
1416 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
1418 MCSymbol *AsmPrinter::GetGlobalValueSymbol(const GlobalValue *GV) const {
1419 SmallString<60> NameStr;
1420 Mang->getNameWithPrefix(NameStr, GV, false);
1421 return OutContext.GetOrCreateSymbol(NameStr.str());
1424 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1425 /// global value name as its base, with the specified suffix, and where the
1426 /// symbol is forced to have private linkage if ForcePrivate is true.
1427 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1429 bool ForcePrivate) const {
1430 SmallString<60> NameStr;
1431 Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1432 NameStr.append(Suffix.begin(), Suffix.end());
1433 return OutContext.GetOrCreateSymbol(NameStr.str());
1436 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1438 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1439 SmallString<60> NameStr;
1440 Mang->getNameWithPrefix(NameStr, Sym);
1441 return OutContext.GetOrCreateSymbol(NameStr.str());
1446 /// PrintParentLoopComment - Print comments about parent loops of this one.
1447 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1448 unsigned FunctionNumber) {
1449 if (Loop == 0) return;
1450 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
1451 OS.indent(Loop->getLoopDepth()*2)
1452 << "Parent Loop BB" << FunctionNumber << "_"
1453 << Loop->getHeader()->getNumber()
1454 << " Depth=" << Loop->getLoopDepth() << '\n';
1458 /// PrintChildLoopComment - Print comments about child loops within
1459 /// the loop for this basic block, with nesting.
1460 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1461 unsigned FunctionNumber) {
1462 // Add child loop information
1463 for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
1464 OS.indent((*CL)->getLoopDepth()*2)
1465 << "Child Loop BB" << FunctionNumber << "_"
1466 << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
1468 PrintChildLoopComment(OS, *CL, FunctionNumber);
1472 /// EmitComments - Pretty-print comments for basic blocks.
1473 static void PrintBasicBlockLoopComments(const MachineBasicBlock &MBB,
1474 const MachineLoopInfo *LI,
1475 const AsmPrinter &AP) {
1476 // Add loop depth information
1477 const MachineLoop *Loop = LI->getLoopFor(&MBB);
1478 if (Loop == 0) return;
1480 MachineBasicBlock *Header = Loop->getHeader();
1481 assert(Header && "No header for loop");
1483 // If this block is not a loop header, just print out what is the loop header
1485 if (Header != &MBB) {
1486 AP.OutStreamer.AddComment(" in Loop: Header=BB" +
1487 Twine(AP.getFunctionNumber())+"_" +
1488 Twine(Loop->getHeader()->getNumber())+
1489 " Depth="+Twine(Loop->getLoopDepth()));
1493 // Otherwise, it is a loop header. Print out information about child and
1495 raw_ostream &OS = AP.OutStreamer.GetCommentOS();
1497 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
1500 OS.indent(Loop->getLoopDepth()*2-2);
1505 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
1507 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
1511 /// EmitBasicBlockStart - This method prints the label for the specified
1512 /// MachineBasicBlock, an alignment (if present) and a comment describing
1513 /// it if appropriate.
1514 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1515 // Emit an alignment directive for this block, if needed.
1516 if (unsigned Align = MBB->getAlignment())
1517 EmitAlignment(Log2_32(Align));
1519 // If the block has its address taken, emit a special label to satisfy
1520 // references to the block. This is done so that we don't need to
1521 // remember the number of this label, and so that we can make
1522 // forward references to labels without knowing what their numbers
1524 if (MBB->hasAddressTaken()) {
1525 const BasicBlock *BB = MBB->getBasicBlock();
1527 OutStreamer.AddComment("Address Taken");
1528 OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1531 // Print the main label for the block.
1532 if (MBB->pred_empty() || MBB->isOnlyReachableByFallthrough()) {
1534 // NOTE: Want this comment at start of line.
1535 O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1536 if (const BasicBlock *BB = MBB->getBasicBlock())
1538 OutStreamer.AddComment("%" + BB->getName());
1540 PrintBasicBlockLoopComments(*MBB, LI, *this);
1541 OutStreamer.AddBlankLine();
1545 if (const BasicBlock *BB = MBB->getBasicBlock())
1547 OutStreamer.AddComment("%" + BB->getName());
1548 PrintBasicBlockLoopComments(*MBB, LI, *this);
1551 OutStreamer.EmitLabel(MBB->getSymbol(OutContext));
1555 /// printPICJumpTableSetLabel - This method prints a set label for the
1556 /// specified MachineBasicBlock for a jumptable entry.
1557 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
1558 const MachineBasicBlock *MBB) const {
1559 if (!MAI->getSetDirective())
1562 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1563 << *GetJTSetSymbol(uid, MBB->getNumber()) << ','
1564 << *MBB->getSymbol(OutContext) << '-' << *GetJTISymbol(uid) << '\n';
1567 void AsmPrinter::printVisibility(MCSymbol *Sym, unsigned Visibility) const {
1568 MCSymbolAttr Attr = MCSA_Invalid;
1570 switch (Visibility) {
1572 case GlobalValue::HiddenVisibility:
1573 Attr = MAI->getHiddenVisibilityAttr();
1575 case GlobalValue::ProtectedVisibility:
1576 Attr = MAI->getProtectedVisibilityAttr();
1580 if (Attr != MCSA_Invalid)
1581 OutStreamer.EmitSymbolAttribute(Sym, Attr);
1584 void AsmPrinter::printOffset(int64_t Offset) const {
1587 else if (Offset < 0)
1591 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1592 if (!S->usesMetadata())
1595 gcp_iterator GCPI = GCMetadataPrinters.find(S);
1596 if (GCPI != GCMetadataPrinters.end())
1597 return GCPI->second;
1599 const char *Name = S->getName().c_str();
1601 for (GCMetadataPrinterRegistry::iterator
1602 I = GCMetadataPrinterRegistry::begin(),
1603 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1604 if (strcmp(Name, I->getName()) == 0) {
1605 GCMetadataPrinter *GMP = I->instantiate();
1607 GCMetadataPrinters.insert(std::make_pair(S, GMP));
1611 llvm_report_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
1615 /// EmitComments - Pretty-print comments for instructions
1616 void AsmPrinter::EmitComments(const MachineInstr &MI) const {
1620 bool Newline = false;
1622 if (!MI.getDebugLoc().isUnknown()) {
1623 DILocation DLT = MF->getDILocation(MI.getDebugLoc());
1625 // Print source line info.
1626 O.PadToColumn(MAI->getCommentColumn());
1627 O << MAI->getCommentString() << ' ';
1628 DIScope Scope = DLT.getScope();
1629 // Omit the directory, because it's likely to be long and uninteresting.
1630 if (!Scope.isNull())
1631 O << Scope.getFilename();
1634 O << ':' << DLT.getLineNumber();
1635 if (DLT.getColumnNumber() != 0)
1636 O << ':' << DLT.getColumnNumber();
1640 // Check for spills and reloads
1643 const MachineFrameInfo *FrameInfo =
1644 MI.getParent()->getParent()->getFrameInfo();
1646 // We assume a single instruction only has a spill or reload, not
1648 const MachineMemOperand *MMO;
1649 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
1650 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1651 MMO = *MI.memoperands_begin();
1652 if (Newline) O << '\n';
1653 O.PadToColumn(MAI->getCommentColumn());
1654 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Reload";
1658 else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
1659 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1660 if (Newline) O << '\n';
1661 O.PadToColumn(MAI->getCommentColumn());
1662 O << MAI->getCommentString() << ' '
1663 << MMO->getSize() << "-byte Folded Reload";
1667 else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&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 Spill";
1676 else if (TM.getInstrInfo()->hasStoreToStackSlot(&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 Spill";
1686 // Check for spill-induced copies
1687 unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1688 if (TM.getInstrInfo()->isMoveInstr(MI, SrcReg, DstReg,
1689 SrcSubIdx, DstSubIdx)) {
1690 if (MI.getAsmPrinterFlag(ReloadReuse)) {
1691 if (Newline) O << '\n';
1692 O.PadToColumn(MAI->getCommentColumn());
1693 O << MAI->getCommentString() << " Reload Reuse";