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 EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getTargetData())));
508 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
509 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
511 // If this jump table was deleted, ignore it.
512 if (JTBBs.empty()) continue;
514 // For the EK_LabelDifference32 entry, if the target supports .set, emit a
515 // .set directive for each unique entry. This reduces the number of
516 // relocations the assembler will generate for the jump table.
517 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
518 MAI->getSetDirective()) {
519 SmallPtrSet<MachineBasicBlock*, 16> EmittedSets;
520 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
521 if (EmittedSets.insert(JTBBs[ii]))
522 printPICJumpTableSetLabel(i, JTBBs[ii]);
525 // On some targets (e.g. Darwin) we want to emit two consequtive labels
526 // before each jump table. The first label is never referenced, but tells
527 // the assembler and linker the extents of the jump table object. The
528 // second label is actually referenced by the code.
529 if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
530 // FIXME: This doesn't have to have any specific name, just any randomly
531 // named and numbered 'l' label would work. Simplify GetJTISymbol.
532 OutStreamer.EmitLabel(GetJTISymbol(i, true));
534 OutStreamer.EmitLabel(GetJTISymbol(i));
536 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
537 EmitJumpTableEntry(MJTI, JTBBs[ii], i);
541 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
543 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
544 const MachineBasicBlock *MBB,
545 unsigned UID) const {
546 const MCExpr *Value = 0;
547 switch (MJTI->getEntryKind()) {
548 case MachineJumpTableInfo::EK_Custom32:
549 Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, UID,
552 case MachineJumpTableInfo::EK_BlockAddress:
553 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
555 Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
557 case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
558 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
559 // with a relocation as gp-relative, e.g.:
561 MCSymbol *MBBSym = MBB->getSymbol(OutContext);
562 OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
566 case MachineJumpTableInfo::EK_LabelDifference32: {
567 // EK_LabelDifference32 - Each entry is the address of the block minus
568 // the address of the jump table. This is used for PIC jump tables where
569 // gprel32 is not supported. e.g.:
570 // .word LBB123 - LJTI1_2
571 // If the .set directive is supported, this is emitted as:
572 // .set L4_5_set_123, LBB123 - LJTI1_2
573 // .word L4_5_set_123
575 // If we have emitted set directives for the jump table entries, print
576 // them rather than the entries themselves. If we're emitting PIC, then
577 // emit the table entries as differences between two text section labels.
578 if (MAI->getSetDirective()) {
579 // If we used .set, reference the .set's symbol.
580 Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
584 // Otherwise, use the difference as the jump table entry.
585 Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
586 const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
587 Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
592 assert(Value && "Unknown entry kind!");
594 unsigned EntrySize = MJTI->getEntrySize(*TM.getTargetData());
595 OutStreamer.EmitValue(Value, EntrySize, /*addrspace*/0);
599 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
600 /// special global used by LLVM. If so, emit it and return true, otherwise
601 /// do nothing and return false.
602 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
603 if (GV->getName() == "llvm.used") {
604 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
605 EmitLLVMUsedList(GV->getInitializer());
609 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
610 if (GV->getSection() == "llvm.metadata" ||
611 GV->hasAvailableExternallyLinkage())
614 if (!GV->hasAppendingLinkage()) return false;
616 assert(GV->hasInitializer() && "Not a special LLVM global!");
618 const TargetData *TD = TM.getTargetData();
619 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
620 if (GV->getName() == "llvm.global_ctors") {
621 OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
622 EmitAlignment(Align, 0);
623 EmitXXStructorList(GV->getInitializer());
625 if (TM.getRelocationModel() == Reloc::Static &&
626 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
627 StringRef Sym(".constructors_used");
628 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
634 if (GV->getName() == "llvm.global_dtors") {
635 OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
636 EmitAlignment(Align, 0);
637 EmitXXStructorList(GV->getInitializer());
639 if (TM.getRelocationModel() == Reloc::Static &&
640 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
641 StringRef Sym(".destructors_used");
642 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
651 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
652 /// global in the specified llvm.used list for which emitUsedDirectiveFor
653 /// is true, as being used with this directive.
654 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
655 // Should be an array of 'i8*'.
656 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
657 if (InitList == 0) return;
659 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
660 const GlobalValue *GV =
661 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
662 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
663 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(GV),
668 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
669 /// function pointers, ignoring the init priority.
670 void AsmPrinter::EmitXXStructorList(Constant *List) {
671 // Should be an array of '{ int, void ()* }' structs. The first value is the
672 // init priority, which we ignore.
673 if (!isa<ConstantArray>(List)) return;
674 ConstantArray *InitList = cast<ConstantArray>(List);
675 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
676 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
677 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
679 if (CS->getOperand(1)->isNullValue())
680 return; // Found a null terminator, exit printing.
681 // Emit the function pointer.
682 EmitGlobalConstant(CS->getOperand(1));
686 //===--------------------------------------------------------------------===//
687 // Emission and print routines
690 /// EmitInt8 - Emit a byte directive and value.
692 void AsmPrinter::EmitInt8(int Value) const {
693 OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
696 /// EmitInt16 - Emit a short directive and value.
698 void AsmPrinter::EmitInt16(int Value) const {
699 OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
702 /// EmitInt32 - Emit a long directive and value.
704 void AsmPrinter::EmitInt32(int Value) const {
705 OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
708 /// EmitInt64 - Emit a long long directive and value.
710 void AsmPrinter::EmitInt64(uint64_t Value) const {
711 OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
714 //===----------------------------------------------------------------------===//
716 // EmitAlignment - Emit an alignment directive to the specified power of
717 // two boundary. For example, if you pass in 3 here, you will get an 8
718 // byte alignment. If a global value is specified, and if that global has
719 // an explicit alignment requested, it will unconditionally override the
720 // alignment request. However, if ForcedAlignBits is specified, this value
721 // has final say: the ultimate alignment will be the max of ForcedAlignBits
722 // and the alignment computed with NumBits and the global.
726 // if (GV && GV->hasalignment) Align = GV->getalignment();
727 // Align = std::max(Align, ForcedAlignBits);
729 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
730 unsigned ForcedAlignBits,
731 bool UseFillExpr) const {
732 if (GV && GV->getAlignment())
733 NumBits = Log2_32(GV->getAlignment());
734 NumBits = std::max(NumBits, ForcedAlignBits);
736 if (NumBits == 0) return; // No need to emit alignment.
738 unsigned FillValue = 0;
739 if (getCurrentSection()->getKind().isText())
740 FillValue = MAI->getTextAlignFillValue();
742 OutStreamer.EmitValueToAlignment(1 << NumBits, FillValue, 1, 0);
745 /// LowerConstant - Lower the specified LLVM Constant to an MCExpr.
747 static const MCExpr *LowerConstant(const Constant *CV, AsmPrinter &AP) {
748 MCContext &Ctx = AP.OutContext;
750 if (CV->isNullValue() || isa<UndefValue>(CV))
751 return MCConstantExpr::Create(0, Ctx);
753 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
754 return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
756 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
757 return MCSymbolRefExpr::Create(AP.GetGlobalValueSymbol(GV), Ctx);
758 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
759 return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
761 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
763 llvm_unreachable("Unknown constant value to lower!");
764 return MCConstantExpr::Create(0, Ctx);
767 switch (CE->getOpcode()) {
768 case Instruction::ZExt:
769 case Instruction::SExt:
770 case Instruction::FPTrunc:
771 case Instruction::FPExt:
772 case Instruction::UIToFP:
773 case Instruction::SIToFP:
774 case Instruction::FPToUI:
775 case Instruction::FPToSI:
776 default: llvm_unreachable("FIXME: Don't support this constant cast expr");
777 case Instruction::GetElementPtr: {
778 const TargetData &TD = *AP.TM.getTargetData();
779 // Generate a symbolic expression for the byte address
780 const Constant *PtrVal = CE->getOperand(0);
781 SmallVector<Value*, 8> IdxVec(CE->op_begin()+1, CE->op_end());
782 int64_t Offset = TD.getIndexedOffset(PtrVal->getType(), &IdxVec[0],
785 const MCExpr *Base = LowerConstant(CE->getOperand(0), AP);
789 // Truncate/sext the offset to the pointer size.
790 if (TD.getPointerSizeInBits() != 64) {
791 int SExtAmount = 64-TD.getPointerSizeInBits();
792 Offset = (Offset << SExtAmount) >> SExtAmount;
795 return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
799 case Instruction::Trunc:
800 // We emit the value and depend on the assembler to truncate the generated
801 // expression properly. This is important for differences between
802 // blockaddress labels. Since the two labels are in the same function, it
803 // is reasonable to treat their delta as a 32-bit value.
805 case Instruction::BitCast:
806 return LowerConstant(CE->getOperand(0), AP);
808 case Instruction::IntToPtr: {
809 const TargetData &TD = *AP.TM.getTargetData();
810 // Handle casts to pointers by changing them into casts to the appropriate
811 // integer type. This promotes constant folding and simplifies this code.
812 Constant *Op = CE->getOperand(0);
813 Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
815 return LowerConstant(Op, AP);
818 case Instruction::PtrToInt: {
819 const TargetData &TD = *AP.TM.getTargetData();
820 // Support only foldable casts to/from pointers that can be eliminated by
821 // changing the pointer to the appropriately sized integer type.
822 Constant *Op = CE->getOperand(0);
823 const Type *Ty = CE->getType();
825 const MCExpr *OpExpr = LowerConstant(Op, AP);
827 // We can emit the pointer value into this slot if the slot is an
828 // integer slot equal to the size of the pointer.
829 if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
832 // Otherwise the pointer is smaller than the resultant integer, mask off
833 // the high bits so we are sure to get a proper truncation if the input is
835 unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
836 const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
837 return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
840 case Instruction::Add:
841 case Instruction::Sub:
842 case Instruction::And:
843 case Instruction::Or:
844 case Instruction::Xor: {
845 const MCExpr *LHS = LowerConstant(CE->getOperand(0), AP);
846 const MCExpr *RHS = LowerConstant(CE->getOperand(1), AP);
847 switch (CE->getOpcode()) {
848 default: llvm_unreachable("Unknown binary operator constant cast expr");
849 case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
850 case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
851 case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
852 case Instruction::Or: return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
853 case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
859 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
861 if (AddrSpace != 0 || !CA->isString()) {
862 // Not a string. Print the values in successive locations
863 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
864 AP.EmitGlobalConstant(CA->getOperand(i), AddrSpace);
868 // Otherwise, it can be emitted as .ascii.
869 SmallVector<char, 128> TmpVec;
870 TmpVec.reserve(CA->getNumOperands());
871 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
872 TmpVec.push_back(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
874 AP.OutStreamer.EmitBytes(StringRef(TmpVec.data(), TmpVec.size()), AddrSpace);
877 static void EmitGlobalConstantVector(const ConstantVector *CV,
878 unsigned AddrSpace, AsmPrinter &AP) {
879 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
880 AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
883 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
884 unsigned AddrSpace, AsmPrinter &AP) {
885 // Print the fields in successive locations. Pad to align if needed!
886 const TargetData *TD = AP.TM.getTargetData();
887 unsigned Size = TD->getTypeAllocSize(CS->getType());
888 const StructLayout *Layout = TD->getStructLayout(CS->getType());
889 uint64_t SizeSoFar = 0;
890 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
891 const Constant *Field = CS->getOperand(i);
893 // Check if padding is needed and insert one or more 0s.
894 uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
895 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
896 - Layout->getElementOffset(i)) - FieldSize;
897 SizeSoFar += FieldSize + PadSize;
899 // Now print the actual field value.
900 AP.EmitGlobalConstant(Field, AddrSpace);
902 // Insert padding - this may include padding to increase the size of the
903 // current field up to the ABI size (if the struct is not packed) as well
904 // as padding to ensure that the next field starts at the right offset.
905 AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
907 assert(SizeSoFar == Layout->getSizeInBytes() &&
908 "Layout of constant struct may be incorrect!");
911 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
913 // FP Constants are printed as integer constants to avoid losing
915 if (CFP->getType()->isDoubleTy()) {
917 double Val = CFP->getValueAPF().convertToDouble();
918 AP.OutStreamer.GetCommentOS() << "double " << Val << '\n';
921 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
922 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
926 if (CFP->getType()->isFloatTy()) {
928 float Val = CFP->getValueAPF().convertToFloat();
929 AP.OutStreamer.GetCommentOS() << "float " << Val << '\n';
931 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
932 AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
936 if (CFP->getType()->isX86_FP80Ty()) {
937 // all long double variants are printed as hex
938 // api needed to prevent premature destruction
939 APInt API = CFP->getValueAPF().bitcastToAPInt();
940 const uint64_t *p = API.getRawData();
942 // Convert to double so we can print the approximate val as a comment.
943 APFloat DoubleVal = CFP->getValueAPF();
945 DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
947 AP.OutStreamer.GetCommentOS() << "x86_fp80 ~= "
948 << DoubleVal.convertToDouble() << '\n';
951 if (AP.TM.getTargetData()->isBigEndian()) {
952 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
953 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
955 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
956 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
959 // Emit the tail padding for the long double.
960 const TargetData &TD = *AP.TM.getTargetData();
961 AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
962 TD.getTypeStoreSize(CFP->getType()), AddrSpace);
966 assert(CFP->getType()->isPPC_FP128Ty() &&
967 "Floating point constant type not handled");
968 // All long double variants are printed as hex api needed to prevent
969 // premature destruction.
970 APInt API = CFP->getValueAPF().bitcastToAPInt();
971 const uint64_t *p = API.getRawData();
972 if (AP.TM.getTargetData()->isBigEndian()) {
973 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
974 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
976 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
977 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
981 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
982 unsigned AddrSpace, AsmPrinter &AP) {
983 const TargetData *TD = AP.TM.getTargetData();
984 unsigned BitWidth = CI->getBitWidth();
985 assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
987 // We don't expect assemblers to support integer data directives
988 // for more than 64 bits, so we emit the data in at most 64-bit
989 // quantities at a time.
990 const uint64_t *RawData = CI->getValue().getRawData();
991 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
992 uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
993 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
997 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
998 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
999 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
1000 uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1001 return OutStreamer.EmitZeros(Size, AddrSpace);
1004 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1005 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1012 OutStreamer.GetCommentOS() << format("0x%llx\n", CI->getZExtValue());
1013 OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1016 EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
1021 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1022 return EmitGlobalConstantArray(CVA, AddrSpace, *this);
1024 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1025 return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
1027 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1028 return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1030 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1031 return EmitGlobalConstantVector(V, AddrSpace, *this);
1033 if (isa<ConstantPointerNull>(CV)) {
1034 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1035 OutStreamer.EmitIntValue(0, Size, AddrSpace);
1039 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
1040 // thread the streamer with EmitValue.
1041 OutStreamer.EmitValue(LowerConstant(CV, *this),
1042 TM.getTargetData()->getTypeAllocSize(CV->getType()),
1046 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1047 // Target doesn't support this yet!
1048 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1051 /// PrintSpecial - Print information related to the specified machine instr
1052 /// that is independent of the operand, and may be independent of the instr
1053 /// itself. This can be useful for portably encoding the comment character
1054 /// or other bits of target-specific knowledge into the asmstrings. The
1055 /// syntax used is ${:comment}. Targets can override this to add support
1056 /// for their own strange codes.
1057 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1058 if (!strcmp(Code, "private")) {
1059 O << MAI->getPrivateGlobalPrefix();
1060 } else if (!strcmp(Code, "comment")) {
1062 O << MAI->getCommentString();
1063 } else if (!strcmp(Code, "uid")) {
1064 // Comparing the address of MI isn't sufficient, because machineinstrs may
1065 // be allocated to the same address across functions.
1066 const Function *ThisF = MI->getParent()->getParent()->getFunction();
1068 // If this is a new LastFn instruction, bump the counter.
1069 if (LastMI != MI || LastFn != ThisF) {
1077 raw_string_ostream Msg(msg);
1078 Msg << "Unknown special formatter '" << Code
1079 << "' for machine instr: " << *MI;
1080 llvm_report_error(Msg.str());
1084 /// processDebugLoc - Processes the debug information of each machine
1085 /// instruction's DebugLoc.
1086 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1087 bool BeforePrintingInsn) {
1088 if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1089 || !DW->ShouldEmitDwarfDebug())
1091 DebugLoc DL = MI->getDebugLoc();
1094 DILocation CurDLT = MF->getDILocation(DL);
1095 if (CurDLT.getScope().isNull())
1098 if (!BeforePrintingInsn) {
1099 // After printing instruction
1101 } else if (CurDLT.getNode() != PrevDLT) {
1102 unsigned L = DW->RecordSourceLine(CurDLT.getLineNumber(),
1103 CurDLT.getColumnNumber(),
1104 CurDLT.getScope().getNode());
1107 DW->BeginScope(MI, L);
1108 PrevDLT = CurDLT.getNode();
1113 /// printInlineAsm - This method formats and prints the specified machine
1114 /// instruction that is an inline asm.
1115 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1116 unsigned NumOperands = MI->getNumOperands();
1118 // Count the number of register definitions.
1119 unsigned NumDefs = 0;
1120 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1122 assert(NumDefs != NumOperands-1 && "No asm string?");
1124 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1126 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1127 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1131 // If this asmstr is empty, just print the #APP/#NOAPP markers.
1132 // These are useful to see where empty asm's wound up.
1133 if (AsmStr[0] == 0) {
1134 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1135 O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1139 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1141 // The variant of the current asmprinter.
1142 int AsmPrinterVariant = MAI->getAssemblerDialect();
1144 int CurVariant = -1; // The number of the {.|.|.} region we are in.
1145 const char *LastEmitted = AsmStr; // One past the last character emitted.
1147 while (*LastEmitted) {
1148 switch (*LastEmitted) {
1150 // Not a special case, emit the string section literally.
1151 const char *LiteralEnd = LastEmitted+1;
1152 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1153 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1155 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1156 O.write(LastEmitted, LiteralEnd-LastEmitted);
1157 LastEmitted = LiteralEnd;
1161 ++LastEmitted; // Consume newline character.
1162 O << '\n'; // Indent code with newline.
1165 ++LastEmitted; // Consume '$' character.
1169 switch (*LastEmitted) {
1170 default: Done = false; break;
1171 case '$': // $$ -> $
1172 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1174 ++LastEmitted; // Consume second '$' character.
1176 case '(': // $( -> same as GCC's { character.
1177 ++LastEmitted; // Consume '(' character.
1178 if (CurVariant != -1) {
1179 llvm_report_error("Nested variants found in inline asm string: '"
1180 + std::string(AsmStr) + "'");
1182 CurVariant = 0; // We're in the first variant now.
1185 ++LastEmitted; // consume '|' character.
1186 if (CurVariant == -1)
1187 O << '|'; // this is gcc's behavior for | outside a variant
1189 ++CurVariant; // We're in the next variant.
1191 case ')': // $) -> same as GCC's } char.
1192 ++LastEmitted; // consume ')' character.
1193 if (CurVariant == -1)
1194 O << '}'; // this is gcc's behavior for } outside a variant
1201 bool HasCurlyBraces = false;
1202 if (*LastEmitted == '{') { // ${variable}
1203 ++LastEmitted; // Consume '{' character.
1204 HasCurlyBraces = true;
1207 // If we have ${:foo}, then this is not a real operand reference, it is a
1208 // "magic" string reference, just like in .td files. Arrange to call
1210 if (HasCurlyBraces && *LastEmitted == ':') {
1212 const char *StrStart = LastEmitted;
1213 const char *StrEnd = strchr(StrStart, '}');
1215 llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1216 + std::string(AsmStr) + "'");
1219 std::string Val(StrStart, StrEnd);
1220 PrintSpecial(MI, Val.c_str());
1221 LastEmitted = StrEnd+1;
1225 const char *IDStart = LastEmitted;
1228 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1229 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1230 llvm_report_error("Bad $ operand number in inline asm string: '"
1231 + std::string(AsmStr) + "'");
1233 LastEmitted = IDEnd;
1235 char Modifier[2] = { 0, 0 };
1237 if (HasCurlyBraces) {
1238 // If we have curly braces, check for a modifier character. This
1239 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1240 if (*LastEmitted == ':') {
1241 ++LastEmitted; // Consume ':' character.
1242 if (*LastEmitted == 0) {
1243 llvm_report_error("Bad ${:} expression in inline asm string: '"
1244 + std::string(AsmStr) + "'");
1247 Modifier[0] = *LastEmitted;
1248 ++LastEmitted; // Consume modifier character.
1251 if (*LastEmitted != '}') {
1252 llvm_report_error("Bad ${} expression in inline asm string: '"
1253 + std::string(AsmStr) + "'");
1255 ++LastEmitted; // Consume '}' character.
1258 if ((unsigned)Val >= NumOperands-1) {
1259 llvm_report_error("Invalid $ operand number in inline asm string: '"
1260 + std::string(AsmStr) + "'");
1263 // Okay, we finally have a value number. Ask the target to print this
1265 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1270 // Scan to find the machine operand number for the operand.
1271 for (; Val; --Val) {
1272 if (OpNo >= MI->getNumOperands()) break;
1273 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1274 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1277 if (OpNo >= MI->getNumOperands()) {
1280 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1281 ++OpNo; // Skip over the ID number.
1283 if (Modifier[0] == 'l') // labels are target independent
1284 O << *MI->getOperand(OpNo).getMBB()->getSymbol(OutContext);
1286 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1287 if ((OpFlags & 7) == 4) {
1288 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1289 Modifier[0] ? Modifier : 0);
1291 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1292 Modifier[0] ? Modifier : 0);
1298 raw_string_ostream Msg(msg);
1299 Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1301 llvm_report_error(Msg.str());
1308 O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1311 /// printImplicitDef - This method prints the specified machine instruction
1312 /// that is an implicit def.
1313 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1314 if (!VerboseAsm) return;
1315 O.PadToColumn(MAI->getCommentColumn());
1316 O << MAI->getCommentString() << " implicit-def: "
1317 << TRI->getName(MI->getOperand(0).getReg());
1320 void AsmPrinter::printKill(const MachineInstr *MI) const {
1321 if (!VerboseAsm) return;
1322 O.PadToColumn(MAI->getCommentColumn());
1323 O << MAI->getCommentString() << " kill:";
1324 for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1325 const MachineOperand &op = MI->getOperand(n);
1326 assert(op.isReg() && "KILL instruction must have only register operands");
1327 O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1331 /// printLabel - This method prints a local label used by debug and
1332 /// exception handling tables.
1333 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1334 printLabel(MI->getOperand(0).getImm());
1337 void AsmPrinter::printLabel(unsigned Id) const {
1338 O << MAI->getPrivateGlobalPrefix() << "label" << Id << ':';
1341 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1342 /// instruction, using the specified assembler variant. Targets should
1343 /// override this to format as appropriate.
1344 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1345 unsigned AsmVariant, const char *ExtraCode) {
1346 // Target doesn't support this yet!
1350 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1351 unsigned AsmVariant,
1352 const char *ExtraCode) {
1353 // Target doesn't support this yet!
1357 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA,
1358 const char *Suffix) const {
1359 return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock(), Suffix);
1362 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1363 const BasicBlock *BB,
1364 const char *Suffix) const {
1365 assert(BB->hasName() &&
1366 "Address of anonymous basic block not supported yet!");
1368 // This code must use the function name itself, and not the function number,
1369 // since it must be possible to generate the label name from within other
1371 SmallString<60> FnName;
1372 Mang->getNameWithPrefix(FnName, F, false);
1374 // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1375 SmallString<60> NameResult;
1376 Mang->getNameWithPrefix(NameResult,
1377 StringRef("BA") + Twine((unsigned)FnName.size()) +
1378 "_" + FnName.str() + "_" + BB->getName() + Suffix,
1381 return OutContext.GetOrCreateSymbol(NameResult.str());
1384 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1385 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1386 SmallString<60> Name;
1387 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "CPI"
1388 << getFunctionNumber() << '_' << CPID;
1389 return OutContext.GetOrCreateSymbol(Name.str());
1392 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1393 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1394 return MF->getJumpTableInfo()->getJTISymbol(JTID, OutContext,isLinkerPrivate);
1397 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
1398 /// FIXME: privatize to AsmPrinter.
1399 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
1400 SmallString<60> Name;
1401 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix()
1402 << getFunctionNumber() << '_' << UID << "_set_" << MBBID;
1403 return OutContext.GetOrCreateSymbol(Name.str());
1406 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
1408 MCSymbol *AsmPrinter::GetGlobalValueSymbol(const GlobalValue *GV) const {
1409 SmallString<60> NameStr;
1410 Mang->getNameWithPrefix(NameStr, GV, false);
1411 return OutContext.GetOrCreateSymbol(NameStr.str());
1414 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1415 /// global value name as its base, with the specified suffix, and where the
1416 /// symbol is forced to have private linkage if ForcePrivate is true.
1417 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1419 bool ForcePrivate) const {
1420 SmallString<60> NameStr;
1421 Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1422 NameStr.append(Suffix.begin(), Suffix.end());
1423 return OutContext.GetOrCreateSymbol(NameStr.str());
1426 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1428 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1429 SmallString<60> NameStr;
1430 Mang->getNameWithPrefix(NameStr, Sym);
1431 return OutContext.GetOrCreateSymbol(NameStr.str());
1436 /// PrintParentLoopComment - Print comments about parent loops of this one.
1437 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1438 unsigned FunctionNumber) {
1439 if (Loop == 0) return;
1440 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
1441 OS.indent(Loop->getLoopDepth()*2)
1442 << "Parent Loop BB" << FunctionNumber << "_"
1443 << Loop->getHeader()->getNumber()
1444 << " Depth=" << Loop->getLoopDepth() << '\n';
1448 /// PrintChildLoopComment - Print comments about child loops within
1449 /// the loop for this basic block, with nesting.
1450 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1451 unsigned FunctionNumber) {
1452 // Add child loop information
1453 for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
1454 OS.indent((*CL)->getLoopDepth()*2)
1455 << "Child Loop BB" << FunctionNumber << "_"
1456 << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
1458 PrintChildLoopComment(OS, *CL, FunctionNumber);
1462 /// EmitComments - Pretty-print comments for basic blocks.
1463 static void PrintBasicBlockLoopComments(const MachineBasicBlock &MBB,
1464 const MachineLoopInfo *LI,
1465 const AsmPrinter &AP) {
1466 // Add loop depth information
1467 const MachineLoop *Loop = LI->getLoopFor(&MBB);
1468 if (Loop == 0) return;
1470 MachineBasicBlock *Header = Loop->getHeader();
1471 assert(Header && "No header for loop");
1473 // If this block is not a loop header, just print out what is the loop header
1475 if (Header != &MBB) {
1476 AP.OutStreamer.AddComment(" in Loop: Header=BB" +
1477 Twine(AP.getFunctionNumber())+"_" +
1478 Twine(Loop->getHeader()->getNumber())+
1479 " Depth="+Twine(Loop->getLoopDepth()));
1483 // Otherwise, it is a loop header. Print out information about child and
1485 raw_ostream &OS = AP.OutStreamer.GetCommentOS();
1487 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
1490 OS.indent(Loop->getLoopDepth()*2-2);
1495 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
1497 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
1501 /// EmitBasicBlockStart - This method prints the label for the specified
1502 /// MachineBasicBlock, an alignment (if present) and a comment describing
1503 /// it if appropriate.
1504 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1505 // Emit an alignment directive for this block, if needed.
1506 if (unsigned Align = MBB->getAlignment())
1507 EmitAlignment(Log2_32(Align));
1509 // If the block has its address taken, emit a special label to satisfy
1510 // references to the block. This is done so that we don't need to
1511 // remember the number of this label, and so that we can make
1512 // forward references to labels without knowing what their numbers
1514 if (MBB->hasAddressTaken()) {
1515 const BasicBlock *BB = MBB->getBasicBlock();
1517 OutStreamer.AddComment("Address Taken");
1518 OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1521 // Print the main label for the block.
1522 if (MBB->pred_empty() || MBB->isOnlyReachableByFallthrough()) {
1524 // NOTE: Want this comment at start of line.
1525 O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1526 if (const BasicBlock *BB = MBB->getBasicBlock())
1528 OutStreamer.AddComment("%" + BB->getName());
1530 PrintBasicBlockLoopComments(*MBB, LI, *this);
1531 OutStreamer.AddBlankLine();
1535 if (const BasicBlock *BB = MBB->getBasicBlock())
1537 OutStreamer.AddComment("%" + BB->getName());
1538 PrintBasicBlockLoopComments(*MBB, LI, *this);
1541 OutStreamer.EmitLabel(MBB->getSymbol(OutContext));
1545 /// printPICJumpTableSetLabel - This method prints a set label for the
1546 /// specified MachineBasicBlock for a jumptable entry.
1547 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
1548 const MachineBasicBlock *MBB) const {
1549 const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
1550 const TargetLowering *TLI = TM.getTargetLowering();
1551 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1552 << *GetJTSetSymbol(uid, MBB->getNumber()) << ','
1553 << *MBB->getSymbol(OutContext) << '-'
1554 << *TLI->getPICJumpTableRelocBaseExpr(MJTI,uid,OutContext)
1558 void AsmPrinter::printVisibility(MCSymbol *Sym, unsigned Visibility) const {
1559 MCSymbolAttr Attr = MCSA_Invalid;
1561 switch (Visibility) {
1563 case GlobalValue::HiddenVisibility:
1564 Attr = MAI->getHiddenVisibilityAttr();
1566 case GlobalValue::ProtectedVisibility:
1567 Attr = MAI->getProtectedVisibilityAttr();
1571 if (Attr != MCSA_Invalid)
1572 OutStreamer.EmitSymbolAttribute(Sym, Attr);
1575 void AsmPrinter::printOffset(int64_t Offset) const {
1578 else if (Offset < 0)
1582 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1583 if (!S->usesMetadata())
1586 gcp_iterator GCPI = GCMetadataPrinters.find(S);
1587 if (GCPI != GCMetadataPrinters.end())
1588 return GCPI->second;
1590 const char *Name = S->getName().c_str();
1592 for (GCMetadataPrinterRegistry::iterator
1593 I = GCMetadataPrinterRegistry::begin(),
1594 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1595 if (strcmp(Name, I->getName()) == 0) {
1596 GCMetadataPrinter *GMP = I->instantiate();
1598 GCMetadataPrinters.insert(std::make_pair(S, GMP));
1602 llvm_report_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
1606 /// EmitComments - Pretty-print comments for instructions
1607 void AsmPrinter::EmitComments(const MachineInstr &MI) const {
1611 bool Newline = false;
1613 if (!MI.getDebugLoc().isUnknown()) {
1614 DILocation DLT = MF->getDILocation(MI.getDebugLoc());
1616 // Print source line info.
1617 O.PadToColumn(MAI->getCommentColumn());
1618 O << MAI->getCommentString() << ' ';
1619 DIScope Scope = DLT.getScope();
1620 // Omit the directory, because it's likely to be long and uninteresting.
1621 if (!Scope.isNull())
1622 O << Scope.getFilename();
1625 O << ':' << DLT.getLineNumber();
1626 if (DLT.getColumnNumber() != 0)
1627 O << ':' << DLT.getColumnNumber();
1631 // Check for spills and reloads
1634 const MachineFrameInfo *FrameInfo =
1635 MI.getParent()->getParent()->getFrameInfo();
1637 // We assume a single instruction only has a spill or reload, not
1639 const MachineMemOperand *MMO;
1640 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
1641 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1642 MMO = *MI.memoperands_begin();
1643 if (Newline) O << '\n';
1644 O.PadToColumn(MAI->getCommentColumn());
1645 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Reload";
1649 else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
1650 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1651 if (Newline) O << '\n';
1652 O.PadToColumn(MAI->getCommentColumn());
1653 O << MAI->getCommentString() << ' '
1654 << MMO->getSize() << "-byte Folded Reload";
1658 else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
1659 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1660 MMO = *MI.memoperands_begin();
1661 if (Newline) O << '\n';
1662 O.PadToColumn(MAI->getCommentColumn());
1663 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Spill";
1667 else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
1668 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1669 if (Newline) O << '\n';
1670 O.PadToColumn(MAI->getCommentColumn());
1671 O << MAI->getCommentString() << ' '
1672 << MMO->getSize() << "-byte Folded Spill";
1677 // Check for spill-induced copies
1678 unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1679 if (TM.getInstrInfo()->isMoveInstr(MI, SrcReg, DstReg,
1680 SrcSubIdx, DstSubIdx)) {
1681 if (MI.getAsmPrinterFlag(ReloadReuse)) {
1682 if (Newline) O << '\n';
1683 O.PadToColumn(MAI->getCommentColumn());
1684 O << MAI->getCommentString() << " Reload Reuse";