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/MCInst.h"
30 #include "llvm/MC/MCSection.h"
31 #include "llvm/MC/MCStreamer.h"
32 #include "llvm/MC/MCSymbol.h"
33 #include "llvm/Support/CommandLine.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/FormattedStream.h"
36 #include "llvm/MC/MCAsmInfo.h"
37 #include "llvm/Target/Mangler.h"
38 #include "llvm/Target/TargetData.h"
39 #include "llvm/Target/TargetInstrInfo.h"
40 #include "llvm/Target/TargetLowering.h"
41 #include "llvm/Target/TargetLoweringObjectFile.h"
42 #include "llvm/Target/TargetOptions.h"
43 #include "llvm/Target/TargetRegisterInfo.h"
44 #include "llvm/ADT/SmallPtrSet.h"
45 #include "llvm/ADT/SmallString.h"
49 static cl::opt<cl::boolOrDefault>
50 AsmVerbose("asm-verbose", cl::desc("Add comments to directives."),
51 cl::init(cl::BOU_UNSET));
53 char AsmPrinter::ID = 0;
54 AsmPrinter::AsmPrinter(formatted_raw_ostream &o, TargetMachine &tm,
55 const MCAsmInfo *T, bool VDef)
56 : MachineFunctionPass(&ID), FunctionNumber(0), O(o),
57 TM(tm), MAI(T), TRI(tm.getRegisterInfo()),
59 OutContext(*new MCContext()),
60 // FIXME: Pass instprinter to streamer.
61 OutStreamer(*createAsmStreamer(OutContext, O, *T,
62 TM.getTargetData()->isLittleEndian(), 0)),
64 LastMI(0), LastFn(0), Counter(~0U), PrevDLT(NULL) {
67 case cl::BOU_UNSET: VerboseAsm = VDef; break;
68 case cl::BOU_TRUE: VerboseAsm = true; break;
69 case cl::BOU_FALSE: VerboseAsm = false; break;
73 AsmPrinter::~AsmPrinter() {
74 for (gcp_iterator I = GCMetadataPrinters.begin(),
75 E = GCMetadataPrinters.end(); I != E; ++I)
82 TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
83 return TM.getTargetLowering()->getObjFileLowering();
86 /// getCurrentSection() - Return the current section we are emitting to.
87 const MCSection *AsmPrinter::getCurrentSection() const {
88 return OutStreamer.getCurrentSection();
92 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
94 MachineFunctionPass::getAnalysisUsage(AU);
95 AU.addRequired<GCModuleInfo>();
97 AU.addRequired<MachineLoopInfo>();
100 bool AsmPrinter::doInitialization(Module &M) {
101 // Initialize TargetLoweringObjectFile.
102 const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
103 .Initialize(OutContext, TM);
105 Mang = new Mangler(*MAI);
107 // Allow the target to emit any magic that it wants at the start of the file.
108 EmitStartOfAsmFile(M);
110 if (MAI->hasSingleParameterDotFile()) {
111 /* Very minimal debug info. It is ignored if we emit actual
112 debug info. If we don't, this at least helps the user find where
113 a function came from. */
114 O << "\t.file\t\"" << M.getModuleIdentifier() << "\"\n";
117 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
118 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
119 for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
120 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
121 MP->beginAssembly(O, *this, *MAI);
123 if (!M.getModuleInlineAsm().empty())
124 O << MAI->getCommentString() << " Start of file scope inline assembly\n"
125 << M.getModuleInlineAsm()
126 << '\n' << MAI->getCommentString()
127 << " End of file scope inline assembly\n";
129 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
131 MMI->AnalyzeModule(M);
132 DW = getAnalysisIfAvailable<DwarfWriter>();
134 DW->BeginModule(&M, MMI, O, this, MAI);
139 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
140 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
141 if (!GV->hasInitializer()) // External globals require no code.
144 // Check to see if this is a special global used by LLVM, if so, emit it.
145 if (EmitSpecialLLVMGlobal(GV))
148 MCSymbol *GVSym = GetGlobalValueSymbol(GV);
149 printVisibility(GVSym, GV->getVisibility());
151 if (MAI->hasDotTypeDotSizeDirective()) {
152 O << "\t.type\t" << *GVSym;
153 if (MAI->getCommentString()[0] != '@')
159 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
161 const TargetData *TD = TM.getTargetData();
162 unsigned Size = TD->getTypeAllocSize(GV->getType()->getElementType());
163 unsigned AlignLog = TD->getPreferredAlignmentLog(GV);
165 // Handle common and BSS local symbols (.lcomm).
166 if (GVKind.isCommon() || GVKind.isBSSLocal()) {
167 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
170 O.PadToColumn(MAI->getCommentColumn());
171 O << MAI->getCommentString() << ' ';
172 WriteAsOperand(O, GV, /*PrintType=*/false, GV->getParent());
176 // Handle common symbols.
177 if (GVKind.isCommon()) {
179 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
183 // Handle local BSS symbols.
184 if (MAI->hasMachoZeroFillDirective()) {
185 const MCSection *TheSection =
186 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
187 // .zerofill __DATA, __bss, _foo, 400, 5
188 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
192 if (const char *LComm = MAI->getLCOMMDirective()) {
194 O << LComm << *GVSym << ',' << Size;
200 O << "\t.local\t" << *GVSym << '\n';
202 OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
206 const MCSection *TheSection =
207 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
209 // Handle the zerofill directive on darwin, which is a special form of BSS
211 if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
213 OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
214 // .zerofill __DATA, __common, _foo, 400, 5
215 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
219 OutStreamer.SwitchSection(TheSection);
221 // TODO: Factor into an 'emit linkage' thing that is shared with function
223 switch (GV->getLinkage()) {
224 case GlobalValue::CommonLinkage:
225 case GlobalValue::LinkOnceAnyLinkage:
226 case GlobalValue::LinkOnceODRLinkage:
227 case GlobalValue::WeakAnyLinkage:
228 case GlobalValue::WeakODRLinkage:
229 case GlobalValue::LinkerPrivateLinkage:
230 if (MAI->getWeakDefDirective() != 0) {
232 OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
233 // .weak_definition _foo
234 OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::WeakDefinition);
235 } else if (const char *LinkOnce = MAI->getLinkOnceDirective()) {
237 OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
238 // .linkonce same_size
242 OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Weak);
245 case GlobalValue::DLLExportLinkage:
246 case GlobalValue::AppendingLinkage:
247 // FIXME: appending linkage variables should go into a section of
248 // their name or something. For now, just emit them as external.
249 case GlobalValue::ExternalLinkage:
250 // If external or appending, declare as a global symbol.
252 OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
254 case GlobalValue::PrivateLinkage:
255 case GlobalValue::InternalLinkage:
258 llvm_unreachable("Unknown linkage type!");
261 EmitAlignment(AlignLog, GV);
263 O.PadToColumn(MAI->getCommentColumn());
264 O << MAI->getCommentString() << ' ';
265 WriteAsOperand(O, GV, /*PrintType=*/false, GV->getParent());
268 OutStreamer.EmitLabel(GVSym);
270 EmitGlobalConstant(GV->getInitializer());
272 if (MAI->hasDotTypeDotSizeDirective())
273 O << "\t.size\t" << *GVSym << ", " << Size << '\n';
277 bool AsmPrinter::doFinalization(Module &M) {
278 // Emit global variables.
279 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
281 EmitGlobalVariable(I);
283 // Emit final debug information.
284 if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
287 // If the target wants to know about weak references, print them all.
288 if (MAI->getWeakRefDirective()) {
289 // FIXME: This is not lazy, it would be nice to only print weak references
290 // to stuff that is actually used. Note that doing so would require targets
291 // to notice uses in operands (due to constant exprs etc). This should
292 // happen with the MC stuff eventually.
294 // Print out module-level global variables here.
295 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
297 if (!I->hasExternalWeakLinkage()) continue;
298 O << MAI->getWeakRefDirective() << *GetGlobalValueSymbol(I) << '\n';
301 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
302 if (!I->hasExternalWeakLinkage()) continue;
303 O << MAI->getWeakRefDirective() << *GetGlobalValueSymbol(I) << '\n';
307 if (MAI->getSetDirective()) {
309 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
311 MCSymbol *Name = GetGlobalValueSymbol(I);
313 const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
314 MCSymbol *Target = GetGlobalValueSymbol(GV);
316 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
317 O << "\t.globl\t" << *Name << '\n';
318 else if (I->hasWeakLinkage())
319 O << MAI->getWeakRefDirective() << *Name << '\n';
321 assert(I->hasLocalLinkage() && "Invalid alias linkage");
323 printVisibility(Name, I->getVisibility());
325 O << MAI->getSetDirective() << ' ' << *Name << ", " << *Target << '\n';
329 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
330 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
331 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
332 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
333 MP->finishAssembly(O, *this, *MAI);
335 // If we don't have any trampolines, then we don't require stack memory
336 // to be executable. Some targets have a directive to declare this.
337 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
338 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
339 if (MAI->getNonexecutableStackDirective())
340 O << MAI->getNonexecutableStackDirective() << '\n';
343 // Allow the target to emit any magic that it wants at the end of the file,
344 // after everything else has gone out.
347 delete Mang; Mang = 0;
350 OutStreamer.Finish();
354 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
355 // Get the function symbol.
356 CurrentFnSym = GetGlobalValueSymbol(MF.getFunction());
357 IncrementFunctionNumber();
360 LI = &getAnalysis<MachineLoopInfo>();
364 // SectionCPs - Keep track the alignment, constpool entries per Section.
368 SmallVector<unsigned, 4> CPEs;
369 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
373 /// EmitConstantPool - Print to the current output stream assembly
374 /// representations of the constants in the constant pool MCP. This is
375 /// used to print out constants which have been "spilled to memory" by
376 /// the code generator.
378 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
379 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
380 if (CP.empty()) return;
382 // Calculate sections for constant pool entries. We collect entries to go into
383 // the same section together to reduce amount of section switch statements.
384 SmallVector<SectionCPs, 4> CPSections;
385 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
386 const MachineConstantPoolEntry &CPE = CP[i];
387 unsigned Align = CPE.getAlignment();
390 switch (CPE.getRelocationInfo()) {
391 default: llvm_unreachable("Unknown section kind");
392 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
394 Kind = SectionKind::getReadOnlyWithRelLocal();
397 switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
398 case 4: Kind = SectionKind::getMergeableConst4(); break;
399 case 8: Kind = SectionKind::getMergeableConst8(); break;
400 case 16: Kind = SectionKind::getMergeableConst16();break;
401 default: Kind = SectionKind::getMergeableConst(); break;
405 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
407 // The number of sections are small, just do a linear search from the
408 // last section to the first.
410 unsigned SecIdx = CPSections.size();
411 while (SecIdx != 0) {
412 if (CPSections[--SecIdx].S == S) {
418 SecIdx = CPSections.size();
419 CPSections.push_back(SectionCPs(S, Align));
422 if (Align > CPSections[SecIdx].Alignment)
423 CPSections[SecIdx].Alignment = Align;
424 CPSections[SecIdx].CPEs.push_back(i);
427 // Now print stuff into the calculated sections.
428 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
429 OutStreamer.SwitchSection(CPSections[i].S);
430 EmitAlignment(Log2_32(CPSections[i].Alignment));
433 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
434 unsigned CPI = CPSections[i].CPEs[j];
435 MachineConstantPoolEntry CPE = CP[CPI];
437 // Emit inter-object padding for alignment.
438 unsigned AlignMask = CPE.getAlignment() - 1;
439 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
440 OutStreamer.EmitFill(NewOffset - Offset, 0/*fillval*/, 0/*addrspace*/);
442 const Type *Ty = CPE.getType();
443 Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
445 O << MAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << '_'
448 O.PadToColumn(MAI->getCommentColumn());
449 O << MAI->getCommentString() << " constant ";
450 WriteTypeSymbolic(O, CPE.getType(), MF->getFunction()->getParent());
453 if (CPE.isMachineConstantPoolEntry())
454 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
456 EmitGlobalConstant(CPE.Val.ConstVal);
461 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
462 /// by the current function to the current output stream.
464 void AsmPrinter::EmitJumpTableInfo(MachineJumpTableInfo *MJTI,
465 MachineFunction &MF) {
466 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
467 if (JT.empty()) return;
469 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
471 // Pick the directive to use to print the jump table entries, and switch to
472 // the appropriate section.
473 TargetLowering *LoweringInfo = TM.getTargetLowering();
475 const Function *F = MF.getFunction();
476 bool JTInDiffSection = false;
477 if (F->isWeakForLinker() ||
478 (IsPic && !LoweringInfo->usesGlobalOffsetTable())) {
479 // In PIC mode, we need to emit the jump table to the same section as the
480 // function body itself, otherwise the label differences won't make sense.
481 // We should also do if the section name is NULL or function is declared in
482 // discardable section.
483 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang,
486 // Otherwise, drop it in the readonly section.
487 const MCSection *ReadOnlySection =
488 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
489 OutStreamer.SwitchSection(ReadOnlySection);
490 JTInDiffSection = true;
493 EmitAlignment(Log2_32(MJTI->getAlignment()));
495 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
496 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
498 // If this jump table was deleted, ignore it.
499 if (JTBBs.empty()) continue;
501 // For PIC codegen, if possible we want to use the SetDirective to reduce
502 // the number of relocations the assembler will generate for the jump table.
503 // Set directives are all printed before the jump table itself.
504 SmallPtrSet<MachineBasicBlock*, 16> EmittedSets;
505 if (MAI->getSetDirective() && IsPic)
506 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
507 if (EmittedSets.insert(JTBBs[ii]))
508 printPICJumpTableSetLabel(i, JTBBs[ii]);
510 // On some targets (e.g. Darwin) we want to emit two consequtive labels
511 // before each jump table. The first label is never referenced, but tells
512 // the assembler and linker the extents of the jump table object. The
513 // second label is actually referenced by the code.
514 if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0]) {
515 O << MAI->getLinkerPrivateGlobalPrefix()
516 << "JTI" << getFunctionNumber() << '_' << i << ":\n";
519 O << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
520 << '_' << i << ":\n";
522 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
523 printPICJumpTableEntry(MJTI, JTBBs[ii], i);
529 void AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
530 const MachineBasicBlock *MBB,
531 unsigned uid) const {
532 bool isPIC = TM.getRelocationModel() == Reloc::PIC_;
534 // Use JumpTableDirective otherwise honor the entry size from the jump table
536 const char *JTEntryDirective = MAI->getJumpTableDirective(isPIC);
537 bool HadJTEntryDirective = JTEntryDirective != NULL;
538 if (!HadJTEntryDirective) {
539 JTEntryDirective = MJTI->getEntrySize() == 4 ?
540 MAI->getData32bitsDirective() : MAI->getData64bitsDirective();
543 O << JTEntryDirective << ' ';
545 // If we have emitted set directives for the jump table entries, print
546 // them rather than the entries themselves. If we're emitting PIC, then
547 // emit the table entries as differences between two text section labels.
548 // If we're emitting non-PIC code, then emit the entries as direct
549 // references to the target basic blocks.
551 O << *GetMBBSymbol(MBB->getNumber());
552 } else if (MAI->getSetDirective()) {
553 O << MAI->getPrivateGlobalPrefix() << getFunctionNumber()
554 << '_' << uid << "_set_" << MBB->getNumber();
556 O << *GetMBBSymbol(MBB->getNumber());
557 // If the arch uses custom Jump Table directives, don't calc relative to
559 if (!HadJTEntryDirective)
560 O << '-' << MAI->getPrivateGlobalPrefix() << "JTI"
561 << getFunctionNumber() << '_' << uid;
566 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
567 /// special global used by LLVM. If so, emit it and return true, otherwise
568 /// do nothing and return false.
569 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
570 if (GV->getName() == "llvm.used") {
571 if (MAI->getUsedDirective() != 0) // No need to emit this at all.
572 EmitLLVMUsedList(GV->getInitializer());
576 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
577 if (GV->getSection() == "llvm.metadata" ||
578 GV->hasAvailableExternallyLinkage())
581 if (!GV->hasAppendingLinkage()) return false;
583 assert(GV->hasInitializer() && "Not a special LLVM global!");
585 const TargetData *TD = TM.getTargetData();
586 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
587 if (GV->getName() == "llvm.global_ctors") {
588 OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
589 EmitAlignment(Align, 0);
590 EmitXXStructorList(GV->getInitializer());
592 if (TM.getRelocationModel() == Reloc::Static &&
593 MAI->hasStaticCtorDtorReferenceInStaticMode())
594 O << ".reference .constructors_used\n";
598 if (GV->getName() == "llvm.global_dtors") {
599 OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
600 EmitAlignment(Align, 0);
601 EmitXXStructorList(GV->getInitializer());
603 if (TM.getRelocationModel() == Reloc::Static &&
604 MAI->hasStaticCtorDtorReferenceInStaticMode())
605 O << ".reference .destructors_used\n";
612 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
613 /// global in the specified llvm.used list for which emitUsedDirectiveFor
614 /// is true, as being used with this directive.
615 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
616 const char *Directive = MAI->getUsedDirective();
618 // Should be an array of 'i8*'.
619 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
620 if (InitList == 0) return;
622 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
623 const GlobalValue *GV =
624 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
625 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang)) {
627 EmitConstantValueOnly(InitList->getOperand(i));
633 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
634 /// function pointers, ignoring the init priority.
635 void AsmPrinter::EmitXXStructorList(Constant *List) {
636 // Should be an array of '{ int, void ()* }' structs. The first value is the
637 // init priority, which we ignore.
638 if (!isa<ConstantArray>(List)) return;
639 ConstantArray *InitList = cast<ConstantArray>(List);
640 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
641 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
642 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
644 if (CS->getOperand(1)->isNullValue())
645 return; // Found a null terminator, exit printing.
646 // Emit the function pointer.
647 EmitGlobalConstant(CS->getOperand(1));
652 //===----------------------------------------------------------------------===//
653 /// LEB 128 number encoding.
655 /// PrintULEB128 - Print a series of hexadecimal values (separated by commas)
656 /// representing an unsigned leb128 value.
657 void AsmPrinter::PrintULEB128(unsigned Value) const {
659 unsigned char Byte = static_cast<unsigned char>(Value & 0x7f);
661 if (Value) Byte |= 0x80;
663 if (Value) O << ", ";
667 /// PrintSLEB128 - Print a series of hexadecimal values (separated by commas)
668 /// representing a signed leb128 value.
669 void AsmPrinter::PrintSLEB128(int Value) const {
670 int Sign = Value >> (8 * sizeof(Value) - 1);
674 unsigned char Byte = static_cast<unsigned char>(Value & 0x7f);
676 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
677 if (IsMore) Byte |= 0x80;
679 if (IsMore) O << ", ";
683 //===--------------------------------------------------------------------===//
684 // Emission and print routines
687 /// PrintHex - Print a value as a hexadecimal value.
689 void AsmPrinter::PrintHex(uint64_t Value) const {
694 /// EOL - Print a newline character to asm stream. If a comment is present
695 /// then it will be printed first. Comments should not contain '\n'.
696 void AsmPrinter::EOL() const {
700 void AsmPrinter::EOL(const Twine &Comment) const {
701 if (VerboseAsm && !Comment.isTriviallyEmpty()) {
702 O.PadToColumn(MAI->getCommentColumn());
703 O << MAI->getCommentString() << ' ' << Comment;
708 static const char *DecodeDWARFEncoding(unsigned Encoding) {
710 case dwarf::DW_EH_PE_absptr:
712 case dwarf::DW_EH_PE_omit:
714 case dwarf::DW_EH_PE_pcrel:
716 case dwarf::DW_EH_PE_udata4:
718 case dwarf::DW_EH_PE_udata8:
720 case dwarf::DW_EH_PE_sdata4:
722 case dwarf::DW_EH_PE_sdata8:
724 case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata4:
725 return "pcrel udata4";
726 case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4:
727 return "pcrel sdata4";
728 case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata8:
729 return "pcrel udata8";
730 case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata8:
731 return "pcrel sdata8";
732 case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_udata4:
733 return "indirect pcrel udata4";
734 case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_sdata4:
735 return "indirect pcrel sdata4";
736 case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_udata8:
737 return "indirect pcrel udata8";
738 case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_sdata8:
739 return "indirect pcrel sdata8";
745 void AsmPrinter::EOL(const Twine &Comment, unsigned Encoding) const {
746 if (VerboseAsm && !Comment.isTriviallyEmpty()) {
747 O.PadToColumn(MAI->getCommentColumn());
748 O << MAI->getCommentString()
752 if (const char *EncStr = DecodeDWARFEncoding(Encoding))
753 O << " (" << EncStr << ')';
758 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
759 /// unsigned leb128 value.
760 void AsmPrinter::EmitULEB128Bytes(unsigned Value) const {
761 if (MAI->hasLEB128()) {
765 O << MAI->getData8bitsDirective();
770 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
771 /// signed leb128 value.
772 void AsmPrinter::EmitSLEB128Bytes(int Value) const {
773 if (MAI->hasLEB128()) {
777 O << MAI->getData8bitsDirective();
782 /// EmitInt8 - Emit a byte directive and value.
784 void AsmPrinter::EmitInt8(int Value) const {
785 OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
788 /// EmitInt16 - Emit a short directive and value.
790 void AsmPrinter::EmitInt16(int Value) const {
791 OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
794 /// EmitInt32 - Emit a long directive and value.
796 void AsmPrinter::EmitInt32(int Value) const {
797 OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
800 /// EmitInt64 - Emit a long long directive and value.
802 void AsmPrinter::EmitInt64(uint64_t Value) const {
803 OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
806 /// toOctal - Convert the low order bits of X into an octal digit.
808 static inline char toOctal(int X) {
812 /// printStringChar - Print a char, escaped if necessary.
814 static void printStringChar(formatted_raw_ostream &O, unsigned char C) {
817 } else if (C == '\\') {
819 } else if (isprint((unsigned char)C)) {
823 case '\b': O << "\\b"; break;
824 case '\f': O << "\\f"; break;
825 case '\n': O << "\\n"; break;
826 case '\r': O << "\\r"; break;
827 case '\t': O << "\\t"; break;
830 O << toOctal(C >> 6);
831 O << toOctal(C >> 3);
832 O << toOctal(C >> 0);
838 /// EmitString - Emit a string with quotes and a null terminator.
839 /// Special characters are emitted properly.
840 /// \literal (Eg. '\t') \endliteral
841 void AsmPrinter::EmitString(const StringRef String) const {
842 EmitString(String.data(), String.size());
845 void AsmPrinter::EmitString(const char *String, unsigned Size) const {
846 const char* AscizDirective = MAI->getAscizDirective();
850 O << MAI->getAsciiDirective();
852 for (unsigned i = 0; i < Size; ++i)
853 printStringChar(O, String[i]);
861 /// EmitFile - Emit a .file directive.
862 void AsmPrinter::EmitFile(unsigned Number, StringRef Name) const {
863 O << "\t.file\t" << Number << " \"";
864 for (unsigned i = 0, N = Name.size(); i < N; ++i)
865 printStringChar(O, Name[i]);
870 //===----------------------------------------------------------------------===//
872 // EmitAlignment - Emit an alignment directive to the specified power of
873 // two boundary. For example, if you pass in 3 here, you will get an 8
874 // byte alignment. If a global value is specified, and if that global has
875 // an explicit alignment requested, it will unconditionally override the
876 // alignment request. However, if ForcedAlignBits is specified, this value
877 // has final say: the ultimate alignment will be the max of ForcedAlignBits
878 // and the alignment computed with NumBits and the global.
882 // if (GV && GV->hasalignment) Align = GV->getalignment();
883 // Align = std::max(Align, ForcedAlignBits);
885 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
886 unsigned ForcedAlignBits,
887 bool UseFillExpr) const {
888 if (GV && GV->getAlignment())
889 NumBits = Log2_32(GV->getAlignment());
890 NumBits = std::max(NumBits, ForcedAlignBits);
892 if (NumBits == 0) return; // No need to emit alignment.
894 unsigned FillValue = 0;
895 if (getCurrentSection()->getKind().isText())
896 FillValue = MAI->getTextAlignFillValue();
898 OutStreamer.EmitValueToAlignment(1 << NumBits, FillValue, 1, 0);
901 // Print out the specified constant, without a storage class. Only the
902 // constants valid in constant expressions can occur here.
903 void AsmPrinter::EmitConstantValueOnly(const Constant *CV) {
904 if (CV->isNullValue() || isa<UndefValue>(CV)) {
909 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
910 O << CI->getZExtValue();
914 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV)) {
915 // This is a constant address for a global variable or function. Use the
916 // name of the variable or function as the address value.
917 O << *GetGlobalValueSymbol(GV);
921 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
922 O << *GetBlockAddressSymbol(BA);
926 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
928 llvm_unreachable("Unknown constant value!");
933 switch (CE->getOpcode()) {
934 case Instruction::ZExt:
935 case Instruction::SExt:
936 case Instruction::FPTrunc:
937 case Instruction::FPExt:
938 case Instruction::UIToFP:
939 case Instruction::SIToFP:
940 case Instruction::FPToUI:
941 case Instruction::FPToSI:
943 llvm_unreachable("FIXME: Don't support this constant cast expr");
944 case Instruction::GetElementPtr: {
945 // generate a symbolic expression for the byte address
946 const TargetData *TD = TM.getTargetData();
947 const Constant *ptrVal = CE->getOperand(0);
948 SmallVector<Value*, 8> idxVec(CE->op_begin()+1, CE->op_end());
949 int64_t Offset = TD->getIndexedOffset(ptrVal->getType(), &idxVec[0],
952 return EmitConstantValueOnly(ptrVal);
954 // Truncate/sext the offset to the pointer size.
955 if (TD->getPointerSizeInBits() != 64) {
956 int SExtAmount = 64-TD->getPointerSizeInBits();
957 Offset = (Offset << SExtAmount) >> SExtAmount;
962 EmitConstantValueOnly(ptrVal);
964 O << ") + " << Offset;
966 O << ") - " << -Offset;
969 case Instruction::BitCast:
970 return EmitConstantValueOnly(CE->getOperand(0));
972 case Instruction::IntToPtr: {
973 // Handle casts to pointers by changing them into casts to the appropriate
974 // integer type. This promotes constant folding and simplifies this code.
975 const TargetData *TD = TM.getTargetData();
976 Constant *Op = CE->getOperand(0);
977 Op = ConstantExpr::getIntegerCast(Op, TD->getIntPtrType(CV->getContext()),
979 return EmitConstantValueOnly(Op);
982 case Instruction::PtrToInt: {
983 // Support only foldable casts to/from pointers that can be eliminated by
984 // changing the pointer to the appropriately sized integer type.
985 Constant *Op = CE->getOperand(0);
986 const Type *Ty = CE->getType();
987 const TargetData *TD = TM.getTargetData();
989 // We can emit the pointer value into this slot if the slot is an
990 // integer slot greater or equal to the size of the pointer.
991 if (TD->getTypeAllocSize(Ty) == TD->getTypeAllocSize(Op->getType()))
992 return EmitConstantValueOnly(Op);
995 EmitConstantValueOnly(Op);
997 APInt::getAllOnesValue(TD->getTypeAllocSizeInBits(Op->getType()));
1000 ptrMask.toStringUnsigned(S);
1001 O << ") & " << S.str() << ')';
1005 case Instruction::Trunc:
1006 // We emit the value and depend on the assembler to truncate the generated
1007 // expression properly. This is important for differences between
1008 // blockaddress labels. Since the two labels are in the same function, it
1009 // is reasonable to treat their delta as a 32-bit value.
1010 return EmitConstantValueOnly(CE->getOperand(0));
1012 case Instruction::Add:
1013 case Instruction::Sub:
1014 case Instruction::And:
1015 case Instruction::Or:
1016 case Instruction::Xor:
1018 EmitConstantValueOnly(CE->getOperand(0));
1020 switch (CE->getOpcode()) {
1021 case Instruction::Add:
1024 case Instruction::Sub:
1027 case Instruction::And:
1030 case Instruction::Or:
1033 case Instruction::Xor:
1040 EmitConstantValueOnly(CE->getOperand(1));
1046 /// printAsCString - Print the specified array as a C compatible string, only if
1047 /// the predicate isString is true.
1049 static void printAsCString(formatted_raw_ostream &O, const ConstantArray *CVA,
1051 assert(CVA->isString() && "Array is not string compatible!");
1054 for (unsigned i = 0; i != LastElt; ++i) {
1056 (unsigned char)cast<ConstantInt>(CVA->getOperand(i))->getZExtValue();
1057 printStringChar(O, C);
1062 /// EmitString - Emit a zero-byte-terminated string constant.
1064 void AsmPrinter::EmitString(const ConstantArray *CVA) const {
1065 unsigned NumElts = CVA->getNumOperands();
1066 if (MAI->getAscizDirective() && NumElts &&
1067 cast<ConstantInt>(CVA->getOperand(NumElts-1))->getZExtValue() == 0) {
1068 O << MAI->getAscizDirective();
1069 printAsCString(O, CVA, NumElts-1);
1071 O << MAI->getAsciiDirective();
1072 printAsCString(O, CVA, NumElts);
1077 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
1079 if (AddrSpace == 0 && CA->isString()) {
1081 } else { // Not a string. Print the values in successive locations
1082 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1083 AP.EmitGlobalConstant(CA->getOperand(i), AddrSpace);
1087 static void EmitGlobalConstantVector(const ConstantVector *CV,
1088 unsigned AddrSpace, AsmPrinter &AP) {
1089 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1090 AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
1093 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
1094 unsigned AddrSpace, AsmPrinter &AP) {
1095 // Print the fields in successive locations. Pad to align if needed!
1096 const TargetData *TD = AP.TM.getTargetData();
1097 unsigned Size = TD->getTypeAllocSize(CS->getType());
1098 const StructLayout *Layout = TD->getStructLayout(CS->getType());
1099 uint64_t SizeSoFar = 0;
1100 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1101 const Constant *Field = CS->getOperand(i);
1103 // Check if padding is needed and insert one or more 0s.
1104 uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
1105 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1106 - Layout->getElementOffset(i)) - FieldSize;
1107 SizeSoFar += FieldSize + PadSize;
1109 // Now print the actual field value.
1110 AP.EmitGlobalConstant(Field, AddrSpace);
1112 // Insert padding - this may include padding to increase the size of the
1113 // current field up to the ABI size (if the struct is not packed) as well
1114 // as padding to ensure that the next field starts at the right offset.
1115 AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
1117 assert(SizeSoFar == Layout->getSizeInBytes() &&
1118 "Layout of constant struct may be incorrect!");
1121 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
1123 // FP Constants are printed as integer constants to avoid losing
1125 if (CFP->getType()->isDoubleTy()) {
1126 if (AP.VerboseAsm) {
1127 double Val = CFP->getValueAPF().convertToDouble(); // for comment only
1128 AP.O.PadToColumn(AP.MAI->getCommentColumn());
1129 AP.O << AP.MAI->getCommentString() << " double " << Val << '\n';
1132 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1133 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1137 if (CFP->getType()->isFloatTy()) {
1138 if (AP.VerboseAsm) {
1139 float Val = CFP->getValueAPF().convertToFloat(); // for comment only
1140 AP.O.PadToColumn(AP.MAI->getCommentColumn());
1141 AP.O << AP.MAI->getCommentString() << " float " << Val << '\n';
1143 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1144 AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
1148 if (CFP->getType()->isX86_FP80Ty()) {
1149 // all long double variants are printed as hex
1150 // api needed to prevent premature destruction
1151 APInt API = CFP->getValueAPF().bitcastToAPInt();
1152 const uint64_t *p = API.getRawData();
1153 if (AP.VerboseAsm) {
1154 // Convert to double so we can print the approximate val as a comment.
1155 APFloat DoubleVal = CFP->getValueAPF();
1157 DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1159 AP.O.PadToColumn(AP.MAI->getCommentColumn());
1160 AP.O << AP.MAI->getCommentString() << " x86_fp80 ~= "
1161 << DoubleVal.convertToDouble() << '\n';
1164 if (AP.TM.getTargetData()->isBigEndian()) {
1165 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1166 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1168 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1169 AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1172 // Emit the tail padding for the long double.
1173 const TargetData &TD = *AP.TM.getTargetData();
1174 AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
1175 TD.getTypeStoreSize(CFP->getType()), AddrSpace);
1179 assert(CFP->getType()->isPPC_FP128Ty() &&
1180 "Floating point constant type not handled");
1181 // All long double variants are printed as hex api needed to prevent
1182 // premature destruction.
1183 APInt API = CFP->getValueAPF().bitcastToAPInt();
1184 const uint64_t *p = API.getRawData();
1185 if (AP.TM.getTargetData()->isBigEndian()) {
1186 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1187 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1189 AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1190 AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1194 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
1195 unsigned AddrSpace, AsmPrinter &AP) {
1196 const TargetData *TD = AP.TM.getTargetData();
1197 unsigned BitWidth = CI->getBitWidth();
1198 assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
1200 // We don't expect assemblers to support integer data directives
1201 // for more than 64 bits, so we emit the data in at most 64-bit
1202 // quantities at a time.
1203 const uint64_t *RawData = CI->getValue().getRawData();
1204 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1205 uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1206 AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1210 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1211 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1212 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
1213 uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1214 return OutStreamer.EmitZeros(Size, AddrSpace);
1217 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1218 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1225 O.PadToColumn(MAI->getCommentColumn());
1226 O << MAI->getCommentString() << " 0x";
1227 O.write_hex(CI->getZExtValue());
1230 OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1233 EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
1238 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1239 return EmitGlobalConstantArray(CVA, AddrSpace, *this);
1241 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1242 return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
1244 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1245 return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1247 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1248 return EmitGlobalConstantVector(V, AddrSpace, *this);
1250 if (isa<ConstantPointerNull>(CV)) {
1251 unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1252 OutStreamer.EmitIntValue(0, Size, AddrSpace);
1256 // Otherwise, it must be a ConstantExpr. Emit the data directive, then emit
1257 // the expression value.
1258 switch (TM.getTargetData()->getTypeAllocSize(CV->getType())) {
1260 case 1: O << MAI->getData8bitsDirective(AddrSpace); break;
1261 case 2: O << MAI->getData16bitsDirective(AddrSpace); break;
1262 case 4: O << MAI->getData32bitsDirective(AddrSpace); break;
1264 if (const char *Dir = MAI->getData64bitsDirective(AddrSpace)) {
1270 llvm_unreachable("Target cannot handle given data directive width!");
1274 EmitConstantValueOnly(CV);
1278 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1279 // Target doesn't support this yet!
1280 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1283 /// PrintSpecial - Print information related to the specified machine instr
1284 /// that is independent of the operand, and may be independent of the instr
1285 /// itself. This can be useful for portably encoding the comment character
1286 /// or other bits of target-specific knowledge into the asmstrings. The
1287 /// syntax used is ${:comment}. Targets can override this to add support
1288 /// for their own strange codes.
1289 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1290 if (!strcmp(Code, "private")) {
1291 O << MAI->getPrivateGlobalPrefix();
1292 } else if (!strcmp(Code, "comment")) {
1294 O << MAI->getCommentString();
1295 } else if (!strcmp(Code, "uid")) {
1296 // Comparing the address of MI isn't sufficient, because machineinstrs may
1297 // be allocated to the same address across functions.
1298 const Function *ThisF = MI->getParent()->getParent()->getFunction();
1300 // If this is a new LastFn instruction, bump the counter.
1301 if (LastMI != MI || LastFn != ThisF) {
1309 raw_string_ostream Msg(msg);
1310 Msg << "Unknown special formatter '" << Code
1311 << "' for machine instr: " << *MI;
1312 llvm_report_error(Msg.str());
1316 /// processDebugLoc - Processes the debug information of each machine
1317 /// instruction's DebugLoc.
1318 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1319 bool BeforePrintingInsn) {
1320 if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1321 || !DW->ShouldEmitDwarfDebug())
1323 DebugLoc DL = MI->getDebugLoc();
1326 DILocation CurDLT = MF->getDILocation(DL);
1327 if (CurDLT.getScope().isNull())
1330 if (!BeforePrintingInsn) {
1331 // After printing instruction
1333 } else if (CurDLT.getNode() != PrevDLT) {
1334 unsigned L = DW->RecordSourceLine(CurDLT.getLineNumber(),
1335 CurDLT.getColumnNumber(),
1336 CurDLT.getScope().getNode());
1339 DW->BeginScope(MI, L);
1340 PrevDLT = CurDLT.getNode();
1345 /// printInlineAsm - This method formats and prints the specified machine
1346 /// instruction that is an inline asm.
1347 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1348 unsigned NumOperands = MI->getNumOperands();
1350 // Count the number of register definitions.
1351 unsigned NumDefs = 0;
1352 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1354 assert(NumDefs != NumOperands-1 && "No asm string?");
1356 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1358 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1359 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1363 // If this asmstr is empty, just print the #APP/#NOAPP markers.
1364 // These are useful to see where empty asm's wound up.
1365 if (AsmStr[0] == 0) {
1366 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1367 O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1371 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1373 // The variant of the current asmprinter.
1374 int AsmPrinterVariant = MAI->getAssemblerDialect();
1376 int CurVariant = -1; // The number of the {.|.|.} region we are in.
1377 const char *LastEmitted = AsmStr; // One past the last character emitted.
1379 while (*LastEmitted) {
1380 switch (*LastEmitted) {
1382 // Not a special case, emit the string section literally.
1383 const char *LiteralEnd = LastEmitted+1;
1384 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1385 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1387 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1388 O.write(LastEmitted, LiteralEnd-LastEmitted);
1389 LastEmitted = LiteralEnd;
1393 ++LastEmitted; // Consume newline character.
1394 O << '\n'; // Indent code with newline.
1397 ++LastEmitted; // Consume '$' character.
1401 switch (*LastEmitted) {
1402 default: Done = false; break;
1403 case '$': // $$ -> $
1404 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1406 ++LastEmitted; // Consume second '$' character.
1408 case '(': // $( -> same as GCC's { character.
1409 ++LastEmitted; // Consume '(' character.
1410 if (CurVariant != -1) {
1411 llvm_report_error("Nested variants found in inline asm string: '"
1412 + std::string(AsmStr) + "'");
1414 CurVariant = 0; // We're in the first variant now.
1417 ++LastEmitted; // consume '|' character.
1418 if (CurVariant == -1)
1419 O << '|'; // this is gcc's behavior for | outside a variant
1421 ++CurVariant; // We're in the next variant.
1423 case ')': // $) -> same as GCC's } char.
1424 ++LastEmitted; // consume ')' character.
1425 if (CurVariant == -1)
1426 O << '}'; // this is gcc's behavior for } outside a variant
1433 bool HasCurlyBraces = false;
1434 if (*LastEmitted == '{') { // ${variable}
1435 ++LastEmitted; // Consume '{' character.
1436 HasCurlyBraces = true;
1439 // If we have ${:foo}, then this is not a real operand reference, it is a
1440 // "magic" string reference, just like in .td files. Arrange to call
1442 if (HasCurlyBraces && *LastEmitted == ':') {
1444 const char *StrStart = LastEmitted;
1445 const char *StrEnd = strchr(StrStart, '}');
1447 llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1448 + std::string(AsmStr) + "'");
1451 std::string Val(StrStart, StrEnd);
1452 PrintSpecial(MI, Val.c_str());
1453 LastEmitted = StrEnd+1;
1457 const char *IDStart = LastEmitted;
1460 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1461 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1462 llvm_report_error("Bad $ operand number in inline asm string: '"
1463 + std::string(AsmStr) + "'");
1465 LastEmitted = IDEnd;
1467 char Modifier[2] = { 0, 0 };
1469 if (HasCurlyBraces) {
1470 // If we have curly braces, check for a modifier character. This
1471 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1472 if (*LastEmitted == ':') {
1473 ++LastEmitted; // Consume ':' character.
1474 if (*LastEmitted == 0) {
1475 llvm_report_error("Bad ${:} expression in inline asm string: '"
1476 + std::string(AsmStr) + "'");
1479 Modifier[0] = *LastEmitted;
1480 ++LastEmitted; // Consume modifier character.
1483 if (*LastEmitted != '}') {
1484 llvm_report_error("Bad ${} expression in inline asm string: '"
1485 + std::string(AsmStr) + "'");
1487 ++LastEmitted; // Consume '}' character.
1490 if ((unsigned)Val >= NumOperands-1) {
1491 llvm_report_error("Invalid $ operand number in inline asm string: '"
1492 + std::string(AsmStr) + "'");
1495 // Okay, we finally have a value number. Ask the target to print this
1497 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1502 // Scan to find the machine operand number for the operand.
1503 for (; Val; --Val) {
1504 if (OpNo >= MI->getNumOperands()) break;
1505 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1506 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1509 if (OpNo >= MI->getNumOperands()) {
1512 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1513 ++OpNo; // Skip over the ID number.
1515 if (Modifier[0] == 'l') // labels are target independent
1516 O << *GetMBBSymbol(MI->getOperand(OpNo).getMBB()->getNumber());
1518 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1519 if ((OpFlags & 7) == 4) {
1520 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1521 Modifier[0] ? Modifier : 0);
1523 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1524 Modifier[0] ? Modifier : 0);
1530 raw_string_ostream Msg(msg);
1531 Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1533 llvm_report_error(Msg.str());
1540 O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1543 /// printImplicitDef - This method prints the specified machine instruction
1544 /// that is an implicit def.
1545 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1546 if (!VerboseAsm) return;
1547 O.PadToColumn(MAI->getCommentColumn());
1548 O << MAI->getCommentString() << " implicit-def: "
1549 << TRI->getName(MI->getOperand(0).getReg());
1552 void AsmPrinter::printKill(const MachineInstr *MI) const {
1553 if (!VerboseAsm) return;
1554 O.PadToColumn(MAI->getCommentColumn());
1555 O << MAI->getCommentString() << " kill:";
1556 for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1557 const MachineOperand &op = MI->getOperand(n);
1558 assert(op.isReg() && "KILL instruction must have only register operands");
1559 O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1563 /// printLabel - This method prints a local label used by debug and
1564 /// exception handling tables.
1565 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1566 printLabel(MI->getOperand(0).getImm());
1569 void AsmPrinter::printLabel(unsigned Id) const {
1570 O << MAI->getPrivateGlobalPrefix() << "label" << Id << ':';
1573 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1574 /// instruction, using the specified assembler variant. Targets should
1575 /// override this to format as appropriate.
1576 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1577 unsigned AsmVariant, const char *ExtraCode) {
1578 // Target doesn't support this yet!
1582 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1583 unsigned AsmVariant,
1584 const char *ExtraCode) {
1585 // Target doesn't support this yet!
1589 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA,
1590 const char *Suffix) const {
1591 return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock(), Suffix);
1594 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1595 const BasicBlock *BB,
1596 const char *Suffix) const {
1597 assert(BB->hasName() &&
1598 "Address of anonymous basic block not supported yet!");
1600 // This code must use the function name itself, and not the function number,
1601 // since it must be possible to generate the label name from within other
1603 SmallString<60> FnName;
1604 Mang->getNameWithPrefix(FnName, F, false);
1606 // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1607 SmallString<60> NameResult;
1608 Mang->getNameWithPrefix(NameResult,
1609 StringRef("BA") + Twine((unsigned)FnName.size()) +
1610 "_" + FnName.str() + "_" + BB->getName() + Suffix,
1613 return OutContext.GetOrCreateSymbol(NameResult.str());
1616 MCSymbol *AsmPrinter::GetMBBSymbol(unsigned MBBID) const {
1617 SmallString<60> Name;
1618 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "BB"
1619 << getFunctionNumber() << '_' << MBBID;
1621 return OutContext.GetOrCreateSymbol(Name.str());
1624 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
1626 MCSymbol *AsmPrinter::GetGlobalValueSymbol(const GlobalValue *GV) const {
1627 SmallString<60> NameStr;
1628 Mang->getNameWithPrefix(NameStr, GV, false);
1629 return OutContext.GetOrCreateSymbol(NameStr.str());
1632 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1633 /// global value name as its base, with the specified suffix, and where the
1634 /// symbol is forced to have private linkage if ForcePrivate is true.
1635 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1637 bool ForcePrivate) const {
1638 SmallString<60> NameStr;
1639 Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1640 NameStr.append(Suffix.begin(), Suffix.end());
1641 return OutContext.GetOrCreateSymbol(NameStr.str());
1644 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1646 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1647 SmallString<60> NameStr;
1648 Mang->getNameWithPrefix(NameStr, Sym);
1649 return OutContext.GetOrCreateSymbol(NameStr.str());
1653 /// EmitBasicBlockStart - This method prints the label for the specified
1654 /// MachineBasicBlock, an alignment (if present) and a comment describing
1655 /// it if appropriate.
1656 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1657 // Emit an alignment directive for this block, if needed.
1658 if (unsigned Align = MBB->getAlignment())
1659 EmitAlignment(Log2_32(Align));
1661 // If the block has its address taken, emit a special label to satisfy
1662 // references to the block. This is done so that we don't need to
1663 // remember the number of this label, and so that we can make
1664 // forward references to labels without knowing what their numbers
1666 if (MBB->hasAddressTaken()) {
1667 const BasicBlock *BB = MBB->getBasicBlock();
1668 OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1670 O.PadToColumn(MAI->getCommentColumn());
1671 O << MAI->getCommentString() << " Address Taken" << '\n';
1675 // Print the main label for the block.
1676 if (MBB->pred_empty() || MBB->isOnlyReachableByFallthrough()) {
1678 O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1680 OutStreamer.EmitLabel(GetMBBSymbol(MBB->getNumber()));
1683 // Print some comments to accompany the label.
1685 if (const BasicBlock *BB = MBB->getBasicBlock())
1686 if (BB->hasName()) {
1687 O.PadToColumn(MAI->getCommentColumn());
1688 O << MAI->getCommentString() << ' ';
1689 WriteAsOperand(O, BB, /*PrintType=*/false);
1697 /// printPICJumpTableSetLabel - This method prints a set label for the
1698 /// specified MachineBasicBlock for a jumptable entry.
1699 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
1700 const MachineBasicBlock *MBB) const {
1701 if (!MAI->getSetDirective())
1704 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1705 << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ','
1706 << *GetMBBSymbol(MBB->getNumber())
1707 << '-' << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1708 << '_' << uid << '\n';
1711 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
1712 const MachineBasicBlock *MBB) const {
1713 if (!MAI->getSetDirective())
1716 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1717 << getFunctionNumber() << '_' << uid << '_' << uid2
1718 << "_set_" << MBB->getNumber() << ','
1719 << *GetMBBSymbol(MBB->getNumber())
1720 << '-' << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1721 << '_' << uid << '_' << uid2 << '\n';
1724 void AsmPrinter::printVisibility(const MCSymbol *Sym,
1725 unsigned Visibility) const {
1726 if (Visibility == GlobalValue::HiddenVisibility) {
1727 if (const char *Directive = MAI->getHiddenDirective())
1728 O << Directive << *Sym << '\n';
1729 } else if (Visibility == GlobalValue::ProtectedVisibility) {
1730 if (const char *Directive = MAI->getProtectedDirective())
1731 O << Directive << *Sym << '\n';
1735 void AsmPrinter::printOffset(int64_t Offset) const {
1738 else if (Offset < 0)
1742 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1743 if (!S->usesMetadata())
1746 gcp_iterator GCPI = GCMetadataPrinters.find(S);
1747 if (GCPI != GCMetadataPrinters.end())
1748 return GCPI->second;
1750 const char *Name = S->getName().c_str();
1752 for (GCMetadataPrinterRegistry::iterator
1753 I = GCMetadataPrinterRegistry::begin(),
1754 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1755 if (strcmp(Name, I->getName()) == 0) {
1756 GCMetadataPrinter *GMP = I->instantiate();
1758 GCMetadataPrinters.insert(std::make_pair(S, GMP));
1762 errs() << "no GCMetadataPrinter registered for GC: " << Name << "\n";
1763 llvm_unreachable(0);
1766 /// EmitComments - Pretty-print comments for instructions
1767 void AsmPrinter::EmitComments(const MachineInstr &MI) const {
1771 bool Newline = false;
1773 if (!MI.getDebugLoc().isUnknown()) {
1774 DILocation DLT = MF->getDILocation(MI.getDebugLoc());
1776 // Print source line info.
1777 O.PadToColumn(MAI->getCommentColumn());
1778 O << MAI->getCommentString() << ' ';
1779 DIScope Scope = DLT.getScope();
1780 // Omit the directory, because it's likely to be long and uninteresting.
1781 if (!Scope.isNull())
1782 O << Scope.getFilename();
1785 O << ':' << DLT.getLineNumber();
1786 if (DLT.getColumnNumber() != 0)
1787 O << ':' << DLT.getColumnNumber();
1791 // Check for spills and reloads
1794 const MachineFrameInfo *FrameInfo =
1795 MI.getParent()->getParent()->getFrameInfo();
1797 // We assume a single instruction only has a spill or reload, not
1799 const MachineMemOperand *MMO;
1800 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
1801 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1802 MMO = *MI.memoperands_begin();
1803 if (Newline) O << '\n';
1804 O.PadToColumn(MAI->getCommentColumn());
1805 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Reload";
1809 else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
1810 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1811 if (Newline) O << '\n';
1812 O.PadToColumn(MAI->getCommentColumn());
1813 O << MAI->getCommentString() << ' '
1814 << MMO->getSize() << "-byte Folded Reload";
1818 else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
1819 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1820 MMO = *MI.memoperands_begin();
1821 if (Newline) O << '\n';
1822 O.PadToColumn(MAI->getCommentColumn());
1823 O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Spill";
1827 else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
1828 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1829 if (Newline) O << '\n';
1830 O.PadToColumn(MAI->getCommentColumn());
1831 O << MAI->getCommentString() << ' '
1832 << MMO->getSize() << "-byte Folded Spill";
1837 // Check for spill-induced copies
1838 unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1839 if (TM.getInstrInfo()->isMoveInstr(MI, SrcReg, DstReg,
1840 SrcSubIdx, DstSubIdx)) {
1841 if (MI.getAsmPrinterFlag(ReloadReuse)) {
1842 if (Newline) O << '\n';
1843 O.PadToColumn(MAI->getCommentColumn());
1844 O << MAI->getCommentString() << " Reload Reuse";
1849 /// PrintChildLoopComment - Print comments about child loops within
1850 /// the loop for this basic block, with nesting.
1852 static void PrintChildLoopComment(formatted_raw_ostream &O,
1853 const MachineLoop *loop,
1854 const MCAsmInfo *MAI,
1855 int FunctionNumber) {
1856 // Add child loop information
1857 for(MachineLoop::iterator cl = loop->begin(),
1858 clend = loop->end();
1861 MachineBasicBlock *Header = (*cl)->getHeader();
1862 assert(Header && "No header for loop");
1865 O.PadToColumn(MAI->getCommentColumn());
1867 O << MAI->getCommentString();
1868 O.indent(((*cl)->getLoopDepth()-1)*2)
1869 << " Child Loop BB" << FunctionNumber << "_"
1870 << Header->getNumber() << " Depth " << (*cl)->getLoopDepth();
1872 PrintChildLoopComment(O, *cl, MAI, FunctionNumber);
1876 /// EmitComments - Pretty-print comments for basic blocks
1877 void AsmPrinter::EmitComments(const MachineBasicBlock &MBB) const {
1879 // Add loop depth information
1880 const MachineLoop *loop = LI->getLoopFor(&MBB);
1883 // Print a newline after bb# annotation.
1885 O.PadToColumn(MAI->getCommentColumn());
1886 O << MAI->getCommentString() << " Loop Depth " << loop->getLoopDepth()
1889 O.PadToColumn(MAI->getCommentColumn());
1891 MachineBasicBlock *Header = loop->getHeader();
1892 assert(Header && "No header for loop");
1894 if (Header == &MBB) {
1895 O << MAI->getCommentString() << " Loop Header";
1896 PrintChildLoopComment(O, loop, MAI, getFunctionNumber());
1899 O << MAI->getCommentString() << " Loop Header is BB"
1900 << getFunctionNumber() << "_" << loop->getHeader()->getNumber();
1903 if (loop->empty()) {
1905 O.PadToColumn(MAI->getCommentColumn());
1906 O << MAI->getCommentString() << " Inner Loop";
1909 // Add parent loop information
1910 for (const MachineLoop *CurLoop = loop->getParentLoop();
1912 CurLoop = CurLoop->getParentLoop()) {
1913 MachineBasicBlock *Header = CurLoop->getHeader();
1914 assert(Header && "No header for loop");
1917 O.PadToColumn(MAI->getCommentColumn());
1918 O << MAI->getCommentString();
1919 O.indent((CurLoop->getLoopDepth()-1)*2)
1920 << " Inside Loop BB" << getFunctionNumber() << "_"
1921 << Header->getNumber() << " Depth " << CurLoop->getLoopDepth();