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();
288 /// EmitFunctionHeader - This method emits the header for the current
290 void AsmPrinter::EmitFunctionHeader() {
291 // Print out constants referenced by the function
292 EmitConstantPool(MF->getConstantPool());
294 // Print the 'header' of function.
295 unsigned FnAlign = MF->getAlignment();
296 const Function *F = MF->getFunction();
298 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang, TM));
299 EmitAlignment(FnAlign, F);
301 switch (F->getLinkage()) {
302 default: llvm_unreachable("Unknown linkage type!");
303 case Function::InternalLinkage: // Symbols default to internal.
304 case Function::PrivateLinkage:
306 case Function::DLLExportLinkage:
307 case Function::ExternalLinkage:
308 OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_Global);
310 case Function::LinkerPrivateLinkage:
311 case Function::LinkOnceAnyLinkage:
312 case Function::LinkOnceODRLinkage:
313 case Function::WeakAnyLinkage:
314 case Function::WeakODRLinkage:
315 if (MAI->getWeakDefDirective() != 0) {
316 OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_Global);
317 O << MAI->getWeakDefDirective() << *CurrentFnSym << '\n';
318 } else if (MAI->getLinkOnceDirective() != 0) {
319 OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_Global);
320 // FIXME: linkonce should be a section attribute, handled by COFF Section
322 // http://sourceware.org/binutils/docs-2.20/as/Linkonce.html#Linkonce
323 O << "\t.linkonce discard\n";
325 O << "\t.weak\t" << *CurrentFnSym << '\n';
330 printVisibility(CurrentFnSym, F->getVisibility());
332 if (MAI->hasDotTypeDotSizeDirective())
333 OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
335 O << *CurrentFnSym << ':';
337 O.PadToColumn(MAI->getCommentColumn());
338 O << MAI->getCommentString() << ' ';
339 WriteAsOperand(O, F, /*PrintType=*/false, F->getParent());
343 // Add some workaround for linkonce linkage on Cygwin\MinGW.
344 if (MAI->getLinkOnceDirective() != 0 &&
345 (F->hasLinkOnceLinkage() || F->hasWeakLinkage()))
346 O << "Lllvm$workaround$fake$stub$" << *CurrentFnSym << ":\n";
348 // Emit pre-function debug and/or EH information.
349 if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
350 DW->BeginFunction(MF);
356 bool AsmPrinter::doFinalization(Module &M) {
357 // Emit global variables.
358 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
360 EmitGlobalVariable(I);
362 // Emit final debug information.
363 if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
366 // If the target wants to know about weak references, print them all.
367 if (MAI->getWeakRefDirective()) {
368 // FIXME: This is not lazy, it would be nice to only print weak references
369 // to stuff that is actually used. Note that doing so would require targets
370 // to notice uses in operands (due to constant exprs etc). This should
371 // happen with the MC stuff eventually.
373 // Print out module-level global variables here.
374 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
376 if (!I->hasExternalWeakLinkage()) continue;
377 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
381 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
382 if (!I->hasExternalWeakLinkage()) continue;
383 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
388 if (MAI->hasSetDirective()) {
389 OutStreamer.AddBlankLine();
390 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
392 MCSymbol *Name = GetGlobalValueSymbol(I);
394 const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
395 MCSymbol *Target = GetGlobalValueSymbol(GV);
397 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
398 OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
399 else if (I->hasWeakLinkage())
400 OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
402 assert(I->hasLocalLinkage() && "Invalid alias linkage");
404 printVisibility(Name, I->getVisibility());
406 // Emit the directives as assignments aka .set:
407 OutStreamer.EmitAssignment(Name,
408 MCSymbolRefExpr::Create(Target, OutContext));
412 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
413 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
414 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
415 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
416 MP->finishAssembly(O, *this, *MAI);
418 // If we don't have any trampolines, then we don't require stack memory
419 // to be executable. Some targets have a directive to declare this.
420 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
421 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
422 if (MCSection *S = MAI->getNonexecutableStackSection(OutContext))
423 OutStreamer.SwitchSection(S);
425 // Allow the target to emit any magic that it wants at the end of the file,
426 // after everything else has gone out.
429 delete Mang; Mang = 0;
432 OutStreamer.Finish();
436 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
438 // Get the function symbol.
439 CurrentFnSym = GetGlobalValueSymbol(MF.getFunction());
442 LI = &getAnalysis<MachineLoopInfo>();
446 // SectionCPs - Keep track the alignment, constpool entries per Section.
450 SmallVector<unsigned, 4> CPEs;
451 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
455 /// EmitConstantPool - Print to the current output stream assembly
456 /// representations of the constants in the constant pool MCP. This is
457 /// used to print out constants which have been "spilled to memory" by
458 /// the code generator.
460 void AsmPrinter::EmitConstantPool(const MachineConstantPool *MCP) {
461 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
462 if (CP.empty()) return;
464 // Calculate sections for constant pool entries. We collect entries to go into
465 // the same section together to reduce amount of section switch statements.
466 SmallVector<SectionCPs, 4> CPSections;
467 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
468 const MachineConstantPoolEntry &CPE = CP[i];
469 unsigned Align = CPE.getAlignment();
472 switch (CPE.getRelocationInfo()) {
473 default: llvm_unreachable("Unknown section kind");
474 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
476 Kind = SectionKind::getReadOnlyWithRelLocal();
479 switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
480 case 4: Kind = SectionKind::getMergeableConst4(); break;
481 case 8: Kind = SectionKind::getMergeableConst8(); break;
482 case 16: Kind = SectionKind::getMergeableConst16();break;
483 default: Kind = SectionKind::getMergeableConst(); break;
487 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
489 // The number of sections are small, just do a linear search from the
490 // last section to the first.
492 unsigned SecIdx = CPSections.size();
493 while (SecIdx != 0) {
494 if (CPSections[--SecIdx].S == S) {
500 SecIdx = CPSections.size();
501 CPSections.push_back(SectionCPs(S, Align));
504 if (Align > CPSections[SecIdx].Alignment)
505 CPSections[SecIdx].Alignment = Align;
506 CPSections[SecIdx].CPEs.push_back(i);
509 // Now print stuff into the calculated sections.
510 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
511 OutStreamer.SwitchSection(CPSections[i].S);
512 EmitAlignment(Log2_32(CPSections[i].Alignment));
515 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
516 unsigned CPI = CPSections[i].CPEs[j];
517 MachineConstantPoolEntry CPE = CP[CPI];
519 // Emit inter-object padding for alignment.
520 unsigned AlignMask = CPE.getAlignment() - 1;
521 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
522 OutStreamer.EmitFill(NewOffset - Offset, 0/*fillval*/, 0/*addrspace*/);
524 const Type *Ty = CPE.getType();
525 Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
527 // Emit the label with a comment on it.
529 OutStreamer.GetCommentOS() << "constant pool ";
530 WriteTypeSymbolic(OutStreamer.GetCommentOS(), CPE.getType(),
531 MF->getFunction()->getParent());
532 OutStreamer.GetCommentOS() << '\n';
534 OutStreamer.EmitLabel(GetCPISymbol(CPI));
536 if (CPE.isMachineConstantPoolEntry())
537 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
539 EmitGlobalConstant(CPE.Val.ConstVal);
544 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
545 /// by the current function to the current output stream.
547 void AsmPrinter::EmitJumpTableInfo(MachineFunction &MF) {
548 MachineJumpTableInfo *MJTI = MF.getJumpTableInfo();
549 if (MJTI == 0) return;
550 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
551 if (JT.empty()) return;
553 // Pick the directive to use to print the jump table entries, and switch to
554 // the appropriate section.
555 const Function *F = MF.getFunction();
556 bool JTInDiffSection = false;
557 if (// In PIC mode, we need to emit the jump table to the same section as the
558 // function body itself, otherwise the label differences won't make sense.
559 // FIXME: Need a better predicate for this: what about custom entries?
560 MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
561 // We should also do if the section name is NULL or function is declared
562 // in discardable section
563 // FIXME: this isn't the right predicate, should be based on the MCSection
565 F->isWeakForLinker()) {
566 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang,
569 // Otherwise, drop it in the readonly section.
570 const MCSection *ReadOnlySection =
571 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
572 OutStreamer.SwitchSection(ReadOnlySection);
573 JTInDiffSection = true;
576 EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getTargetData())));
578 for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
579 const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
581 // If this jump table was deleted, ignore it.
582 if (JTBBs.empty()) continue;
584 // For the EK_LabelDifference32 entry, if the target supports .set, emit a
585 // .set directive for each unique entry. This reduces the number of
586 // relocations the assembler will generate for the jump table.
587 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
588 MAI->hasSetDirective()) {
589 SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
590 const TargetLowering *TLI = TM.getTargetLowering();
591 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(&MF, JTI,
593 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
594 const MachineBasicBlock *MBB = JTBBs[ii];
595 if (!EmittedSets.insert(MBB)) continue;
597 // .set LJTSet, LBB32-base
599 MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
600 OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
601 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
605 // On some targets (e.g. Darwin) we want to emit two consequtive labels
606 // before each jump table. The first label is never referenced, but tells
607 // the assembler and linker the extents of the jump table object. The
608 // second label is actually referenced by the code.
609 if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
610 // FIXME: This doesn't have to have any specific name, just any randomly
611 // named and numbered 'l' label would work. Simplify GetJTISymbol.
612 OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
614 OutStreamer.EmitLabel(GetJTISymbol(JTI));
616 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
617 EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
621 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
623 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
624 const MachineBasicBlock *MBB,
625 unsigned UID) const {
626 const MCExpr *Value = 0;
627 switch (MJTI->getEntryKind()) {
628 case MachineJumpTableInfo::EK_Custom32:
629 Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, UID,
632 case MachineJumpTableInfo::EK_BlockAddress:
633 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
635 Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
637 case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
638 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
639 // with a relocation as gp-relative, e.g.:
641 MCSymbol *MBBSym = MBB->getSymbol(OutContext);
642 OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
646 case MachineJumpTableInfo::EK_LabelDifference32: {
647 // EK_LabelDifference32 - Each entry is the address of the block minus
648 // the address of the jump table. This is used for PIC jump tables where
649 // gprel32 is not supported. e.g.:
650 // .word LBB123 - LJTI1_2
651 // If the .set directive is supported, this is emitted as:
652 // .set L4_5_set_123, LBB123 - LJTI1_2
653 // .word L4_5_set_123
655 // If we have emitted set directives for the jump table entries, print
656 // them rather than the entries themselves. If we're emitting PIC, then
657 // emit the table entries as differences between two text section labels.
658 if (MAI->hasSetDirective()) {
659 // If we used .set, reference the .set's symbol.
660 Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
664 // Otherwise, use the difference as the jump table entry.
665 Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
666 const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
667 Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
672 assert(Value && "Unknown entry kind!");
674 unsigned EntrySize = MJTI->getEntrySize(*TM.getTargetData());
675 OutStreamer.EmitValue(Value, EntrySize, /*addrspace*/0);
679 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
680 /// special global used by LLVM. If so, emit it and return true, otherwise
681 /// do nothing and return false.
682 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
683 if (GV->getName() == "llvm.used") {
684 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
685 EmitLLVMUsedList(GV->getInitializer());
689 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
690 if (GV->getSection() == "llvm.metadata" ||
691 GV->hasAvailableExternallyLinkage())
694 if (!GV->hasAppendingLinkage()) return false;
696 assert(GV->hasInitializer() && "Not a special LLVM global!");
698 const TargetData *TD = TM.getTargetData();
699 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
700 if (GV->getName() == "llvm.global_ctors") {
701 OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
702 EmitAlignment(Align, 0);
703 EmitXXStructorList(GV->getInitializer());
705 if (TM.getRelocationModel() == Reloc::Static &&
706 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
707 StringRef Sym(".constructors_used");
708 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
714 if (GV->getName() == "llvm.global_dtors") {
715 OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
716 EmitAlignment(Align, 0);
717 EmitXXStructorList(GV->getInitializer());
719 if (TM.getRelocationModel() == Reloc::Static &&
720 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
721 StringRef Sym(".destructors_used");
722 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
731 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
732 /// global in the specified llvm.used list for which emitUsedDirectiveFor
733 /// is true, as being used with this directive.
734 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
735 // Should be an array of 'i8*'.
736 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
737 if (InitList == 0) return;
739 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
740 const GlobalValue *GV =
741 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
742 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
743 OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(GV),
748 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
749 /// function pointers, ignoring the init priority.
750 void AsmPrinter::EmitXXStructorList(Constant *List) {
751 // Should be an array of '{ int, void ()* }' structs. The first value is the
752 // init priority, which we ignore.
753 if (!isa<ConstantArray>(List)) return;
754 ConstantArray *InitList = cast<ConstantArray>(List);
755 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
756 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
757 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
759 if (CS->getOperand(1)->isNullValue())
760 return; // Found a null terminator, exit printing.
761 // Emit the function pointer.
762 EmitGlobalConstant(CS->getOperand(1));
766 //===--------------------------------------------------------------------===//
767 // Emission and print routines
770 /// EmitInt8 - Emit a byte directive and value.
772 void AsmPrinter::EmitInt8(int Value) const {
773 OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
776 /// EmitInt16 - Emit a short directive and value.
778 void AsmPrinter::EmitInt16(int Value) const {
779 OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
782 /// EmitInt32 - Emit a long directive and value.
784 void AsmPrinter::EmitInt32(int Value) const {
785 OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
788 /// EmitInt64 - Emit a long long directive and value.
790 void AsmPrinter::EmitInt64(uint64_t Value) const {
791 OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
794 //===----------------------------------------------------------------------===//
796 // EmitAlignment - Emit an alignment directive to the specified power of
797 // two boundary. For example, if you pass in 3 here, you will get an 8
798 // byte alignment. If a global value is specified, and if that global has
799 // an explicit alignment requested, it will unconditionally override the
800 // alignment request. However, if ForcedAlignBits is specified, this value
801 // has final say: the ultimate alignment will be the max of ForcedAlignBits
802 // and the alignment computed with NumBits and the global.
806 // if (GV && GV->hasalignment) Align = GV->getalignment();
807 // Align = std::max(Align, ForcedAlignBits);
809 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
810 unsigned ForcedAlignBits,
811 bool UseFillExpr) const {
812 if (GV && GV->getAlignment())
813 NumBits = Log2_32(GV->getAlignment());
814 NumBits = std::max(NumBits, ForcedAlignBits);
816 if (NumBits == 0) return; // No need to emit alignment.
818 unsigned FillValue = 0;
819 if (getCurrentSection()->getKind().isText())
820 FillValue = MAI->getTextAlignFillValue();
822 OutStreamer.EmitValueToAlignment(1 << NumBits, FillValue, 1, 0);
825 /// LowerConstant - Lower the specified LLVM Constant to an MCExpr.
827 static const MCExpr *LowerConstant(const Constant *CV, AsmPrinter &AP) {
828 MCContext &Ctx = AP.OutContext;
830 if (CV->isNullValue() || isa<UndefValue>(CV))
831 return MCConstantExpr::Create(0, Ctx);
833 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
834 return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
836 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
837 return MCSymbolRefExpr::Create(AP.GetGlobalValueSymbol(GV), Ctx);
838 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
839 return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
841 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
843 llvm_unreachable("Unknown constant value to lower!");
844 return MCConstantExpr::Create(0, Ctx);
847 switch (CE->getOpcode()) {
848 case Instruction::ZExt:
849 case Instruction::SExt:
850 case Instruction::FPTrunc:
851 case Instruction::FPExt:
852 case Instruction::UIToFP:
853 case Instruction::SIToFP:
854 case Instruction::FPToUI:
855 case Instruction::FPToSI:
856 default: llvm_unreachable("FIXME: Don't support this constant cast expr");
857 case Instruction::GetElementPtr: {
858 const TargetData &TD = *AP.TM.getTargetData();
859 // Generate a symbolic expression for the byte address
860 const Constant *PtrVal = CE->getOperand(0);
861 SmallVector<Value*, 8> IdxVec(CE->op_begin()+1, CE->op_end());
862 int64_t Offset = TD.getIndexedOffset(PtrVal->getType(), &IdxVec[0],
865 const MCExpr *Base = LowerConstant(CE->getOperand(0), AP);
869 // Truncate/sext the offset to the pointer size.
870 if (TD.getPointerSizeInBits() != 64) {
871 int SExtAmount = 64-TD.getPointerSizeInBits();
872 Offset = (Offset << SExtAmount) >> SExtAmount;
875 return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
879 case Instruction::Trunc:
880 // We emit the value and depend on the assembler to truncate the generated
881 // expression properly. This is important for differences between
882 // blockaddress labels. Since the two labels are in the same function, it
883 // is reasonable to treat their delta as a 32-bit value.
885 case Instruction::BitCast:
886 return LowerConstant(CE->getOperand(0), AP);
888 case Instruction::IntToPtr: {
889 const TargetData &TD = *AP.TM.getTargetData();
890 // Handle casts to pointers by changing them into casts to the appropriate
891 // integer type. This promotes constant folding and simplifies this code.
892 Constant *Op = CE->getOperand(0);
893 Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
895 return LowerConstant(Op, AP);
898 case Instruction::PtrToInt: {
899 const TargetData &TD = *AP.TM.getTargetData();
900 // Support only foldable casts to/from pointers that can be eliminated by
901 // changing the pointer to the appropriately sized integer type.
902 Constant *Op = CE->getOperand(0);
903 const Type *Ty = CE->getType();
905 const MCExpr *OpExpr = LowerConstant(Op, AP);
907 // We can emit the pointer value into this slot if the slot is an
908 // integer slot equal to the size of the pointer.
909 if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
912 // Otherwise the pointer is smaller than the resultant integer, mask off
913 // the high bits so we are sure to get a proper truncation if the input is
915 unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
916 const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
917 return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
920 case Instruction::Add:
921 case Instruction::Sub:
922 case Instruction::And:
923 case Instruction::Or:
924 case Instruction::Xor: {
925 const MCExpr *LHS = LowerConstant(CE->getOperand(0), AP);
926 const MCExpr *RHS = LowerConstant(CE->getOperand(1), AP);
927 switch (CE->getOpcode()) {
928 default: llvm_unreachable("Unknown binary operator constant cast expr");
929 case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
930 case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
931 case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
932 case Instruction::Or: return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
933 case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
939 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
941 if (AddrSpace != 0 || !CA->isString()) {
942 // Not a string. Print the values in successive locations
943 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
944 AP.EmitGlobalConstant(CA->getOperand(i), AddrSpace);
948 // Otherwise, it can be emitted as .ascii.
949 SmallVector<char, 128> TmpVec;
950 TmpVec.reserve(CA->getNumOperands());
951 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
952 TmpVec.push_back(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
954 AP.OutStreamer.EmitBytes(StringRef(TmpVec.data(), TmpVec.size()), AddrSpace);
957 static void EmitGlobalConstantVector(const ConstantVector *CV,
958 unsigned AddrSpace, AsmPrinter &AP) {
959 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
960 AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
963 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
964 unsigned AddrSpace, AsmPrinter &AP) {
965 // Print the fields in successive locations. Pad to align if needed!
966 const TargetData *TD = AP.TM.getTargetData();
967 unsigned Size = TD->getTypeAllocSize(CS->getType());
968 const StructLayout *Layout = TD->getStructLayout(CS->getType());
969 uint64_t SizeSoFar = 0;
970 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
971 const Constant *Field = CS->getOperand(i);
973 // Check if padding is needed and insert one or more 0s.
974 uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
975 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
976 - Layout->getElementOffset(i)) - FieldSize;
977 SizeSoFar += FieldSize + PadSize;
979 // Now print the actual field value.
980 AP.EmitGlobalConstant(Field, AddrSpace);
982 // Insert padding - this may include padding to increase the size of the
983 // current field up to the ABI size (if the struct is not packed) as well
984 // as padding to ensure that the next field starts at the right offset.
985 AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
987 assert(SizeSoFar == Layout->getSizeInBytes() &&
988 "Layout of constant struct may be incorrect!");
991 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
993 // FP Constants are printed as integer constants to avoid losing
995 if (CFP->getType()->isDoubleTy()) {
997 double Val = CFP->getValueAPF().convertToDouble();
998 AP.OutStreamer.GetCommentOS() << "double " << Val << '\n';
1001 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1002 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1006 if (CFP->getType()->isFloatTy()) {
1007 if (AP.VerboseAsm) {
1008 float Val = CFP->getValueAPF().convertToFloat();
1009 AP.OutStreamer.GetCommentOS() << "float " << Val << '\n';
1011 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1012 AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
1016 if (CFP->getType()->isX86_FP80Ty()) {
1017 // all long double variants are printed as hex
1018 // api needed to prevent premature destruction
1019 APInt API = CFP->getValueAPF().bitcastToAPInt();
1020 const uint64_t *p = API.getRawData();
1021 if (AP.VerboseAsm) {
1022 // Convert to double so we can print the approximate val as a comment.
1023 APFloat DoubleVal = CFP->getValueAPF();
1025 DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1027 AP.OutStreamer.GetCommentOS() << "x86_fp80 ~= "
1028 << DoubleVal.convertToDouble() << '\n';
1031 if (AP.TM.getTargetData()->isBigEndian()) {
1032 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1033 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1035 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1036 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1039 // Emit the tail padding for the long double.
1040 const TargetData &TD = *AP.TM.getTargetData();
1041 AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
1042 TD.getTypeStoreSize(CFP->getType()), AddrSpace);
1046 assert(CFP->getType()->isPPC_FP128Ty() &&
1047 "Floating point constant type not handled");
1048 // All long double variants are printed as hex api needed to prevent
1049 // premature destruction.
1050 APInt API = CFP->getValueAPF().bitcastToAPInt();
1051 const uint64_t *p = API.getRawData();
1052 if (AP.TM.getTargetData()->isBigEndian()) {
1053 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1054 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1056 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1057 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1061 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
1062 unsigned AddrSpace, AsmPrinter &AP) {
1063 const TargetData *TD = AP.TM.getTargetData();
1064 unsigned BitWidth = CI->getBitWidth();
1065 assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
1067 // We don't expect assemblers to support integer data directives
1068 // for more than 64 bits, so we emit the data in at most 64-bit
1069 // quantities at a time.
1070 const uint64_t *RawData = CI->getValue().getRawData();
1071 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1072 uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1073 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1077 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1078 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1079 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
1080 uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1081 return OutStreamer.EmitZeros(Size, AddrSpace);
1084 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1085 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1092 OutStreamer.GetCommentOS() << format("0x%llx\n", CI->getZExtValue());
1093 OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1096 EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
1101 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1102 return EmitGlobalConstantArray(CVA, AddrSpace, *this);
1104 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1105 return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
1107 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1108 return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1110 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1111 return EmitGlobalConstantVector(V, AddrSpace, *this);
1113 if (isa<ConstantPointerNull>(CV)) {
1114 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1115 OutStreamer.EmitIntValue(0, Size, AddrSpace);
1119 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
1120 // thread the streamer with EmitValue.
1121 OutStreamer.EmitValue(LowerConstant(CV, *this),
1122 TM.getTargetData()->getTypeAllocSize(CV->getType()),
1126 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1127 // Target doesn't support this yet!
1128 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1131 /// PrintSpecial - Print information related to the specified machine instr
1132 /// that is independent of the operand, and may be independent of the instr
1133 /// itself. This can be useful for portably encoding the comment character
1134 /// or other bits of target-specific knowledge into the asmstrings. The
1135 /// syntax used is ${:comment}. Targets can override this to add support
1136 /// for their own strange codes.
1137 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1138 if (!strcmp(Code, "private")) {
1139 O << MAI->getPrivateGlobalPrefix();
1140 } else if (!strcmp(Code, "comment")) {
1142 O << MAI->getCommentString();
1143 } else if (!strcmp(Code, "uid")) {
1144 // Comparing the address of MI isn't sufficient, because machineinstrs may
1145 // be allocated to the same address across functions.
1146 const Function *ThisF = MI->getParent()->getParent()->getFunction();
1148 // If this is a new LastFn instruction, bump the counter.
1149 if (LastMI != MI || LastFn != ThisF) {
1157 raw_string_ostream Msg(msg);
1158 Msg << "Unknown special formatter '" << Code
1159 << "' for machine instr: " << *MI;
1160 llvm_report_error(Msg.str());
1164 /// processDebugLoc - Processes the debug information of each machine
1165 /// instruction's DebugLoc.
1166 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1167 bool BeforePrintingInsn) {
1168 if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1169 || !DW->ShouldEmitDwarfDebug())
1171 DebugLoc DL = MI->getDebugLoc();
1174 DILocation CurDLT = MF->getDILocation(DL);
1175 if (CurDLT.getScope().isNull())
1178 if (!BeforePrintingInsn) {
1179 // After printing instruction
1181 } else if (CurDLT.getNode() != PrevDLT) {
1182 unsigned L = DW->RecordSourceLine(CurDLT.getLineNumber(),
1183 CurDLT.getColumnNumber(),
1184 CurDLT.getScope().getNode());
1187 DW->BeginScope(MI, L);
1188 PrevDLT = CurDLT.getNode();
1193 /// printInlineAsm - This method formats and prints the specified machine
1194 /// instruction that is an inline asm.
1195 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1196 unsigned NumOperands = MI->getNumOperands();
1198 // Count the number of register definitions.
1199 unsigned NumDefs = 0;
1200 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1202 assert(NumDefs != NumOperands-1 && "No asm string?");
1204 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1206 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1207 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1211 // If this asmstr is empty, just print the #APP/#NOAPP markers.
1212 // These are useful to see where empty asm's wound up.
1213 if (AsmStr[0] == 0) {
1214 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1215 O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1219 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1221 // The variant of the current asmprinter.
1222 int AsmPrinterVariant = MAI->getAssemblerDialect();
1224 int CurVariant = -1; // The number of the {.|.|.} region we are in.
1225 const char *LastEmitted = AsmStr; // One past the last character emitted.
1227 while (*LastEmitted) {
1228 switch (*LastEmitted) {
1230 // Not a special case, emit the string section literally.
1231 const char *LiteralEnd = LastEmitted+1;
1232 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1233 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1235 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1236 O.write(LastEmitted, LiteralEnd-LastEmitted);
1237 LastEmitted = LiteralEnd;
1241 ++LastEmitted; // Consume newline character.
1242 O << '\n'; // Indent code with newline.
1245 ++LastEmitted; // Consume '$' character.
1249 switch (*LastEmitted) {
1250 default: Done = false; break;
1251 case '$': // $$ -> $
1252 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1254 ++LastEmitted; // Consume second '$' character.
1256 case '(': // $( -> same as GCC's { character.
1257 ++LastEmitted; // Consume '(' character.
1258 if (CurVariant != -1) {
1259 llvm_report_error("Nested variants found in inline asm string: '"
1260 + std::string(AsmStr) + "'");
1262 CurVariant = 0; // We're in the first variant now.
1265 ++LastEmitted; // consume '|' character.
1266 if (CurVariant == -1)
1267 O << '|'; // this is gcc's behavior for | outside a variant
1269 ++CurVariant; // We're in the next variant.
1271 case ')': // $) -> same as GCC's } char.
1272 ++LastEmitted; // consume ')' character.
1273 if (CurVariant == -1)
1274 O << '}'; // this is gcc's behavior for } outside a variant
1281 bool HasCurlyBraces = false;
1282 if (*LastEmitted == '{') { // ${variable}
1283 ++LastEmitted; // Consume '{' character.
1284 HasCurlyBraces = true;
1287 // If we have ${:foo}, then this is not a real operand reference, it is a
1288 // "magic" string reference, just like in .td files. Arrange to call
1290 if (HasCurlyBraces && *LastEmitted == ':') {
1292 const char *StrStart = LastEmitted;
1293 const char *StrEnd = strchr(StrStart, '}');
1295 llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1296 + std::string(AsmStr) + "'");
1299 std::string Val(StrStart, StrEnd);
1300 PrintSpecial(MI, Val.c_str());
1301 LastEmitted = StrEnd+1;
1305 const char *IDStart = LastEmitted;
1308 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1309 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1310 llvm_report_error("Bad $ operand number in inline asm string: '"
1311 + std::string(AsmStr) + "'");
1313 LastEmitted = IDEnd;
1315 char Modifier[2] = { 0, 0 };
1317 if (HasCurlyBraces) {
1318 // If we have curly braces, check for a modifier character. This
1319 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1320 if (*LastEmitted == ':') {
1321 ++LastEmitted; // Consume ':' character.
1322 if (*LastEmitted == 0) {
1323 llvm_report_error("Bad ${:} expression in inline asm string: '"
1324 + std::string(AsmStr) + "'");
1327 Modifier[0] = *LastEmitted;
1328 ++LastEmitted; // Consume modifier character.
1331 if (*LastEmitted != '}') {
1332 llvm_report_error("Bad ${} expression in inline asm string: '"
1333 + std::string(AsmStr) + "'");
1335 ++LastEmitted; // Consume '}' character.
1338 if ((unsigned)Val >= NumOperands-1) {
1339 llvm_report_error("Invalid $ operand number in inline asm string: '"
1340 + std::string(AsmStr) + "'");
1343 // Okay, we finally have a value number. Ask the target to print this
1345 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1350 // Scan to find the machine operand number for the operand.
1351 for (; Val; --Val) {
1352 if (OpNo >= MI->getNumOperands()) break;
1353 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1354 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1357 if (OpNo >= MI->getNumOperands()) {
1360 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1361 ++OpNo; // Skip over the ID number.
1363 if (Modifier[0] == 'l') // labels are target independent
1364 O << *MI->getOperand(OpNo).getMBB()->getSymbol(OutContext);
1366 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1367 if ((OpFlags & 7) == 4) {
1368 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1369 Modifier[0] ? Modifier : 0);
1371 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1372 Modifier[0] ? Modifier : 0);
1378 raw_string_ostream Msg(msg);
1379 Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1381 llvm_report_error(Msg.str());
1388 O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1391 /// printImplicitDef - This method prints the specified machine instruction
1392 /// that is an implicit def.
1393 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1394 if (!VerboseAsm) return;
1395 O.PadToColumn(MAI->getCommentColumn());
1396 O << MAI->getCommentString() << " implicit-def: "
1397 << TRI->getName(MI->getOperand(0).getReg());
1400 void AsmPrinter::printKill(const MachineInstr *MI) const {
1401 if (!VerboseAsm) return;
1402 O.PadToColumn(MAI->getCommentColumn());
1403 O << MAI->getCommentString() << " kill:";
1404 for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1405 const MachineOperand &op = MI->getOperand(n);
1406 assert(op.isReg() && "KILL instruction must have only register operands");
1407 O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1411 /// printLabel - This method prints a local label used by debug and
1412 /// exception handling tables.
1413 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1414 printLabel(MI->getOperand(0).getImm());
1417 void AsmPrinter::printLabel(unsigned Id) const {
1418 O << MAI->getPrivateGlobalPrefix() << "label" << Id << ':';
1421 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1422 /// instruction, using the specified assembler variant. Targets should
1423 /// override this to format as appropriate.
1424 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1425 unsigned AsmVariant, const char *ExtraCode) {
1426 // Target doesn't support this yet!
1430 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1431 unsigned AsmVariant,
1432 const char *ExtraCode) {
1433 // Target doesn't support this yet!
1437 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA,
1438 const char *Suffix) const {
1439 return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock(), Suffix);
1442 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1443 const BasicBlock *BB,
1444 const char *Suffix) const {
1445 assert(BB->hasName() &&
1446 "Address of anonymous basic block not supported yet!");
1448 // This code must use the function name itself, and not the function number,
1449 // since it must be possible to generate the label name from within other
1451 SmallString<60> FnName;
1452 Mang->getNameWithPrefix(FnName, F, false);
1454 // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1455 SmallString<60> NameResult;
1456 Mang->getNameWithPrefix(NameResult,
1457 StringRef("BA") + Twine((unsigned)FnName.size()) +
1458 "_" + FnName.str() + "_" + BB->getName() + Suffix,
1461 return OutContext.GetOrCreateSymbol(NameResult.str());
1464 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1465 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1466 SmallString<60> Name;
1467 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "CPI"
1468 << getFunctionNumber() << '_' << CPID;
1469 return OutContext.GetOrCreateSymbol(Name.str());
1472 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1473 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1474 return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
1477 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
1478 /// FIXME: privatize to AsmPrinter.
1479 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
1480 SmallString<60> Name;
1481 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix()
1482 << getFunctionNumber() << '_' << UID << "_set_" << MBBID;
1483 return OutContext.GetOrCreateSymbol(Name.str());
1486 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
1488 MCSymbol *AsmPrinter::GetGlobalValueSymbol(const GlobalValue *GV) const {
1489 SmallString<60> NameStr;
1490 Mang->getNameWithPrefix(NameStr, GV, false);
1491 return OutContext.GetOrCreateSymbol(NameStr.str());
1494 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1495 /// global value name as its base, with the specified suffix, and where the
1496 /// symbol is forced to have private linkage if ForcePrivate is true.
1497 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1499 bool ForcePrivate) const {
1500 SmallString<60> NameStr;
1501 Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1502 NameStr.append(Suffix.begin(), Suffix.end());
1503 return OutContext.GetOrCreateSymbol(NameStr.str());
1506 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1508 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1509 SmallString<60> NameStr;
1510 Mang->getNameWithPrefix(NameStr, Sym);
1511 return OutContext.GetOrCreateSymbol(NameStr.str());
1516 /// PrintParentLoopComment - Print comments about parent loops of this one.
1517 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1518 unsigned FunctionNumber) {
1519 if (Loop == 0) return;
1520 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
1521 OS.indent(Loop->getLoopDepth()*2)
1522 << "Parent Loop BB" << FunctionNumber << "_"
1523 << Loop->getHeader()->getNumber()
1524 << " Depth=" << Loop->getLoopDepth() << '\n';
1528 /// PrintChildLoopComment - Print comments about child loops within
1529 /// the loop for this basic block, with nesting.
1530 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1531 unsigned FunctionNumber) {
1532 // Add child loop information
1533 for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
1534 OS.indent((*CL)->getLoopDepth()*2)
1535 << "Child Loop BB" << FunctionNumber << "_"
1536 << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
1538 PrintChildLoopComment(OS, *CL, FunctionNumber);
1542 /// EmitComments - Pretty-print comments for basic blocks.
1543 static void PrintBasicBlockLoopComments(const MachineBasicBlock &MBB,
1544 const MachineLoopInfo *LI,
1545 const AsmPrinter &AP) {
1546 // Add loop depth information
1547 const MachineLoop *Loop = LI->getLoopFor(&MBB);
1548 if (Loop == 0) return;
1550 MachineBasicBlock *Header = Loop->getHeader();
1551 assert(Header && "No header for loop");
1553 // If this block is not a loop header, just print out what is the loop header
1555 if (Header != &MBB) {
1556 AP.OutStreamer.AddComment(" in Loop: Header=BB" +
1557 Twine(AP.getFunctionNumber())+"_" +
1558 Twine(Loop->getHeader()->getNumber())+
1559 " Depth="+Twine(Loop->getLoopDepth()));
1563 // Otherwise, it is a loop header. Print out information about child and
1565 raw_ostream &OS = AP.OutStreamer.GetCommentOS();
1567 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
1570 OS.indent(Loop->getLoopDepth()*2-2);
1575 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
1577 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
1581 /// EmitBasicBlockStart - This method prints the label for the specified
1582 /// MachineBasicBlock, an alignment (if present) and a comment describing
1583 /// it if appropriate.
1584 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1585 // Emit an alignment directive for this block, if needed.
1586 if (unsigned Align = MBB->getAlignment())
1587 EmitAlignment(Log2_32(Align));
1589 // If the block has its address taken, emit a special label to satisfy
1590 // references to the block. This is done so that we don't need to
1591 // remember the number of this label, and so that we can make
1592 // forward references to labels without knowing what their numbers
1594 if (MBB->hasAddressTaken()) {
1595 const BasicBlock *BB = MBB->getBasicBlock();
1597 OutStreamer.AddComment("Address Taken");
1598 OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1601 // Print the main label for the block.
1602 if (MBB->pred_empty() || MBB->isOnlyReachableByFallthrough()) {
1604 // NOTE: Want this comment at start of line.
1605 O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1606 if (const BasicBlock *BB = MBB->getBasicBlock())
1608 OutStreamer.AddComment("%" + BB->getName());
1610 PrintBasicBlockLoopComments(*MBB, LI, *this);
1611 OutStreamer.AddBlankLine();
1615 if (const BasicBlock *BB = MBB->getBasicBlock())
1617 OutStreamer.AddComment("%" + BB->getName());
1618 PrintBasicBlockLoopComments(*MBB, LI, *this);
1621 OutStreamer.EmitLabel(MBB->getSymbol(OutContext));
1625 void AsmPrinter::printVisibility(MCSymbol *Sym, unsigned Visibility) const {
1626 // FIXME: RENAME TO EmitVisibility.
1627 MCSymbolAttr Attr = MCSA_Invalid;
1629 switch (Visibility) {
1631 case GlobalValue::HiddenVisibility:
1632 Attr = MAI->getHiddenVisibilityAttr();
1634 case GlobalValue::ProtectedVisibility:
1635 Attr = MAI->getProtectedVisibilityAttr();
1639 if (Attr != MCSA_Invalid)
1640 OutStreamer.EmitSymbolAttribute(Sym, Attr);
1643 void AsmPrinter::printOffset(int64_t Offset) const {
1646 else if (Offset < 0)
1650 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1651 if (!S->usesMetadata())
1654 gcp_iterator GCPI = GCMetadataPrinters.find(S);
1655 if (GCPI != GCMetadataPrinters.end())
1656 return GCPI->second;
1658 const char *Name = S->getName().c_str();
1660 for (GCMetadataPrinterRegistry::iterator
1661 I = GCMetadataPrinterRegistry::begin(),
1662 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1663 if (strcmp(Name, I->getName()) == 0) {
1664 GCMetadataPrinter *GMP = I->instantiate();
1666 GCMetadataPrinters.insert(std::make_pair(S, GMP));
1670 llvm_report_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
1674 /// EmitComments - Pretty-print comments for instructions
1675 void AsmPrinter::EmitComments(const MachineInstr &MI) const {
1679 bool Newline = false;
1681 if (!MI.getDebugLoc().isUnknown()) {
1682 DILocation DLT = MF->getDILocation(MI.getDebugLoc());
1684 // Print source line info.
1685 O.PadToColumn(MAI->getCommentColumn());
1686 O << MAI->getCommentString() << ' ';
1687 DIScope Scope = DLT.getScope();
1688 // Omit the directory, because it's likely to be long and uninteresting.
1689 if (!Scope.isNull())
1690 O << Scope.getFilename();
1693 O << ':' << DLT.getLineNumber();
1694 if (DLT.getColumnNumber() != 0)
1695 O << ':' << DLT.getColumnNumber();
1699 // Check for spills and reloads
1702 const MachineFrameInfo *FrameInfo =
1703 MI.getParent()->getParent()->getFrameInfo();
1705 // We assume a single instruction only has a spill or reload, not
1707 const MachineMemOperand *MMO;
1708 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
1709 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1710 MMO = *MI.memoperands_begin();
1711 if (Newline) O << '\n';
1712 O.PadToColumn(MAI->getCommentColumn());
1713 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Reload";
1717 else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
1718 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1719 if (Newline) O << '\n';
1720 O.PadToColumn(MAI->getCommentColumn());
1721 O << MAI->getCommentString() << ' '
1722 << MMO->getSize() << "-byte Folded Reload";
1726 else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
1727 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1728 MMO = *MI.memoperands_begin();
1729 if (Newline) O << '\n';
1730 O.PadToColumn(MAI->getCommentColumn());
1731 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Spill";
1735 else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
1736 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1737 if (Newline) O << '\n';
1738 O.PadToColumn(MAI->getCommentColumn());
1739 O << MAI->getCommentString() << ' '
1740 << MMO->getSize() << "-byte Folded Spill";
1745 // Check for spill-induced copies
1746 unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1747 if (TM.getInstrInfo()->isMoveInstr(MI, SrcReg, DstReg,
1748 SrcSubIdx, DstSubIdx)) {
1749 if (MI.getAsmPrinterFlag(ReloadReuse)) {
1750 if (Newline) O << '\n';
1751 O.PadToColumn(MAI->getCommentColumn());
1752 O << MAI->getCommentString() << " Reload Reuse";