1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the AsmPrinter class.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/AsmPrinter.h"
15 #include "llvm/Assembly/Writer.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/Constants.h"
18 #include "llvm/Module.h"
19 #include "llvm/CodeGen/DwarfWriter.h"
20 #include "llvm/CodeGen/GCMetadataPrinter.h"
21 #include "llvm/CodeGen/MachineConstantPool.h"
22 #include "llvm/CodeGen/MachineFrameInfo.h"
23 #include "llvm/CodeGen/MachineFunction.h"
24 #include "llvm/CodeGen/MachineJumpTableInfo.h"
25 #include "llvm/CodeGen/MachineLoopInfo.h"
26 #include "llvm/CodeGen/MachineModuleInfo.h"
27 #include "llvm/Analysis/DebugInfo.h"
28 #include "llvm/MC/MCContext.h"
29 #include "llvm/MC/MCExpr.h"
30 #include "llvm/MC/MCInst.h"
31 #include "llvm/MC/MCSection.h"
32 #include "llvm/MC/MCStreamer.h"
33 #include "llvm/MC/MCSymbol.h"
34 #include "llvm/Support/CommandLine.h"
35 #include "llvm/Support/ErrorHandling.h"
36 #include "llvm/Support/Format.h"
37 #include "llvm/Support/FormattedStream.h"
38 #include "llvm/MC/MCAsmInfo.h"
39 #include "llvm/Target/Mangler.h"
40 #include "llvm/Target/TargetData.h"
41 #include "llvm/Target/TargetInstrInfo.h"
42 #include "llvm/Target/TargetLowering.h"
43 #include "llvm/Target/TargetLoweringObjectFile.h"
44 #include "llvm/Target/TargetOptions.h"
45 #include "llvm/Target/TargetRegisterInfo.h"
46 #include "llvm/ADT/SmallPtrSet.h"
47 #include "llvm/ADT/SmallString.h"
51 static cl::opt<cl::boolOrDefault>
52 AsmVerbose("asm-verbose", cl::desc("Add comments to directives."),
53 cl::init(cl::BOU_UNSET));
55 static bool getVerboseAsm(bool VDef) {
58 case cl::BOU_UNSET: return VDef;
59 case cl::BOU_TRUE: return true;
60 case cl::BOU_FALSE: return false;
64 char AsmPrinter::ID = 0;
65 AsmPrinter::AsmPrinter(formatted_raw_ostream &o, TargetMachine &tm,
66 const MCAsmInfo *T, bool VDef)
67 : MachineFunctionPass(&ID), FunctionNumber(0), O(o),
68 TM(tm), MAI(T), TRI(tm.getRegisterInfo()),
70 OutContext(*new MCContext()),
71 // FIXME: Pass instprinter to streamer.
72 OutStreamer(*createAsmStreamer(OutContext, O, *T,
73 TM.getTargetData()->isLittleEndian(),
74 getVerboseAsm(VDef), 0)),
76 LastMI(0), LastFn(0), Counter(~0U), PrevDLT(NULL) {
78 VerboseAsm = getVerboseAsm(VDef);
81 AsmPrinter::~AsmPrinter() {
82 for (gcp_iterator I = GCMetadataPrinters.begin(),
83 E = GCMetadataPrinters.end(); I != E; ++I)
90 TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
91 return TM.getTargetLowering()->getObjFileLowering();
94 /// getCurrentSection() - Return the current section we are emitting to.
95 const MCSection *AsmPrinter::getCurrentSection() const {
96 return OutStreamer.getCurrentSection();
100 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
101 AU.setPreservesAll();
102 MachineFunctionPass::getAnalysisUsage(AU);
103 AU.addRequired<GCModuleInfo>();
105 AU.addRequired<MachineLoopInfo>();
108 bool AsmPrinter::doInitialization(Module &M) {
109 // Initialize TargetLoweringObjectFile.
110 const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
111 .Initialize(OutContext, TM);
113 Mang = new Mangler(*MAI);
115 // Allow the target to emit any magic that it wants at the start of the file.
116 EmitStartOfAsmFile(M);
118 // Very minimal debug info. It is ignored if we emit actual debug info. If we
119 // don't, this at least helps the user find where a global came from.
120 if (MAI->hasSingleParameterDotFile()) {
122 OutStreamer.EmitFileDirective(M.getModuleIdentifier());
125 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
126 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
127 for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
128 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
129 MP->beginAssembly(O, *this, *MAI);
131 if (!M.getModuleInlineAsm().empty())
132 O << MAI->getCommentString() << " Start of file scope inline assembly\n"
133 << M.getModuleInlineAsm()
134 << '\n' << MAI->getCommentString()
135 << " End of file scope inline assembly\n";
137 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
139 MMI->AnalyzeModule(M);
140 DW = getAnalysisIfAvailable<DwarfWriter>();
142 DW->BeginModule(&M, MMI, O, this, MAI);
147 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
148 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
149 if (!GV->hasInitializer()) // External globals require no code.
152 // Check to see if this is a special global used by LLVM, if so, emit it.
153 if (EmitSpecialLLVMGlobal(GV))
156 MCSymbol *GVSym = GetGlobalValueSymbol(GV);
157 printVisibility(GVSym, GV->getVisibility());
159 if (MAI->hasDotTypeDotSizeDirective())
160 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
162 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
164 const TargetData *TD = TM.getTargetData();
165 unsigned Size = TD->getTypeAllocSize(GV->getType()->getElementType());
166 unsigned AlignLog = TD->getPreferredAlignmentLog(GV);
168 // Handle common and BSS local symbols (.lcomm).
169 if (GVKind.isCommon() || GVKind.isBSSLocal()) {
170 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
173 WriteAsOperand(OutStreamer.GetCommentOS(), GV,
174 /*PrintType=*/false, GV->getParent());
175 OutStreamer.GetCommentOS() << '\n';
178 // Handle common symbols.
179 if (GVKind.isCommon()) {
181 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
185 // Handle local BSS symbols.
186 if (MAI->hasMachoZeroFillDirective()) {
187 const MCSection *TheSection =
188 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
189 // .zerofill __DATA, __bss, _foo, 400, 5
190 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
194 if (MAI->hasLCOMMDirective()) {
196 OutStreamer.EmitLocalCommonSymbol(GVSym, Size);
201 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
203 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
207 const MCSection *TheSection =
208 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
210 // Handle the zerofill directive on darwin, which is a special form of BSS
212 if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
214 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
215 // .zerofill __DATA, __common, _foo, 400, 5
216 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
220 OutStreamer.SwitchSection(TheSection);
222 // TODO: Factor into an 'emit linkage' thing that is shared with function
224 switch (GV->getLinkage()) {
225 case GlobalValue::CommonLinkage:
226 case GlobalValue::LinkOnceAnyLinkage:
227 case GlobalValue::LinkOnceODRLinkage:
228 case GlobalValue::WeakAnyLinkage:
229 case GlobalValue::WeakODRLinkage:
230 case GlobalValue::LinkerPrivateLinkage:
231 if (MAI->getWeakDefDirective() != 0) {
233 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
234 // .weak_definition _foo
235 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
236 } else if (const char *LinkOnce = MAI->getLinkOnceDirective()) {
238 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
239 // FIXME: linkonce should be a section attribute, handled by COFF Section
241 // http://sourceware.org/binutils/docs-2.20/as/Linkonce.html#Linkonce
242 // .linkonce same_size
246 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
249 case GlobalValue::DLLExportLinkage:
250 case GlobalValue::AppendingLinkage:
251 // FIXME: appending linkage variables should go into a section of
252 // their name or something. For now, just emit them as external.
253 case GlobalValue::ExternalLinkage:
254 // If external or appending, declare as a global symbol.
256 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
258 case GlobalValue::PrivateLinkage:
259 case GlobalValue::InternalLinkage:
262 llvm_unreachable("Unknown linkage type!");
265 EmitAlignment(AlignLog, GV);
267 WriteAsOperand(OutStreamer.GetCommentOS(), GV,
268 /*PrintType=*/false, GV->getParent());
269 OutStreamer.GetCommentOS() << '\n';
271 OutStreamer.EmitLabel(GVSym);
273 EmitGlobalConstant(GV->getInitializer());
275 if (MAI->hasDotTypeDotSizeDirective())
277 OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
279 OutStreamer.AddBlankLine();
283 bool AsmPrinter::doFinalization(Module &M) {
284 // Emit global variables.
285 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
287 EmitGlobalVariable(I);
289 // Emit final debug information.
290 if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
293 // If the target wants to know about weak references, print them all.
294 if (MAI->getWeakRefDirective()) {
295 // FIXME: This is not lazy, it would be nice to only print weak references
296 // to stuff that is actually used. Note that doing so would require targets
297 // to notice uses in operands (due to constant exprs etc). This should
298 // happen with the MC stuff eventually.
300 // Print out module-level global variables here.
301 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
303 if (!I->hasExternalWeakLinkage()) continue;
304 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
308 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
309 if (!I->hasExternalWeakLinkage()) continue;
310 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
315 if (MAI->getSetDirective()) {
316 OutStreamer.AddBlankLine();
317 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
319 MCSymbol *Name = GetGlobalValueSymbol(I);
321 const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
322 MCSymbol *Target = GetGlobalValueSymbol(GV);
324 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
325 OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
326 else if (I->hasWeakLinkage())
327 OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
329 assert(I->hasLocalLinkage() && "Invalid alias linkage");
331 printVisibility(Name, I->getVisibility());
333 O << MAI->getSetDirective() << ' ' << *Name << ", " << *Target << '\n';
337 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
338 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
339 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
340 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
341 MP->finishAssembly(O, *this, *MAI);
343 // If we don't have any trampolines, then we don't require stack memory
344 // to be executable. Some targets have a directive to declare this.
345 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
346 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
347 if (MCSection *S = MAI->getNonexecutableStackSection(OutContext))
348 OutStreamer.SwitchSection(S);
350 // Allow the target to emit any magic that it wants at the end of the file,
351 // after everything else has gone out.
354 delete Mang; Mang = 0;
357 OutStreamer.Finish();
361 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
362 // Get the function symbol.
363 CurrentFnSym = GetGlobalValueSymbol(MF.getFunction());
364 IncrementFunctionNumber();
367 LI = &getAnalysis<MachineLoopInfo>();
371 // SectionCPs - Keep track the alignment, constpool entries per Section.
375 SmallVector<unsigned, 4> CPEs;
376 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
380 /// EmitConstantPool - Print to the current output stream assembly
381 /// representations of the constants in the constant pool MCP. This is
382 /// used to print out constants which have been "spilled to memory" by
383 /// the code generator.
385 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
386 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
387 if (CP.empty()) return;
389 // Calculate sections for constant pool entries. We collect entries to go into
390 // the same section together to reduce amount of section switch statements.
391 SmallVector<SectionCPs, 4> CPSections;
392 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
393 const MachineConstantPoolEntry &CPE = CP[i];
394 unsigned Align = CPE.getAlignment();
397 switch (CPE.getRelocationInfo()) {
398 default: llvm_unreachable("Unknown section kind");
399 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
401 Kind = SectionKind::getReadOnlyWithRelLocal();
404 switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
405 case 4: Kind = SectionKind::getMergeableConst4(); break;
406 case 8: Kind = SectionKind::getMergeableConst8(); break;
407 case 16: Kind = SectionKind::getMergeableConst16();break;
408 default: Kind = SectionKind::getMergeableConst(); break;
412 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
414 // The number of sections are small, just do a linear search from the
415 // last section to the first.
417 unsigned SecIdx = CPSections.size();
418 while (SecIdx != 0) {
419 if (CPSections[--SecIdx].S == S) {
425 SecIdx = CPSections.size();
426 CPSections.push_back(SectionCPs(S, Align));
429 if (Align > CPSections[SecIdx].Alignment)
430 CPSections[SecIdx].Alignment = Align;
431 CPSections[SecIdx].CPEs.push_back(i);
434 // Now print stuff into the calculated sections.
435 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
436 OutStreamer.SwitchSection(CPSections[i].S);
437 EmitAlignment(Log2_32(CPSections[i].Alignment));
440 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
441 unsigned CPI = CPSections[i].CPEs[j];
442 MachineConstantPoolEntry CPE = CP[CPI];
444 // Emit inter-object padding for alignment.
445 unsigned AlignMask = CPE.getAlignment() - 1;
446 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
447 OutStreamer.EmitFill(NewOffset - Offset, 0/*fillval*/, 0/*addrspace*/);
449 const Type *Ty = CPE.getType();
450 Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
452 // Emit the label with a comment on it.
454 OutStreamer.GetCommentOS() << "constant pool ";
455 WriteTypeSymbolic(OutStreamer.GetCommentOS(), CPE.getType(),
456 MF->getFunction()->getParent());
457 OutStreamer.GetCommentOS() << '\n';
459 OutStreamer.EmitLabel(GetCPISymbol(CPI));
461 if (CPE.isMachineConstantPoolEntry())
462 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
464 EmitGlobalConstant(CPE.Val.ConstVal);
469 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
470 /// by the current function to the current output stream.
472 void AsmPrinter::EmitJumpTableInfo(MachineFunction &MF) {
473 MachineJumpTableInfo *MJTI = MF.getJumpTableInfo();
474 if (MJTI == 0) return;
475 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
476 if (JT.empty()) return;
478 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
480 // Pick the directive to use to print the jump table entries, and switch to
481 // the appropriate section.
482 const Function *F = MF.getFunction();
483 bool JTInDiffSection = false;
484 if (F->isWeakForLinker() ||
485 (IsPic && !TM.getTargetLowering()->usesGlobalOffsetTable())) {
486 // In PIC mode, we need to emit the jump table to the same section as the
487 // function body itself, otherwise the label differences won't make sense.
488 // We should also do if the section name is NULL or function is declared in
489 // discardable section.
490 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang,
493 // Otherwise, drop it in the readonly section.
494 const MCSection *ReadOnlySection =
495 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
496 OutStreamer.SwitchSection(ReadOnlySection);
497 JTInDiffSection = true;
500 unsigned EntrySize = MJTI->getEntrySize(*TM.getTargetData());
501 EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getTargetData())));
503 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
504 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
506 // If this jump table was deleted, ignore it.
507 if (JTBBs.empty()) continue;
509 // For PIC codegen, if possible we want to use the SetDirective to reduce
510 // the number of relocations the assembler will generate for the jump table.
511 // Set directives are all printed before the jump table itself.
512 SmallPtrSet<MachineBasicBlock*, 16> EmittedSets;
513 if (MAI->getSetDirective() && IsPic)
514 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
515 if (EmittedSets.insert(JTBBs[ii]))
516 printPICJumpTableSetLabel(i, JTBBs[ii]);
518 // On some targets (e.g. Darwin) we want to emit two consequtive labels
519 // before each jump table. The first label is never referenced, but tells
520 // the assembler and linker the extents of the jump table object. The
521 // second label is actually referenced by the code.
522 if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
523 OutStreamer.EmitLabel(GetJTISymbol(i, true));
525 OutStreamer.EmitLabel(GetJTISymbol(i));
528 // In non-pic mode, the entries in the jump table are direct references
529 // to the basic blocks.
530 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
531 MCSymbol *MBBSym = GetMBBSymbol(JTBBs[ii]->getNumber());
532 OutStreamer.EmitValue(MCSymbolRefExpr::Create(MBBSym, OutContext),
533 EntrySize, /*addrspace*/0);
536 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
537 printPICJumpTableEntry(MJTI, JTBBs[ii], i);
542 void AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
543 const MachineBasicBlock *MBB,
544 unsigned uid) const {
545 const MCExpr *Value = 0;
546 switch (MJTI->getEntryKind()) {
547 case MachineJumpTableInfo::EK_Custom32:
548 Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, uid,
551 case MachineJumpTableInfo::EK_BlockAddress:
552 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
554 Value = MCSymbolRefExpr::Create(GetMBBSymbol(MBB->getNumber()), OutContext);
556 case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
557 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
558 // with a relocation as gp-relative, e.g.:
560 MCSymbol *MBBSym = GetMBBSymbol(MBB->getNumber());
561 OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
565 case MachineJumpTableInfo::EK_LabelDifference32: {
566 // EK_LabelDifference32 - Each entry is the address of the block minus
567 // the address of the jump table. This is used for PIC jump tables where
568 // gprel32 is not supported. e.g.:
569 // .word LBB123 - LJTI1_2
570 // If the .set directive is supported, this is emitted as:
571 // .set L4_5_set_123, LBB123 - LJTI1_2
572 // .word L4_5_set_123
574 // If we have emitted set directives for the jump table entries, print
575 // them rather than the entries themselves. If we're emitting PIC, then
576 // emit the table entries as differences between two text section labels.
577 if (MAI->getSetDirective()) {
578 // If we used .set, reference the .set's symbol.
579 Value = MCSymbolRefExpr::Create(GetJTSetSymbol(uid, MBB->getNumber()),
583 // Otherwise, use the difference as the jump table entry.
584 Value = MCSymbolRefExpr::Create(GetMBBSymbol(MBB->getNumber()), OutContext);
585 const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(uid), OutContext);
586 Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
591 assert(Value && "Unknown entry kind!");
593 unsigned EntrySize = MJTI->getEntrySize(*TM.getTargetData());
594 OutStreamer.EmitValue(Value, EntrySize, /*addrspace*/0);
598 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
599 /// special global used by LLVM. If so, emit it and return true, otherwise
600 /// do nothing and return false.
601 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
602 if (GV->getName() == "llvm.used") {
603 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
604 EmitLLVMUsedList(GV->getInitializer());
608 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
609 if (GV->getSection() == "llvm.metadata" ||
610 GV->hasAvailableExternallyLinkage())
613 if (!GV->hasAppendingLinkage()) return false;
615 assert(GV->hasInitializer() && "Not a special LLVM global!");
617 const TargetData *TD = TM.getTargetData();
618 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
619 if (GV->getName() == "llvm.global_ctors") {
620 OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
621 EmitAlignment(Align, 0);
622 EmitXXStructorList(GV->getInitializer());
624 if (TM.getRelocationModel() == Reloc::Static &&
625 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
626 StringRef Sym(".constructors_used");
627 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
633 if (GV->getName() == "llvm.global_dtors") {
634 OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
635 EmitAlignment(Align, 0);
636 EmitXXStructorList(GV->getInitializer());
638 if (TM.getRelocationModel() == Reloc::Static &&
639 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
640 StringRef Sym(".destructors_used");
641 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
650 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
651 /// global in the specified llvm.used list for which emitUsedDirectiveFor
652 /// is true, as being used with this directive.
653 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
654 // Should be an array of 'i8*'.
655 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
656 if (InitList == 0) return;
658 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
659 const GlobalValue *GV =
660 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
661 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
662 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(GV),
667 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
668 /// function pointers, ignoring the init priority.
669 void AsmPrinter::EmitXXStructorList(Constant *List) {
670 // Should be an array of '{ int, void ()* }' structs. The first value is the
671 // init priority, which we ignore.
672 if (!isa<ConstantArray>(List)) return;
673 ConstantArray *InitList = cast<ConstantArray>(List);
674 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
675 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
676 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
678 if (CS->getOperand(1)->isNullValue())
679 return; // Found a null terminator, exit printing.
680 // Emit the function pointer.
681 EmitGlobalConstant(CS->getOperand(1));
685 //===--------------------------------------------------------------------===//
686 // Emission and print routines
689 /// EmitInt8 - Emit a byte directive and value.
691 void AsmPrinter::EmitInt8(int Value) const {
692 OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
695 /// EmitInt16 - Emit a short directive and value.
697 void AsmPrinter::EmitInt16(int Value) const {
698 OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
701 /// EmitInt32 - Emit a long directive and value.
703 void AsmPrinter::EmitInt32(int Value) const {
704 OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
707 /// EmitInt64 - Emit a long long directive and value.
709 void AsmPrinter::EmitInt64(uint64_t Value) const {
710 OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
713 //===----------------------------------------------------------------------===//
715 // EmitAlignment - Emit an alignment directive to the specified power of
716 // two boundary. For example, if you pass in 3 here, you will get an 8
717 // byte alignment. If a global value is specified, and if that global has
718 // an explicit alignment requested, it will unconditionally override the
719 // alignment request. However, if ForcedAlignBits is specified, this value
720 // has final say: the ultimate alignment will be the max of ForcedAlignBits
721 // and the alignment computed with NumBits and the global.
725 // if (GV && GV->hasalignment) Align = GV->getalignment();
726 // Align = std::max(Align, ForcedAlignBits);
728 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
729 unsigned ForcedAlignBits,
730 bool UseFillExpr) const {
731 if (GV && GV->getAlignment())
732 NumBits = Log2_32(GV->getAlignment());
733 NumBits = std::max(NumBits, ForcedAlignBits);
735 if (NumBits == 0) return; // No need to emit alignment.
737 unsigned FillValue = 0;
738 if (getCurrentSection()->getKind().isText())
739 FillValue = MAI->getTextAlignFillValue();
741 OutStreamer.EmitValueToAlignment(1 << NumBits, FillValue, 1, 0);
744 /// LowerConstant - Lower the specified LLVM Constant to an MCExpr.
746 static const MCExpr *LowerConstant(const Constant *CV, AsmPrinter &AP) {
747 MCContext &Ctx = AP.OutContext;
749 if (CV->isNullValue() || isa<UndefValue>(CV))
750 return MCConstantExpr::Create(0, Ctx);
752 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
753 return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
755 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
756 return MCSymbolRefExpr::Create(AP.GetGlobalValueSymbol(GV), Ctx);
757 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
758 return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
760 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
762 llvm_unreachable("Unknown constant value to lower!");
763 return MCConstantExpr::Create(0, Ctx);
766 switch (CE->getOpcode()) {
767 case Instruction::ZExt:
768 case Instruction::SExt:
769 case Instruction::FPTrunc:
770 case Instruction::FPExt:
771 case Instruction::UIToFP:
772 case Instruction::SIToFP:
773 case Instruction::FPToUI:
774 case Instruction::FPToSI:
775 default: llvm_unreachable("FIXME: Don't support this constant cast expr");
776 case Instruction::GetElementPtr: {
777 const TargetData &TD = *AP.TM.getTargetData();
778 // Generate a symbolic expression for the byte address
779 const Constant *PtrVal = CE->getOperand(0);
780 SmallVector<Value*, 8> IdxVec(CE->op_begin()+1, CE->op_end());
781 int64_t Offset = TD.getIndexedOffset(PtrVal->getType(), &IdxVec[0],
784 const MCExpr *Base = LowerConstant(CE->getOperand(0), AP);
788 // Truncate/sext the offset to the pointer size.
789 if (TD.getPointerSizeInBits() != 64) {
790 int SExtAmount = 64-TD.getPointerSizeInBits();
791 Offset = (Offset << SExtAmount) >> SExtAmount;
794 return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
798 case Instruction::Trunc:
799 // We emit the value and depend on the assembler to truncate the generated
800 // expression properly. This is important for differences between
801 // blockaddress labels. Since the two labels are in the same function, it
802 // is reasonable to treat their delta as a 32-bit value.
804 case Instruction::BitCast:
805 return LowerConstant(CE->getOperand(0), AP);
807 case Instruction::IntToPtr: {
808 const TargetData &TD = *AP.TM.getTargetData();
809 // Handle casts to pointers by changing them into casts to the appropriate
810 // integer type. This promotes constant folding and simplifies this code.
811 Constant *Op = CE->getOperand(0);
812 Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
814 return LowerConstant(Op, AP);
817 case Instruction::PtrToInt: {
818 const TargetData &TD = *AP.TM.getTargetData();
819 // Support only foldable casts to/from pointers that can be eliminated by
820 // changing the pointer to the appropriately sized integer type.
821 Constant *Op = CE->getOperand(0);
822 const Type *Ty = CE->getType();
824 const MCExpr *OpExpr = LowerConstant(Op, AP);
826 // We can emit the pointer value into this slot if the slot is an
827 // integer slot equal to the size of the pointer.
828 if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
831 // Otherwise the pointer is smaller than the resultant integer, mask off
832 // the high bits so we are sure to get a proper truncation if the input is
834 unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
835 const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
836 return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
839 case Instruction::Add:
840 case Instruction::Sub:
841 case Instruction::And:
842 case Instruction::Or:
843 case Instruction::Xor: {
844 const MCExpr *LHS = LowerConstant(CE->getOperand(0), AP);
845 const MCExpr *RHS = LowerConstant(CE->getOperand(1), AP);
846 switch (CE->getOpcode()) {
847 default: llvm_unreachable("Unknown binary operator constant cast expr");
848 case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
849 case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
850 case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
851 case Instruction::Or: return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
852 case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
858 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
860 if (AddrSpace != 0 || !CA->isString()) {
861 // Not a string. Print the values in successive locations
862 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
863 AP.EmitGlobalConstant(CA->getOperand(i), AddrSpace);
867 // Otherwise, it can be emitted as .ascii.
868 SmallVector<char, 128> TmpVec;
869 TmpVec.reserve(CA->getNumOperands());
870 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
871 TmpVec.push_back(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
873 AP.OutStreamer.EmitBytes(StringRef(TmpVec.data(), TmpVec.size()), AddrSpace);
876 static void EmitGlobalConstantVector(const ConstantVector *CV,
877 unsigned AddrSpace, AsmPrinter &AP) {
878 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
879 AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
882 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
883 unsigned AddrSpace, AsmPrinter &AP) {
884 // Print the fields in successive locations. Pad to align if needed!
885 const TargetData *TD = AP.TM.getTargetData();
886 unsigned Size = TD->getTypeAllocSize(CS->getType());
887 const StructLayout *Layout = TD->getStructLayout(CS->getType());
888 uint64_t SizeSoFar = 0;
889 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
890 const Constant *Field = CS->getOperand(i);
892 // Check if padding is needed and insert one or more 0s.
893 uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
894 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
895 - Layout->getElementOffset(i)) - FieldSize;
896 SizeSoFar += FieldSize + PadSize;
898 // Now print the actual field value.
899 AP.EmitGlobalConstant(Field, AddrSpace);
901 // Insert padding - this may include padding to increase the size of the
902 // current field up to the ABI size (if the struct is not packed) as well
903 // as padding to ensure that the next field starts at the right offset.
904 AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
906 assert(SizeSoFar == Layout->getSizeInBytes() &&
907 "Layout of constant struct may be incorrect!");
910 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
912 // FP Constants are printed as integer constants to avoid losing
914 if (CFP->getType()->isDoubleTy()) {
916 double Val = CFP->getValueAPF().convertToDouble();
917 AP.OutStreamer.GetCommentOS() << "double " << Val << '\n';
920 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
921 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
925 if (CFP->getType()->isFloatTy()) {
927 float Val = CFP->getValueAPF().convertToFloat();
928 AP.OutStreamer.GetCommentOS() << "float " << Val << '\n';
930 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
931 AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
935 if (CFP->getType()->isX86_FP80Ty()) {
936 // all long double variants are printed as hex
937 // api needed to prevent premature destruction
938 APInt API = CFP->getValueAPF().bitcastToAPInt();
939 const uint64_t *p = API.getRawData();
941 // Convert to double so we can print the approximate val as a comment.
942 APFloat DoubleVal = CFP->getValueAPF();
944 DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
946 AP.OutStreamer.GetCommentOS() << "x86_fp80 ~= "
947 << DoubleVal.convertToDouble() << '\n';
950 if (AP.TM.getTargetData()->isBigEndian()) {
951 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
952 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
954 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
955 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
958 // Emit the tail padding for the long double.
959 const TargetData &TD = *AP.TM.getTargetData();
960 AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
961 TD.getTypeStoreSize(CFP->getType()), AddrSpace);
965 assert(CFP->getType()->isPPC_FP128Ty() &&
966 "Floating point constant type not handled");
967 // All long double variants are printed as hex api needed to prevent
968 // premature destruction.
969 APInt API = CFP->getValueAPF().bitcastToAPInt();
970 const uint64_t *p = API.getRawData();
971 if (AP.TM.getTargetData()->isBigEndian()) {
972 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
973 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
975 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
976 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
980 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
981 unsigned AddrSpace, AsmPrinter &AP) {
982 const TargetData *TD = AP.TM.getTargetData();
983 unsigned BitWidth = CI->getBitWidth();
984 assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
986 // We don't expect assemblers to support integer data directives
987 // for more than 64 bits, so we emit the data in at most 64-bit
988 // quantities at a time.
989 const uint64_t *RawData = CI->getValue().getRawData();
990 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
991 uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
992 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
996 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
997 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
998 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
999 uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1000 return OutStreamer.EmitZeros(Size, AddrSpace);
1003 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1004 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1011 OutStreamer.GetCommentOS() << format("0x%llx\n", CI->getZExtValue());
1012 OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1015 EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
1020 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1021 return EmitGlobalConstantArray(CVA, AddrSpace, *this);
1023 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1024 return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
1026 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1027 return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1029 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1030 return EmitGlobalConstantVector(V, AddrSpace, *this);
1032 if (isa<ConstantPointerNull>(CV)) {
1033 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1034 OutStreamer.EmitIntValue(0, Size, AddrSpace);
1038 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
1039 // thread the streamer with EmitValue.
1040 OutStreamer.EmitValue(LowerConstant(CV, *this),
1041 TM.getTargetData()->getTypeAllocSize(CV->getType()),
1045 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1046 // Target doesn't support this yet!
1047 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1050 /// PrintSpecial - Print information related to the specified machine instr
1051 /// that is independent of the operand, and may be independent of the instr
1052 /// itself. This can be useful for portably encoding the comment character
1053 /// or other bits of target-specific knowledge into the asmstrings. The
1054 /// syntax used is ${:comment}. Targets can override this to add support
1055 /// for their own strange codes.
1056 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1057 if (!strcmp(Code, "private")) {
1058 O << MAI->getPrivateGlobalPrefix();
1059 } else if (!strcmp(Code, "comment")) {
1061 O << MAI->getCommentString();
1062 } else if (!strcmp(Code, "uid")) {
1063 // Comparing the address of MI isn't sufficient, because machineinstrs may
1064 // be allocated to the same address across functions.
1065 const Function *ThisF = MI->getParent()->getParent()->getFunction();
1067 // If this is a new LastFn instruction, bump the counter.
1068 if (LastMI != MI || LastFn != ThisF) {
1076 raw_string_ostream Msg(msg);
1077 Msg << "Unknown special formatter '" << Code
1078 << "' for machine instr: " << *MI;
1079 llvm_report_error(Msg.str());
1083 /// processDebugLoc - Processes the debug information of each machine
1084 /// instruction's DebugLoc.
1085 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1086 bool BeforePrintingInsn) {
1087 if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1088 || !DW->ShouldEmitDwarfDebug())
1090 DebugLoc DL = MI->getDebugLoc();
1093 DILocation CurDLT = MF->getDILocation(DL);
1094 if (CurDLT.getScope().isNull())
1097 if (!BeforePrintingInsn) {
1098 // After printing instruction
1100 } else if (CurDLT.getNode() != PrevDLT) {
1101 unsigned L = DW->RecordSourceLine(CurDLT.getLineNumber(),
1102 CurDLT.getColumnNumber(),
1103 CurDLT.getScope().getNode());
1106 DW->BeginScope(MI, L);
1107 PrevDLT = CurDLT.getNode();
1112 /// printInlineAsm - This method formats and prints the specified machine
1113 /// instruction that is an inline asm.
1114 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1115 unsigned NumOperands = MI->getNumOperands();
1117 // Count the number of register definitions.
1118 unsigned NumDefs = 0;
1119 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1121 assert(NumDefs != NumOperands-1 && "No asm string?");
1123 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1125 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1126 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1130 // If this asmstr is empty, just print the #APP/#NOAPP markers.
1131 // These are useful to see where empty asm's wound up.
1132 if (AsmStr[0] == 0) {
1133 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1134 O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1138 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1140 // The variant of the current asmprinter.
1141 int AsmPrinterVariant = MAI->getAssemblerDialect();
1143 int CurVariant = -1; // The number of the {.|.|.} region we are in.
1144 const char *LastEmitted = AsmStr; // One past the last character emitted.
1146 while (*LastEmitted) {
1147 switch (*LastEmitted) {
1149 // Not a special case, emit the string section literally.
1150 const char *LiteralEnd = LastEmitted+1;
1151 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1152 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1154 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1155 O.write(LastEmitted, LiteralEnd-LastEmitted);
1156 LastEmitted = LiteralEnd;
1160 ++LastEmitted; // Consume newline character.
1161 O << '\n'; // Indent code with newline.
1164 ++LastEmitted; // Consume '$' character.
1168 switch (*LastEmitted) {
1169 default: Done = false; break;
1170 case '$': // $$ -> $
1171 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1173 ++LastEmitted; // Consume second '$' character.
1175 case '(': // $( -> same as GCC's { character.
1176 ++LastEmitted; // Consume '(' character.
1177 if (CurVariant != -1) {
1178 llvm_report_error("Nested variants found in inline asm string: '"
1179 + std::string(AsmStr) + "'");
1181 CurVariant = 0; // We're in the first variant now.
1184 ++LastEmitted; // consume '|' character.
1185 if (CurVariant == -1)
1186 O << '|'; // this is gcc's behavior for | outside a variant
1188 ++CurVariant; // We're in the next variant.
1190 case ')': // $) -> same as GCC's } char.
1191 ++LastEmitted; // consume ')' character.
1192 if (CurVariant == -1)
1193 O << '}'; // this is gcc's behavior for } outside a variant
1200 bool HasCurlyBraces = false;
1201 if (*LastEmitted == '{') { // ${variable}
1202 ++LastEmitted; // Consume '{' character.
1203 HasCurlyBraces = true;
1206 // If we have ${:foo}, then this is not a real operand reference, it is a
1207 // "magic" string reference, just like in .td files. Arrange to call
1209 if (HasCurlyBraces && *LastEmitted == ':') {
1211 const char *StrStart = LastEmitted;
1212 const char *StrEnd = strchr(StrStart, '}');
1214 llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1215 + std::string(AsmStr) + "'");
1218 std::string Val(StrStart, StrEnd);
1219 PrintSpecial(MI, Val.c_str());
1220 LastEmitted = StrEnd+1;
1224 const char *IDStart = LastEmitted;
1227 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1228 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1229 llvm_report_error("Bad $ operand number in inline asm string: '"
1230 + std::string(AsmStr) + "'");
1232 LastEmitted = IDEnd;
1234 char Modifier[2] = { 0, 0 };
1236 if (HasCurlyBraces) {
1237 // If we have curly braces, check for a modifier character. This
1238 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1239 if (*LastEmitted == ':') {
1240 ++LastEmitted; // Consume ':' character.
1241 if (*LastEmitted == 0) {
1242 llvm_report_error("Bad ${:} expression in inline asm string: '"
1243 + std::string(AsmStr) + "'");
1246 Modifier[0] = *LastEmitted;
1247 ++LastEmitted; // Consume modifier character.
1250 if (*LastEmitted != '}') {
1251 llvm_report_error("Bad ${} expression in inline asm string: '"
1252 + std::string(AsmStr) + "'");
1254 ++LastEmitted; // Consume '}' character.
1257 if ((unsigned)Val >= NumOperands-1) {
1258 llvm_report_error("Invalid $ operand number in inline asm string: '"
1259 + std::string(AsmStr) + "'");
1262 // Okay, we finally have a value number. Ask the target to print this
1264 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1269 // Scan to find the machine operand number for the operand.
1270 for (; Val; --Val) {
1271 if (OpNo >= MI->getNumOperands()) break;
1272 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1273 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1276 if (OpNo >= MI->getNumOperands()) {
1279 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1280 ++OpNo; // Skip over the ID number.
1282 if (Modifier[0] == 'l') // labels are target independent
1283 O << *GetMBBSymbol(MI->getOperand(OpNo).getMBB()->getNumber());
1285 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1286 if ((OpFlags & 7) == 4) {
1287 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1288 Modifier[0] ? Modifier : 0);
1290 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1291 Modifier[0] ? Modifier : 0);
1297 raw_string_ostream Msg(msg);
1298 Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1300 llvm_report_error(Msg.str());
1307 O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1310 /// printImplicitDef - This method prints the specified machine instruction
1311 /// that is an implicit def.
1312 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1313 if (!VerboseAsm) return;
1314 O.PadToColumn(MAI->getCommentColumn());
1315 O << MAI->getCommentString() << " implicit-def: "
1316 << TRI->getName(MI->getOperand(0).getReg());
1319 void AsmPrinter::printKill(const MachineInstr *MI) const {
1320 if (!VerboseAsm) return;
1321 O.PadToColumn(MAI->getCommentColumn());
1322 O << MAI->getCommentString() << " kill:";
1323 for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1324 const MachineOperand &op = MI->getOperand(n);
1325 assert(op.isReg() && "KILL instruction must have only register operands");
1326 O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1330 /// printLabel - This method prints a local label used by debug and
1331 /// exception handling tables.
1332 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1333 printLabel(MI->getOperand(0).getImm());
1336 void AsmPrinter::printLabel(unsigned Id) const {
1337 O << MAI->getPrivateGlobalPrefix() << "label" << Id << ':';
1340 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1341 /// instruction, using the specified assembler variant. Targets should
1342 /// override this to format as appropriate.
1343 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1344 unsigned AsmVariant, const char *ExtraCode) {
1345 // Target doesn't support this yet!
1349 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1350 unsigned AsmVariant,
1351 const char *ExtraCode) {
1352 // Target doesn't support this yet!
1356 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA,
1357 const char *Suffix) const {
1358 return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock(), Suffix);
1361 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1362 const BasicBlock *BB,
1363 const char *Suffix) const {
1364 assert(BB->hasName() &&
1365 "Address of anonymous basic block not supported yet!");
1367 // This code must use the function name itself, and not the function number,
1368 // since it must be possible to generate the label name from within other
1370 SmallString<60> FnName;
1371 Mang->getNameWithPrefix(FnName, F, false);
1373 // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1374 SmallString<60> NameResult;
1375 Mang->getNameWithPrefix(NameResult,
1376 StringRef("BA") + Twine((unsigned)FnName.size()) +
1377 "_" + FnName.str() + "_" + BB->getName() + Suffix,
1380 return OutContext.GetOrCreateSymbol(NameResult.str());
1383 MCSymbol *AsmPrinter::GetMBBSymbol(unsigned MBBID) const {
1384 SmallString<60> Name;
1385 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "BB"
1386 << getFunctionNumber() << '_' << MBBID;
1387 return OutContext.GetOrCreateSymbol(Name.str());
1390 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1391 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1392 SmallString<60> Name;
1393 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "CPI"
1394 << getFunctionNumber() << '_' << CPID;
1395 return OutContext.GetOrCreateSymbol(Name.str());
1398 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1399 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1400 const char *Prefix = isLinkerPrivate ? MAI->getLinkerPrivateGlobalPrefix() :
1401 MAI->getPrivateGlobalPrefix();
1402 SmallString<60> Name;
1403 raw_svector_ostream(Name) << Prefix << "JTI" << getFunctionNumber() << '_'
1405 return OutContext.GetOrCreateSymbol(Name.str());
1408 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
1409 /// FIXME: privatize to AsmPrinter.
1410 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
1411 SmallString<60> Name;
1412 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix()
1413 << getFunctionNumber() << '_' << UID << "_set_" << MBBID;
1414 return OutContext.GetOrCreateSymbol(Name.str());
1417 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
1419 MCSymbol *AsmPrinter::GetGlobalValueSymbol(const GlobalValue *GV) const {
1420 SmallString<60> NameStr;
1421 Mang->getNameWithPrefix(NameStr, GV, false);
1422 return OutContext.GetOrCreateSymbol(NameStr.str());
1425 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1426 /// global value name as its base, with the specified suffix, and where the
1427 /// symbol is forced to have private linkage if ForcePrivate is true.
1428 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1430 bool ForcePrivate) const {
1431 SmallString<60> NameStr;
1432 Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1433 NameStr.append(Suffix.begin(), Suffix.end());
1434 return OutContext.GetOrCreateSymbol(NameStr.str());
1437 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1439 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1440 SmallString<60> NameStr;
1441 Mang->getNameWithPrefix(NameStr, Sym);
1442 return OutContext.GetOrCreateSymbol(NameStr.str());
1447 /// PrintParentLoopComment - Print comments about parent loops of this one.
1448 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1449 unsigned FunctionNumber) {
1450 if (Loop == 0) return;
1451 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
1452 OS.indent(Loop->getLoopDepth()*2)
1453 << "Parent Loop BB" << FunctionNumber << "_"
1454 << Loop->getHeader()->getNumber()
1455 << " Depth=" << Loop->getLoopDepth() << '\n';
1459 /// PrintChildLoopComment - Print comments about child loops within
1460 /// the loop for this basic block, with nesting.
1461 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1462 unsigned FunctionNumber) {
1463 // Add child loop information
1464 for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
1465 OS.indent((*CL)->getLoopDepth()*2)
1466 << "Child Loop BB" << FunctionNumber << "_"
1467 << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
1469 PrintChildLoopComment(OS, *CL, FunctionNumber);
1473 /// EmitComments - Pretty-print comments for basic blocks.
1474 static void PrintBasicBlockLoopComments(const MachineBasicBlock &MBB,
1475 const MachineLoopInfo *LI,
1476 const AsmPrinter &AP) {
1477 // Add loop depth information
1478 const MachineLoop *Loop = LI->getLoopFor(&MBB);
1479 if (Loop == 0) return;
1481 MachineBasicBlock *Header = Loop->getHeader();
1482 assert(Header && "No header for loop");
1484 // If this block is not a loop header, just print out what is the loop header
1486 if (Header != &MBB) {
1487 AP.OutStreamer.AddComment(" in Loop: Header=BB" +
1488 Twine(AP.getFunctionNumber())+"_" +
1489 Twine(Loop->getHeader()->getNumber())+
1490 " Depth="+Twine(Loop->getLoopDepth()));
1494 // Otherwise, it is a loop header. Print out information about child and
1496 raw_ostream &OS = AP.OutStreamer.GetCommentOS();
1498 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
1501 OS.indent(Loop->getLoopDepth()*2-2);
1506 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
1508 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
1512 /// EmitBasicBlockStart - This method prints the label for the specified
1513 /// MachineBasicBlock, an alignment (if present) and a comment describing
1514 /// it if appropriate.
1515 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1516 // Emit an alignment directive for this block, if needed.
1517 if (unsigned Align = MBB->getAlignment())
1518 EmitAlignment(Log2_32(Align));
1520 // If the block has its address taken, emit a special label to satisfy
1521 // references to the block. This is done so that we don't need to
1522 // remember the number of this label, and so that we can make
1523 // forward references to labels without knowing what their numbers
1525 if (MBB->hasAddressTaken()) {
1526 const BasicBlock *BB = MBB->getBasicBlock();
1528 OutStreamer.AddComment("Address Taken");
1529 OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1532 // Print the main label for the block.
1533 if (MBB->pred_empty() || MBB->isOnlyReachableByFallthrough()) {
1535 // NOTE: Want this comment at start of line.
1536 O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1537 if (const BasicBlock *BB = MBB->getBasicBlock())
1539 OutStreamer.AddComment("%" + BB->getName());
1541 PrintBasicBlockLoopComments(*MBB, LI, *this);
1542 OutStreamer.AddBlankLine();
1546 if (const BasicBlock *BB = MBB->getBasicBlock())
1548 OutStreamer.AddComment("%" + BB->getName());
1549 PrintBasicBlockLoopComments(*MBB, LI, *this);
1552 OutStreamer.EmitLabel(GetMBBSymbol(MBB->getNumber()));
1556 /// printPICJumpTableSetLabel - This method prints a set label for the
1557 /// specified MachineBasicBlock for a jumptable entry.
1558 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
1559 const MachineBasicBlock *MBB) const {
1560 if (!MAI->getSetDirective())
1563 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1564 << *GetJTSetSymbol(uid, MBB->getNumber()) << ','
1565 << *GetMBBSymbol(MBB->getNumber()) << '-' << *GetJTISymbol(uid) << '\n';
1568 void AsmPrinter::printVisibility(MCSymbol *Sym, unsigned Visibility) const {
1569 MCSymbolAttr Attr = MCSA_Invalid;
1571 switch (Visibility) {
1573 case GlobalValue::HiddenVisibility:
1574 Attr = MAI->getHiddenVisibilityAttr();
1576 case GlobalValue::ProtectedVisibility:
1577 Attr = MAI->getProtectedVisibilityAttr();
1581 if (Attr != MCSA_Invalid)
1582 OutStreamer.EmitSymbolAttribute(Sym, Attr);
1585 void AsmPrinter::printOffset(int64_t Offset) const {
1588 else if (Offset < 0)
1592 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1593 if (!S->usesMetadata())
1596 gcp_iterator GCPI = GCMetadataPrinters.find(S);
1597 if (GCPI != GCMetadataPrinters.end())
1598 return GCPI->second;
1600 const char *Name = S->getName().c_str();
1602 for (GCMetadataPrinterRegistry::iterator
1603 I = GCMetadataPrinterRegistry::begin(),
1604 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1605 if (strcmp(Name, I->getName()) == 0) {
1606 GCMetadataPrinter *GMP = I->instantiate();
1608 GCMetadataPrinters.insert(std::make_pair(S, GMP));
1612 llvm_report_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
1616 /// EmitComments - Pretty-print comments for instructions
1617 void AsmPrinter::EmitComments(const MachineInstr &MI) const {
1621 bool Newline = false;
1623 if (!MI.getDebugLoc().isUnknown()) {
1624 DILocation DLT = MF->getDILocation(MI.getDebugLoc());
1626 // Print source line info.
1627 O.PadToColumn(MAI->getCommentColumn());
1628 O << MAI->getCommentString() << ' ';
1629 DIScope Scope = DLT.getScope();
1630 // Omit the directory, because it's likely to be long and uninteresting.
1631 if (!Scope.isNull())
1632 O << Scope.getFilename();
1635 O << ':' << DLT.getLineNumber();
1636 if (DLT.getColumnNumber() != 0)
1637 O << ':' << DLT.getColumnNumber();
1641 // Check for spills and reloads
1644 const MachineFrameInfo *FrameInfo =
1645 MI.getParent()->getParent()->getFrameInfo();
1647 // We assume a single instruction only has a spill or reload, not
1649 const MachineMemOperand *MMO;
1650 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
1651 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1652 MMO = *MI.memoperands_begin();
1653 if (Newline) O << '\n';
1654 O.PadToColumn(MAI->getCommentColumn());
1655 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Reload";
1659 else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
1660 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1661 if (Newline) O << '\n';
1662 O.PadToColumn(MAI->getCommentColumn());
1663 O << MAI->getCommentString() << ' '
1664 << MMO->getSize() << "-byte Folded Reload";
1668 else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
1669 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1670 MMO = *MI.memoperands_begin();
1671 if (Newline) O << '\n';
1672 O.PadToColumn(MAI->getCommentColumn());
1673 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Spill";
1677 else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
1678 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1679 if (Newline) O << '\n';
1680 O.PadToColumn(MAI->getCommentColumn());
1681 O << MAI->getCommentString() << ' '
1682 << MMO->getSize() << "-byte Folded Spill";
1687 // Check for spill-induced copies
1688 unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1689 if (TM.getInstrInfo()->isMoveInstr(MI, SrcReg, DstReg,
1690 SrcSubIdx, DstSubIdx)) {
1691 if (MI.getAsmPrinterFlag(ReloadReuse)) {
1692 if (Newline) O << '\n';
1693 O.PadToColumn(MAI->getCommentColumn());
1694 O << MAI->getCommentString() << " Reload Reuse";