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/GCMetadataPrinter.h"
20 #include "llvm/CodeGen/MachineConstantPool.h"
21 #include "llvm/CodeGen/MachineFunction.h"
22 #include "llvm/CodeGen/MachineJumpTableInfo.h"
23 #include "llvm/CodeGen/MachineLoopInfo.h"
24 #include "llvm/CodeGen/MachineModuleInfo.h"
25 #include "llvm/CodeGen/DwarfWriter.h"
26 #include "llvm/Analysis/DebugInfo.h"
27 #include "llvm/MC/MCContext.h"
28 #include "llvm/MC/MCInst.h"
29 #include "llvm/MC/MCSection.h"
30 #include "llvm/MC/MCStreamer.h"
31 #include "llvm/MC/MCSymbol.h"
32 #include "llvm/Support/CommandLine.h"
33 #include "llvm/Support/ErrorHandling.h"
34 #include "llvm/Support/FormattedStream.h"
35 #include "llvm/Support/Mangler.h"
36 #include "llvm/MC/MCAsmInfo.h"
37 #include "llvm/Target/TargetData.h"
38 #include "llvm/Target/TargetLowering.h"
39 #include "llvm/Target/TargetLoweringObjectFile.h"
40 #include "llvm/Target/TargetOptions.h"
41 #include "llvm/Target/TargetRegisterInfo.h"
42 #include "llvm/ADT/SmallPtrSet.h"
43 #include "llvm/ADT/SmallString.h"
44 #include "llvm/ADT/StringExtras.h"
48 static cl::opt<cl::boolOrDefault>
49 AsmVerbose("asm-verbose", cl::desc("Add comments to directives."),
50 cl::init(cl::BOU_UNSET));
52 char AsmPrinter::ID = 0;
53 AsmPrinter::AsmPrinter(formatted_raw_ostream &o, TargetMachine &tm,
54 const MCAsmInfo *T, bool VDef)
55 : MachineFunctionPass(&ID), FunctionNumber(0), O(o),
56 TM(tm), MAI(T), TRI(tm.getRegisterInfo()),
58 OutContext(*new MCContext()),
59 // FIXME: Pass instprinter to streamer.
60 OutStreamer(*createAsmStreamer(OutContext, O, *T, 0)),
62 LastMI(0), LastFn(0), Counter(~0U),
63 PrevDLT(0, 0, ~0U, ~0U) {
66 case cl::BOU_UNSET: VerboseAsm = VDef; break;
67 case cl::BOU_TRUE: VerboseAsm = true; break;
68 case cl::BOU_FALSE: VerboseAsm = false; break;
72 AsmPrinter::~AsmPrinter() {
73 for (gcp_iterator I = GCMetadataPrinters.begin(),
74 E = GCMetadataPrinters.end(); I != E; ++I)
81 TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
82 return TM.getTargetLowering()->getObjFileLowering();
85 /// getCurrentSection() - Return the current section we are emitting to.
86 const MCSection *AsmPrinter::getCurrentSection() const {
87 return OutStreamer.getCurrentSection();
91 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
93 MachineFunctionPass::getAnalysisUsage(AU);
94 AU.addRequired<GCModuleInfo>();
96 AU.addRequired<MachineLoopInfo>();
99 bool AsmPrinter::doInitialization(Module &M) {
100 // Initialize TargetLoweringObjectFile.
101 const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
102 .Initialize(OutContext, TM);
104 Mang = new Mangler(M, MAI->getGlobalPrefix(), MAI->getPrivateGlobalPrefix(),
105 MAI->getLinkerPrivateGlobalPrefix());
107 if (MAI->doesAllowQuotesInName())
108 Mang->setUseQuotes(true);
110 if (MAI->doesAllowNameToStartWithDigit())
111 Mang->setSymbolsCanStartWithDigit(true);
113 // Allow the target to emit any magic that it wants at the start of the file.
114 EmitStartOfAsmFile(M);
116 if (MAI->hasSingleParameterDotFile()) {
117 /* Very minimal debug info. It is ignored if we emit actual
118 debug info. If we don't, this at least helps the user find where
119 a function came from. */
120 O << "\t.file\t\"" << M.getModuleIdentifier() << "\"\n";
123 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
124 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
125 for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
126 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
127 MP->beginAssembly(O, *this, *MAI);
129 if (!M.getModuleInlineAsm().empty())
130 O << MAI->getCommentString() << " Start of file scope inline assembly\n"
131 << M.getModuleInlineAsm()
132 << '\n' << MAI->getCommentString()
133 << " End of file scope inline assembly\n";
135 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
137 MMI->AnalyzeModule(M);
138 DW = getAnalysisIfAvailable<DwarfWriter>();
140 DW->BeginModule(&M, MMI, O, this, MAI);
145 bool AsmPrinter::doFinalization(Module &M) {
146 // Emit global variables.
147 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
149 PrintGlobalVariable(I);
151 // Emit final debug information.
152 if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
155 // If the target wants to know about weak references, print them all.
156 if (MAI->getWeakRefDirective()) {
157 // FIXME: This is not lazy, it would be nice to only print weak references
158 // to stuff that is actually used. Note that doing so would require targets
159 // to notice uses in operands (due to constant exprs etc). This should
160 // happen with the MC stuff eventually.
162 // Print out module-level global variables here.
163 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
165 if (I->hasExternalWeakLinkage())
166 O << MAI->getWeakRefDirective() << Mang->getMangledName(I) << '\n';
169 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
170 if (I->hasExternalWeakLinkage())
171 O << MAI->getWeakRefDirective() << Mang->getMangledName(I) << '\n';
175 if (MAI->getSetDirective()) {
177 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
179 std::string Name = Mang->getMangledName(I);
181 const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
182 std::string Target = Mang->getMangledName(GV);
184 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
185 O << "\t.globl\t" << Name << '\n';
186 else if (I->hasWeakLinkage())
187 O << MAI->getWeakRefDirective() << Name << '\n';
188 else if (!I->hasLocalLinkage())
189 llvm_unreachable("Invalid alias linkage");
191 printVisibility(Name, I->getVisibility());
193 O << MAI->getSetDirective() << ' ' << Name << ", " << Target << '\n';
197 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
198 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
199 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
200 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
201 MP->finishAssembly(O, *this, *MAI);
203 // If we don't have any trampolines, then we don't require stack memory
204 // to be executable. Some targets have a directive to declare this.
205 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
206 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
207 if (MAI->getNonexecutableStackDirective())
208 O << MAI->getNonexecutableStackDirective() << '\n';
211 // Allow the target to emit any magic that it wants at the end of the file,
212 // after everything else has gone out.
215 delete Mang; Mang = 0;
218 OutStreamer.Finish();
222 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
223 // What's my mangled name?
224 CurrentFnName = Mang->getMangledName(MF.getFunction());
225 IncrementFunctionNumber();
228 LI = &getAnalysis<MachineLoopInfo>();
232 // SectionCPs - Keep track the alignment, constpool entries per Section.
236 SmallVector<unsigned, 4> CPEs;
237 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {};
241 /// EmitConstantPool - Print to the current output stream assembly
242 /// representations of the constants in the constant pool MCP. This is
243 /// used to print out constants which have been "spilled to memory" by
244 /// the code generator.
246 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
247 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
248 if (CP.empty()) return;
250 // Calculate sections for constant pool entries. We collect entries to go into
251 // the same section together to reduce amount of section switch statements.
252 SmallVector<SectionCPs, 4> CPSections;
253 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
254 const MachineConstantPoolEntry &CPE = CP[i];
255 unsigned Align = CPE.getAlignment();
258 switch (CPE.getRelocationInfo()) {
259 default: llvm_unreachable("Unknown section kind");
260 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
262 Kind = SectionKind::getReadOnlyWithRelLocal();
265 switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
266 case 4: Kind = SectionKind::getMergeableConst4(); break;
267 case 8: Kind = SectionKind::getMergeableConst8(); break;
268 case 16: Kind = SectionKind::getMergeableConst16();break;
269 default: Kind = SectionKind::getMergeableConst(); break;
273 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
275 // The number of sections are small, just do a linear search from the
276 // last section to the first.
278 unsigned SecIdx = CPSections.size();
279 while (SecIdx != 0) {
280 if (CPSections[--SecIdx].S == S) {
286 SecIdx = CPSections.size();
287 CPSections.push_back(SectionCPs(S, Align));
290 if (Align > CPSections[SecIdx].Alignment)
291 CPSections[SecIdx].Alignment = Align;
292 CPSections[SecIdx].CPEs.push_back(i);
295 // Now print stuff into the calculated sections.
296 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
297 OutStreamer.SwitchSection(CPSections[i].S);
298 EmitAlignment(Log2_32(CPSections[i].Alignment));
301 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
302 unsigned CPI = CPSections[i].CPEs[j];
303 MachineConstantPoolEntry CPE = CP[CPI];
305 // Emit inter-object padding for alignment.
306 unsigned AlignMask = CPE.getAlignment() - 1;
307 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
308 EmitZeros(NewOffset - Offset);
310 const Type *Ty = CPE.getType();
311 Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
313 O << MAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << '_'
316 O.PadToColumn(MAI->getCommentColumn());
317 O << MAI->getCommentString() << " constant ";
318 WriteTypeSymbolic(O, CPE.getType(), MF->getFunction()->getParent());
321 if (CPE.isMachineConstantPoolEntry())
322 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
324 EmitGlobalConstant(CPE.Val.ConstVal);
329 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
330 /// by the current function to the current output stream.
332 void AsmPrinter::EmitJumpTableInfo(MachineJumpTableInfo *MJTI,
333 MachineFunction &MF) {
334 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
335 if (JT.empty()) return;
337 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
339 // Pick the directive to use to print the jump table entries, and switch to
340 // the appropriate section.
341 TargetLowering *LoweringInfo = TM.getTargetLowering();
343 const Function *F = MF.getFunction();
344 bool JTInDiffSection = false;
345 if (F->isWeakForLinker() ||
346 (IsPic && !LoweringInfo->usesGlobalOffsetTable())) {
347 // In PIC mode, we need to emit the jump table to the same section as the
348 // function body itself, otherwise the label differences won't make sense.
349 // We should also do if the section name is NULL or function is declared in
350 // discardable section.
351 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang,
354 // Otherwise, drop it in the readonly section.
355 const MCSection *ReadOnlySection =
356 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
357 OutStreamer.SwitchSection(ReadOnlySection);
358 JTInDiffSection = true;
361 EmitAlignment(Log2_32(MJTI->getAlignment()));
363 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
364 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
366 // If this jump table was deleted, ignore it.
367 if (JTBBs.empty()) continue;
369 // For PIC codegen, if possible we want to use the SetDirective to reduce
370 // the number of relocations the assembler will generate for the jump table.
371 // Set directives are all printed before the jump table itself.
372 SmallPtrSet<MachineBasicBlock*, 16> EmittedSets;
373 if (MAI->getSetDirective() && IsPic)
374 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
375 if (EmittedSets.insert(JTBBs[ii]))
376 printPICJumpTableSetLabel(i, JTBBs[ii]);
378 // On some targets (e.g. Darwin) we want to emit two consequtive labels
379 // before each jump table. The first label is never referenced, but tells
380 // the assembler and linker the extents of the jump table object. The
381 // second label is actually referenced by the code.
382 if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0]) {
383 O << MAI->getLinkerPrivateGlobalPrefix()
384 << "JTI" << getFunctionNumber() << '_' << i << ":\n";
387 O << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
388 << '_' << i << ":\n";
390 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
391 printPICJumpTableEntry(MJTI, JTBBs[ii], i);
397 void AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
398 const MachineBasicBlock *MBB,
399 unsigned uid) const {
400 bool isPIC = TM.getRelocationModel() == Reloc::PIC_;
402 // Use JumpTableDirective otherwise honor the entry size from the jump table
404 const char *JTEntryDirective = MAI->getJumpTableDirective(isPIC);
405 bool HadJTEntryDirective = JTEntryDirective != NULL;
406 if (!HadJTEntryDirective) {
407 JTEntryDirective = MJTI->getEntrySize() == 4 ?
408 MAI->getData32bitsDirective() : MAI->getData64bitsDirective();
411 O << JTEntryDirective << ' ';
413 // If we have emitted set directives for the jump table entries, print
414 // them rather than the entries themselves. If we're emitting PIC, then
415 // emit the table entries as differences between two text section labels.
416 // If we're emitting non-PIC code, then emit the entries as direct
417 // references to the target basic blocks.
419 GetMBBSymbol(MBB->getNumber())->print(O, MAI);
420 } else if (MAI->getSetDirective()) {
421 O << MAI->getPrivateGlobalPrefix() << getFunctionNumber()
422 << '_' << uid << "_set_" << MBB->getNumber();
424 GetMBBSymbol(MBB->getNumber())->print(O, MAI);
425 // If the arch uses custom Jump Table directives, don't calc relative to
427 if (!HadJTEntryDirective)
428 O << '-' << MAI->getPrivateGlobalPrefix() << "JTI"
429 << getFunctionNumber() << '_' << uid;
434 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
435 /// special global used by LLVM. If so, emit it and return true, otherwise
436 /// do nothing and return false.
437 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
438 if (GV->getName() == "llvm.used") {
439 if (MAI->getUsedDirective() != 0) // No need to emit this at all.
440 EmitLLVMUsedList(GV->getInitializer());
444 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
445 if (GV->getSection() == "llvm.metadata" ||
446 GV->hasAvailableExternallyLinkage())
449 if (!GV->hasAppendingLinkage()) return false;
451 assert(GV->hasInitializer() && "Not a special LLVM global!");
453 const TargetData *TD = TM.getTargetData();
454 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
455 if (GV->getName() == "llvm.global_ctors") {
456 OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
457 EmitAlignment(Align, 0);
458 EmitXXStructorList(GV->getInitializer());
462 if (GV->getName() == "llvm.global_dtors") {
463 OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
464 EmitAlignment(Align, 0);
465 EmitXXStructorList(GV->getInitializer());
472 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
473 /// global in the specified llvm.used list for which emitUsedDirectiveFor
474 /// is true, as being used with this directive.
475 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
476 const char *Directive = MAI->getUsedDirective();
478 // Should be an array of 'i8*'.
479 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
480 if (InitList == 0) return;
482 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
483 const GlobalValue *GV =
484 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
485 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang)) {
487 EmitConstantValueOnly(InitList->getOperand(i));
493 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
494 /// function pointers, ignoring the init priority.
495 void AsmPrinter::EmitXXStructorList(Constant *List) {
496 // Should be an array of '{ int, void ()* }' structs. The first value is the
497 // init priority, which we ignore.
498 if (!isa<ConstantArray>(List)) return;
499 ConstantArray *InitList = cast<ConstantArray>(List);
500 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
501 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
502 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
504 if (CS->getOperand(1)->isNullValue())
505 return; // Found a null terminator, exit printing.
506 // Emit the function pointer.
507 EmitGlobalConstant(CS->getOperand(1));
512 //===----------------------------------------------------------------------===//
513 /// LEB 128 number encoding.
515 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
516 /// representing an unsigned leb128 value.
517 void AsmPrinter::PrintULEB128(unsigned Value) const {
520 unsigned char Byte = static_cast<unsigned char>(Value & 0x7f);
522 if (Value) Byte |= 0x80;
523 O << "0x" << utohex_buffer(Byte, Buffer+20);
524 if (Value) O << ", ";
528 /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
529 /// representing a signed leb128 value.
530 void AsmPrinter::PrintSLEB128(int Value) const {
531 int Sign = Value >> (8 * sizeof(Value) - 1);
536 unsigned char Byte = static_cast<unsigned char>(Value & 0x7f);
538 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
539 if (IsMore) Byte |= 0x80;
540 O << "0x" << utohex_buffer(Byte, Buffer+20);
541 if (IsMore) O << ", ";
545 //===--------------------------------------------------------------------===//
546 // Emission and print routines
549 /// PrintHex - Print a value as a hexidecimal value.
551 void AsmPrinter::PrintHex(int Value) const {
553 O << "0x" << utohex_buffer(static_cast<unsigned>(Value), Buffer+20);
556 /// EOL - Print a newline character to asm stream. If a comment is present
557 /// then it will be printed first. Comments should not contain '\n'.
558 void AsmPrinter::EOL() const {
562 void AsmPrinter::EOL(const std::string &Comment) const {
563 if (VerboseAsm && !Comment.empty()) {
564 O.PadToColumn(MAI->getCommentColumn());
565 O << MAI->getCommentString()
572 void AsmPrinter::EOL(const char* Comment) const {
573 if (VerboseAsm && *Comment) {
574 O.PadToColumn(MAI->getCommentColumn());
575 O << MAI->getCommentString()
582 static const char *DecodeDWARFEncoding(unsigned Encoding) {
584 case dwarf::DW_EH_PE_absptr:
586 case dwarf::DW_EH_PE_omit:
588 case dwarf::DW_EH_PE_pcrel:
590 case dwarf::DW_EH_PE_udata4:
592 case dwarf::DW_EH_PE_udata8:
594 case dwarf::DW_EH_PE_sdata4:
596 case dwarf::DW_EH_PE_sdata8:
598 case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata4:
599 return "pcrel udata4";
600 case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4:
601 return "pcrel sdata4";
602 case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata8:
603 return "pcrel udata8";
604 case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata8:
605 return "pcrel sdata8";
606 case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_udata4:
607 return "indirect pcrel udata4";
608 case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_sdata4:
609 return "indirect pcrel sdata4";
610 case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_udata8:
611 return "indirect pcrel udata8";
612 case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_sdata8:
613 return "indirect pcrel sdata8";
619 void AsmPrinter::EOL(const char *Comment, unsigned Encoding) const {
620 if (VerboseAsm && *Comment) {
621 O.PadToColumn(MAI->getCommentColumn());
622 O << MAI->getCommentString()
626 if (const char *EncStr = DecodeDWARFEncoding(Encoding))
627 O << " (" << EncStr << ')';
632 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
633 /// unsigned leb128 value.
634 void AsmPrinter::EmitULEB128Bytes(unsigned Value) const {
635 if (MAI->hasLEB128()) {
639 O << MAI->getData8bitsDirective();
644 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
645 /// signed leb128 value.
646 void AsmPrinter::EmitSLEB128Bytes(int Value) const {
647 if (MAI->hasLEB128()) {
651 O << MAI->getData8bitsDirective();
656 /// EmitInt8 - Emit a byte directive and value.
658 void AsmPrinter::EmitInt8(int Value) const {
659 O << MAI->getData8bitsDirective();
660 PrintHex(Value & 0xFF);
663 /// EmitInt16 - Emit a short directive and value.
665 void AsmPrinter::EmitInt16(int Value) const {
666 O << MAI->getData16bitsDirective();
667 PrintHex(Value & 0xFFFF);
670 /// EmitInt32 - Emit a long directive and value.
672 void AsmPrinter::EmitInt32(int Value) const {
673 O << MAI->getData32bitsDirective();
677 /// EmitInt64 - Emit a long long directive and value.
679 void AsmPrinter::EmitInt64(uint64_t Value) const {
680 if (MAI->getData64bitsDirective()) {
681 O << MAI->getData64bitsDirective();
684 if (TM.getTargetData()->isBigEndian()) {
685 EmitInt32(unsigned(Value >> 32)); O << '\n';
686 EmitInt32(unsigned(Value));
688 EmitInt32(unsigned(Value)); O << '\n';
689 EmitInt32(unsigned(Value >> 32));
694 /// toOctal - Convert the low order bits of X into an octal digit.
696 static inline char toOctal(int X) {
700 /// printStringChar - Print a char, escaped if necessary.
702 static void printStringChar(formatted_raw_ostream &O, unsigned char C) {
705 } else if (C == '\\') {
707 } else if (isprint((unsigned char)C)) {
711 case '\b': O << "\\b"; break;
712 case '\f': O << "\\f"; break;
713 case '\n': O << "\\n"; break;
714 case '\r': O << "\\r"; break;
715 case '\t': O << "\\t"; break;
718 O << toOctal(C >> 6);
719 O << toOctal(C >> 3);
720 O << toOctal(C >> 0);
726 /// EmitString - Emit a string with quotes and a null terminator.
727 /// Special characters are emitted properly.
728 /// \literal (Eg. '\t') \endliteral
729 void AsmPrinter::EmitString(const std::string &String) const {
730 EmitString(String.c_str(), String.size());
733 void AsmPrinter::EmitString(const char *String, unsigned Size) const {
734 const char* AscizDirective = MAI->getAscizDirective();
738 O << MAI->getAsciiDirective();
740 for (unsigned i = 0; i < Size; ++i)
741 printStringChar(O, String[i]);
749 /// EmitFile - Emit a .file directive.
750 void AsmPrinter::EmitFile(unsigned Number, const std::string &Name) const {
751 O << "\t.file\t" << Number << " \"";
752 for (unsigned i = 0, N = Name.size(); i < N; ++i)
753 printStringChar(O, Name[i]);
758 //===----------------------------------------------------------------------===//
760 // EmitAlignment - Emit an alignment directive to the specified power of
761 // two boundary. For example, if you pass in 3 here, you will get an 8
762 // byte alignment. If a global value is specified, and if that global has
763 // an explicit alignment requested, it will unconditionally override the
764 // alignment request. However, if ForcedAlignBits is specified, this value
765 // has final say: the ultimate alignment will be the max of ForcedAlignBits
766 // and the alignment computed with NumBits and the global.
770 // if (GV && GV->hasalignment) Align = GV->getalignment();
771 // Align = std::max(Align, ForcedAlignBits);
773 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
774 unsigned ForcedAlignBits,
775 bool UseFillExpr) const {
776 if (GV && GV->getAlignment())
777 NumBits = Log2_32(GV->getAlignment());
778 NumBits = std::max(NumBits, ForcedAlignBits);
780 if (NumBits == 0) return; // No need to emit alignment.
782 unsigned FillValue = 0;
783 if (getCurrentSection()->getKind().isText())
784 FillValue = MAI->getTextAlignFillValue();
786 OutStreamer.EmitValueToAlignment(1 << NumBits, FillValue, 1, 0);
789 /// EmitZeros - Emit a block of zeros.
791 void AsmPrinter::EmitZeros(uint64_t NumZeros, unsigned AddrSpace) const {
793 if (MAI->getZeroDirective()) {
794 O << MAI->getZeroDirective() << NumZeros;
795 if (MAI->getZeroDirectiveSuffix())
796 O << MAI->getZeroDirectiveSuffix();
799 for (; NumZeros; --NumZeros)
800 O << MAI->getData8bitsDirective(AddrSpace) << "0\n";
805 // Print out the specified constant, without a storage class. Only the
806 // constants valid in constant expressions can occur here.
807 void AsmPrinter::EmitConstantValueOnly(const Constant *CV) {
808 if (CV->isNullValue() || isa<UndefValue>(CV))
810 else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
811 O << CI->getZExtValue();
812 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV)) {
813 // This is a constant address for a global variable or function. Use the
814 // name of the variable or function as the address value.
815 O << Mang->getMangledName(GV);
816 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
817 const TargetData *TD = TM.getTargetData();
818 unsigned Opcode = CE->getOpcode();
820 case Instruction::Trunc:
821 case Instruction::ZExt:
822 case Instruction::SExt:
823 case Instruction::FPTrunc:
824 case Instruction::FPExt:
825 case Instruction::UIToFP:
826 case Instruction::SIToFP:
827 case Instruction::FPToUI:
828 case Instruction::FPToSI:
829 llvm_unreachable("FIXME: Don't support this constant cast expr");
830 case Instruction::GetElementPtr: {
831 // generate a symbolic expression for the byte address
832 const Constant *ptrVal = CE->getOperand(0);
833 SmallVector<Value*, 8> idxVec(CE->op_begin()+1, CE->op_end());
834 if (int64_t Offset = TD->getIndexedOffset(ptrVal->getType(), &idxVec[0],
836 // Truncate/sext the offset to the pointer size.
837 if (TD->getPointerSizeInBits() != 64) {
838 int SExtAmount = 64-TD->getPointerSizeInBits();
839 Offset = (Offset << SExtAmount) >> SExtAmount;
844 EmitConstantValueOnly(ptrVal);
846 O << ") + " << Offset;
848 O << ") - " << -Offset;
850 EmitConstantValueOnly(ptrVal);
854 case Instruction::BitCast:
855 return EmitConstantValueOnly(CE->getOperand(0));
857 case Instruction::IntToPtr: {
858 // Handle casts to pointers by changing them into casts to the appropriate
859 // integer type. This promotes constant folding and simplifies this code.
860 Constant *Op = CE->getOperand(0);
861 Op = ConstantExpr::getIntegerCast(Op, TD->getIntPtrType(CV->getContext()),
863 return EmitConstantValueOnly(Op);
867 case Instruction::PtrToInt: {
868 // Support only foldable casts to/from pointers that can be eliminated by
869 // changing the pointer to the appropriately sized integer type.
870 Constant *Op = CE->getOperand(0);
871 const Type *Ty = CE->getType();
873 // We can emit the pointer value into this slot if the slot is an
874 // integer slot greater or equal to the size of the pointer.
875 if (TD->getTypeAllocSize(Ty) == TD->getTypeAllocSize(Op->getType()))
876 return EmitConstantValueOnly(Op);
879 EmitConstantValueOnly(Op);
881 APInt::getAllOnesValue(TD->getTypeAllocSizeInBits(Op->getType()));
884 ptrMask.toStringUnsigned(S);
885 O << ") & " << S.str() << ')';
888 case Instruction::Add:
889 case Instruction::Sub:
890 case Instruction::And:
891 case Instruction::Or:
892 case Instruction::Xor:
894 EmitConstantValueOnly(CE->getOperand(0));
897 case Instruction::Add:
900 case Instruction::Sub:
903 case Instruction::And:
906 case Instruction::Or:
909 case Instruction::Xor:
916 EmitConstantValueOnly(CE->getOperand(1));
920 llvm_unreachable("Unsupported operator!");
922 } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
923 GetBlockAddressSymbol(BA)->print(O, MAI);
925 llvm_unreachable("Unknown constant value!");
929 /// printAsCString - Print the specified array as a C compatible string, only if
930 /// the predicate isString is true.
932 static void printAsCString(formatted_raw_ostream &O, const ConstantArray *CVA,
934 assert(CVA->isString() && "Array is not string compatible!");
937 for (unsigned i = 0; i != LastElt; ++i) {
939 (unsigned char)cast<ConstantInt>(CVA->getOperand(i))->getZExtValue();
940 printStringChar(O, C);
945 /// EmitString - Emit a zero-byte-terminated string constant.
947 void AsmPrinter::EmitString(const ConstantArray *CVA) const {
948 unsigned NumElts = CVA->getNumOperands();
949 if (MAI->getAscizDirective() && NumElts &&
950 cast<ConstantInt>(CVA->getOperand(NumElts-1))->getZExtValue() == 0) {
951 O << MAI->getAscizDirective();
952 printAsCString(O, CVA, NumElts-1);
954 O << MAI->getAsciiDirective();
955 printAsCString(O, CVA, NumElts);
960 void AsmPrinter::EmitGlobalConstantArray(const ConstantArray *CVA,
961 unsigned AddrSpace) {
962 if (CVA->isString()) {
964 } else { // Not a string. Print the values in successive locations
965 for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
966 EmitGlobalConstant(CVA->getOperand(i), AddrSpace);
970 void AsmPrinter::EmitGlobalConstantVector(const ConstantVector *CP) {
971 const VectorType *PTy = CP->getType();
973 for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
974 EmitGlobalConstant(CP->getOperand(I));
977 void AsmPrinter::EmitGlobalConstantStruct(const ConstantStruct *CVS,
978 unsigned AddrSpace) {
979 // Print the fields in successive locations. Pad to align if needed!
980 const TargetData *TD = TM.getTargetData();
981 unsigned Size = TD->getTypeAllocSize(CVS->getType());
982 const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
983 uint64_t sizeSoFar = 0;
984 for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
985 const Constant* field = CVS->getOperand(i);
987 // Check if padding is needed and insert one or more 0s.
988 uint64_t fieldSize = TD->getTypeAllocSize(field->getType());
989 uint64_t padSize = ((i == e-1 ? Size : cvsLayout->getElementOffset(i+1))
990 - cvsLayout->getElementOffset(i)) - fieldSize;
991 sizeSoFar += fieldSize + padSize;
993 // Now print the actual field value.
994 EmitGlobalConstant(field, AddrSpace);
996 // Insert padding - this may include padding to increase the size of the
997 // current field up to the ABI size (if the struct is not packed) as well
998 // as padding to ensure that the next field starts at the right offset.
999 EmitZeros(padSize, AddrSpace);
1001 assert(sizeSoFar == cvsLayout->getSizeInBytes() &&
1002 "Layout of constant struct may be incorrect!");
1005 void AsmPrinter::EmitGlobalConstantFP(const ConstantFP *CFP,
1006 unsigned AddrSpace) {
1007 // FP Constants are printed as integer constants to avoid losing
1009 LLVMContext &Context = CFP->getContext();
1010 const TargetData *TD = TM.getTargetData();
1011 if (CFP->getType()->isDoubleTy()) {
1012 double Val = CFP->getValueAPF().convertToDouble(); // for comment only
1013 uint64_t i = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1014 if (MAI->getData64bitsDirective(AddrSpace)) {
1015 O << MAI->getData64bitsDirective(AddrSpace) << i;
1017 O.PadToColumn(MAI->getCommentColumn());
1018 O << MAI->getCommentString() << " double " << Val;
1021 } else if (TD->isBigEndian()) {
1022 O << MAI->getData32bitsDirective(AddrSpace) << unsigned(i >> 32);
1024 O.PadToColumn(MAI->getCommentColumn());
1025 O << MAI->getCommentString()
1026 << " most significant word of double " << Val;
1029 O << MAI->getData32bitsDirective(AddrSpace) << unsigned(i);
1031 O.PadToColumn(MAI->getCommentColumn());
1032 O << MAI->getCommentString()
1033 << " least significant word of double " << Val;
1037 O << MAI->getData32bitsDirective(AddrSpace) << unsigned(i);
1039 O.PadToColumn(MAI->getCommentColumn());
1040 O << MAI->getCommentString()
1041 << " least significant word of double " << Val;
1044 O << MAI->getData32bitsDirective(AddrSpace) << unsigned(i >> 32);
1046 O.PadToColumn(MAI->getCommentColumn());
1047 O << MAI->getCommentString()
1048 << " most significant word of double " << Val;
1055 if (CFP->getType()->isFloatTy()) {
1056 float Val = CFP->getValueAPF().convertToFloat(); // for comment only
1057 O << MAI->getData32bitsDirective(AddrSpace)
1058 << CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1060 O.PadToColumn(MAI->getCommentColumn());
1061 O << MAI->getCommentString() << " float " << Val;
1067 if (CFP->getType()->isX86_FP80Ty()) {
1068 // all long double variants are printed as hex
1069 // api needed to prevent premature destruction
1070 APInt api = CFP->getValueAPF().bitcastToAPInt();
1071 const uint64_t *p = api.getRawData();
1072 // Convert to double so we can print the approximate val as a comment.
1073 APFloat DoubleVal = CFP->getValueAPF();
1075 DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1077 if (TD->isBigEndian()) {
1078 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[1]);
1080 O.PadToColumn(MAI->getCommentColumn());
1081 O << MAI->getCommentString()
1082 << " most significant halfword of x86_fp80 ~"
1083 << DoubleVal.convertToDouble();
1086 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 48);
1088 O.PadToColumn(MAI->getCommentColumn());
1089 O << MAI->getCommentString() << " next halfword";
1092 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 32);
1094 O.PadToColumn(MAI->getCommentColumn());
1095 O << MAI->getCommentString() << " next halfword";
1098 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 16);
1100 O.PadToColumn(MAI->getCommentColumn());
1101 O << MAI->getCommentString() << " next halfword";
1104 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0]);
1106 O.PadToColumn(MAI->getCommentColumn());
1107 O << MAI->getCommentString()
1108 << " least significant halfword";
1112 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0]);
1114 O.PadToColumn(MAI->getCommentColumn());
1115 O << MAI->getCommentString()
1116 << " least significant halfword of x86_fp80 ~"
1117 << DoubleVal.convertToDouble();
1120 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 16);
1122 O.PadToColumn(MAI->getCommentColumn());
1123 O << MAI->getCommentString()
1124 << " next halfword";
1127 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 32);
1129 O.PadToColumn(MAI->getCommentColumn());
1130 O << MAI->getCommentString()
1131 << " next halfword";
1134 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[0] >> 48);
1136 O.PadToColumn(MAI->getCommentColumn());
1137 O << MAI->getCommentString()
1138 << " next halfword";
1141 O << MAI->getData16bitsDirective(AddrSpace) << uint16_t(p[1]);
1143 O.PadToColumn(MAI->getCommentColumn());
1144 O << MAI->getCommentString()
1145 << " most significant halfword";
1149 EmitZeros(TD->getTypeAllocSize(Type::getX86_FP80Ty(Context)) -
1150 TD->getTypeStoreSize(Type::getX86_FP80Ty(Context)), AddrSpace);
1154 if (CFP->getType()->isPPC_FP128Ty()) {
1155 // all long double variants are printed as hex
1156 // api needed to prevent premature destruction
1157 APInt api = CFP->getValueAPF().bitcastToAPInt();
1158 const uint64_t *p = api.getRawData();
1159 if (TD->isBigEndian()) {
1160 O << MAI->getData32bitsDirective(AddrSpace) << uint32_t(p[0] >> 32);
1162 O.PadToColumn(MAI->getCommentColumn());
1163 O << MAI->getCommentString()
1164 << " most significant word of ppc_fp128";
1167 O << MAI->getData32bitsDirective(AddrSpace) << uint32_t(p[0]);
1169 O.PadToColumn(MAI->getCommentColumn());
1170 O << MAI->getCommentString()
1174 O << MAI->getData32bitsDirective(AddrSpace) << uint32_t(p[1] >> 32);
1176 O.PadToColumn(MAI->getCommentColumn());
1177 O << MAI->getCommentString()
1181 O << MAI->getData32bitsDirective(AddrSpace) << uint32_t(p[1]);
1183 O.PadToColumn(MAI->getCommentColumn());
1184 O << MAI->getCommentString()
1185 << " least significant word";
1189 O << MAI->getData32bitsDirective(AddrSpace) << uint32_t(p[1]);
1191 O.PadToColumn(MAI->getCommentColumn());
1192 O << MAI->getCommentString()
1193 << " least significant word of ppc_fp128";
1196 O << MAI->getData32bitsDirective(AddrSpace) << uint32_t(p[1] >> 32);
1198 O.PadToColumn(MAI->getCommentColumn());
1199 O << MAI->getCommentString()
1203 O << MAI->getData32bitsDirective(AddrSpace) << uint32_t(p[0]);
1205 O.PadToColumn(MAI->getCommentColumn());
1206 O << MAI->getCommentString()
1210 O << MAI->getData32bitsDirective(AddrSpace) << uint32_t(p[0] >> 32);
1212 O.PadToColumn(MAI->getCommentColumn());
1213 O << MAI->getCommentString()
1214 << " most significant word";
1219 } else llvm_unreachable("Floating point constant type not handled");
1222 void AsmPrinter::EmitGlobalConstantLargeInt(const ConstantInt *CI,
1223 unsigned AddrSpace) {
1224 const TargetData *TD = TM.getTargetData();
1225 unsigned BitWidth = CI->getBitWidth();
1226 assert(isPowerOf2_32(BitWidth) &&
1227 "Non-power-of-2-sized integers not handled!");
1229 // We don't expect assemblers to support integer data directives
1230 // for more than 64 bits, so we emit the data in at most 64-bit
1231 // quantities at a time.
1232 const uint64_t *RawData = CI->getValue().getRawData();
1233 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1235 if (TD->isBigEndian())
1236 Val = RawData[e - i - 1];
1240 if (MAI->getData64bitsDirective(AddrSpace))
1241 O << MAI->getData64bitsDirective(AddrSpace) << Val << '\n';
1242 else if (TD->isBigEndian()) {
1243 O << MAI->getData32bitsDirective(AddrSpace) << unsigned(Val >> 32);
1245 O.PadToColumn(MAI->getCommentColumn());
1246 O << MAI->getCommentString()
1247 << " most significant half of i64 " << Val;
1250 O << MAI->getData32bitsDirective(AddrSpace) << unsigned(Val);
1252 O.PadToColumn(MAI->getCommentColumn());
1253 O << MAI->getCommentString()
1254 << " least significant half of i64 " << Val;
1258 O << MAI->getData32bitsDirective(AddrSpace) << unsigned(Val);
1260 O.PadToColumn(MAI->getCommentColumn());
1261 O << MAI->getCommentString()
1262 << " least significant half of i64 " << Val;
1265 O << MAI->getData32bitsDirective(AddrSpace) << unsigned(Val >> 32);
1267 O.PadToColumn(MAI->getCommentColumn());
1268 O << MAI->getCommentString()
1269 << " most significant half of i64 " << Val;
1276 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1277 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1278 const TargetData *TD = TM.getTargetData();
1279 const Type *type = CV->getType();
1280 unsigned Size = TD->getTypeAllocSize(type);
1282 if (CV->isNullValue() || isa<UndefValue>(CV)) {
1283 EmitZeros(Size, AddrSpace);
1285 } else if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
1286 EmitGlobalConstantArray(CVA , AddrSpace);
1288 } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
1289 EmitGlobalConstantStruct(CVS, AddrSpace);
1291 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1292 EmitGlobalConstantFP(CFP, AddrSpace);
1294 } else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1295 // Small integers are handled below; large integers are handled here.
1297 EmitGlobalConstantLargeInt(CI, AddrSpace);
1300 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
1301 EmitGlobalConstantVector(CP);
1305 printDataDirective(type, AddrSpace);
1306 EmitConstantValueOnly(CV);
1308 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1310 CI->getValue().toStringUnsigned(S, 16);
1311 O.PadToColumn(MAI->getCommentColumn());
1312 O << MAI->getCommentString() << " 0x" << S.str();
1318 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1319 // Target doesn't support this yet!
1320 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1323 /// PrintSpecial - Print information related to the specified machine instr
1324 /// that is independent of the operand, and may be independent of the instr
1325 /// itself. This can be useful for portably encoding the comment character
1326 /// or other bits of target-specific knowledge into the asmstrings. The
1327 /// syntax used is ${:comment}. Targets can override this to add support
1328 /// for their own strange codes.
1329 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1330 if (!strcmp(Code, "private")) {
1331 O << MAI->getPrivateGlobalPrefix();
1332 } else if (!strcmp(Code, "comment")) {
1334 O << MAI->getCommentString();
1335 } else if (!strcmp(Code, "uid")) {
1336 // Comparing the address of MI isn't sufficient, because machineinstrs may
1337 // be allocated to the same address across functions.
1338 const Function *ThisF = MI->getParent()->getParent()->getFunction();
1340 // If this is a new LastFn instruction, bump the counter.
1341 if (LastMI != MI || LastFn != ThisF) {
1349 raw_string_ostream Msg(msg);
1350 Msg << "Unknown special formatter '" << Code
1351 << "' for machine instr: " << *MI;
1352 llvm_report_error(Msg.str());
1356 /// processDebugLoc - Processes the debug information of each machine
1357 /// instruction's DebugLoc.
1358 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1359 bool BeforePrintingInsn) {
1362 DebugLoc DL = MI->getDebugLoc();
1363 if (MAI->doesSupportDebugInformation() && DW->ShouldEmitDwarfDebug()) {
1364 if (!DL.isUnknown()) {
1365 DebugLocTuple CurDLT = MF->getDebugLocTuple(DL);
1366 if (BeforePrintingInsn) {
1367 if (CurDLT.Scope != 0 && PrevDLT != CurDLT) {
1368 unsigned L = DW->RecordSourceLine(CurDLT.Line, CurDLT.Col,
1371 #ifdef ATTACH_DEBUG_INFO_TO_AN_INSN
1372 DW->SetDbgScopeBeginLabels(MI, L);
1375 #ifdef ATTACH_DEBUG_INFO_TO_AN_INSN
1376 DW->SetDbgScopeEndLabels(MI, 0);
1385 /// printInlineAsm - This method formats and prints the specified machine
1386 /// instruction that is an inline asm.
1387 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1388 unsigned NumOperands = MI->getNumOperands();
1390 // Count the number of register definitions.
1391 unsigned NumDefs = 0;
1392 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1394 assert(NumDefs != NumOperands-1 && "No asm string?");
1396 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1398 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1399 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1401 // If this asmstr is empty, just print the #APP/#NOAPP markers.
1402 // These are useful to see where empty asm's wound up.
1403 if (AsmStr[0] == 0) {
1404 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1405 O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1409 O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1411 // The variant of the current asmprinter.
1412 int AsmPrinterVariant = MAI->getAssemblerDialect();
1414 int CurVariant = -1; // The number of the {.|.|.} region we are in.
1415 const char *LastEmitted = AsmStr; // One past the last character emitted.
1417 while (*LastEmitted) {
1418 switch (*LastEmitted) {
1420 // Not a special case, emit the string section literally.
1421 const char *LiteralEnd = LastEmitted+1;
1422 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1423 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1425 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1426 O.write(LastEmitted, LiteralEnd-LastEmitted);
1427 LastEmitted = LiteralEnd;
1431 ++LastEmitted; // Consume newline character.
1432 O << '\n'; // Indent code with newline.
1435 ++LastEmitted; // Consume '$' character.
1439 switch (*LastEmitted) {
1440 default: Done = false; break;
1441 case '$': // $$ -> $
1442 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1444 ++LastEmitted; // Consume second '$' character.
1446 case '(': // $( -> same as GCC's { character.
1447 ++LastEmitted; // Consume '(' character.
1448 if (CurVariant != -1) {
1449 llvm_report_error("Nested variants found in inline asm string: '"
1450 + std::string(AsmStr) + "'");
1452 CurVariant = 0; // We're in the first variant now.
1455 ++LastEmitted; // consume '|' character.
1456 if (CurVariant == -1)
1457 O << '|'; // this is gcc's behavior for | outside a variant
1459 ++CurVariant; // We're in the next variant.
1461 case ')': // $) -> same as GCC's } char.
1462 ++LastEmitted; // consume ')' character.
1463 if (CurVariant == -1)
1464 O << '}'; // this is gcc's behavior for } outside a variant
1471 bool HasCurlyBraces = false;
1472 if (*LastEmitted == '{') { // ${variable}
1473 ++LastEmitted; // Consume '{' character.
1474 HasCurlyBraces = true;
1477 // If we have ${:foo}, then this is not a real operand reference, it is a
1478 // "magic" string reference, just like in .td files. Arrange to call
1480 if (HasCurlyBraces && *LastEmitted == ':') {
1482 const char *StrStart = LastEmitted;
1483 const char *StrEnd = strchr(StrStart, '}');
1485 llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1486 + std::string(AsmStr) + "'");
1489 std::string Val(StrStart, StrEnd);
1490 PrintSpecial(MI, Val.c_str());
1491 LastEmitted = StrEnd+1;
1495 const char *IDStart = LastEmitted;
1498 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1499 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1500 llvm_report_error("Bad $ operand number in inline asm string: '"
1501 + std::string(AsmStr) + "'");
1503 LastEmitted = IDEnd;
1505 char Modifier[2] = { 0, 0 };
1507 if (HasCurlyBraces) {
1508 // If we have curly braces, check for a modifier character. This
1509 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1510 if (*LastEmitted == ':') {
1511 ++LastEmitted; // Consume ':' character.
1512 if (*LastEmitted == 0) {
1513 llvm_report_error("Bad ${:} expression in inline asm string: '"
1514 + std::string(AsmStr) + "'");
1517 Modifier[0] = *LastEmitted;
1518 ++LastEmitted; // Consume modifier character.
1521 if (*LastEmitted != '}') {
1522 llvm_report_error("Bad ${} expression in inline asm string: '"
1523 + std::string(AsmStr) + "'");
1525 ++LastEmitted; // Consume '}' character.
1528 if ((unsigned)Val >= NumOperands-1) {
1529 llvm_report_error("Invalid $ operand number in inline asm string: '"
1530 + std::string(AsmStr) + "'");
1533 // Okay, we finally have a value number. Ask the target to print this
1535 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1540 // Scan to find the machine operand number for the operand.
1541 for (; Val; --Val) {
1542 if (OpNo >= MI->getNumOperands()) break;
1543 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1544 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1547 if (OpNo >= MI->getNumOperands()) {
1550 unsigned OpFlags = MI->getOperand(OpNo).getImm();
1551 ++OpNo; // Skip over the ID number.
1553 if (Modifier[0]=='l') // labels are target independent
1554 GetMBBSymbol(MI->getOperand(OpNo).getMBB()
1555 ->getNumber())->print(O, MAI);
1557 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1558 if ((OpFlags & 7) == 4) {
1559 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1560 Modifier[0] ? Modifier : 0);
1562 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1563 Modifier[0] ? Modifier : 0);
1569 raw_string_ostream Msg(msg);
1570 Msg << "Invalid operand found in inline asm: '"
1573 llvm_report_error(Msg.str());
1580 O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1583 /// printImplicitDef - This method prints the specified machine instruction
1584 /// that is an implicit def.
1585 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1586 if (!VerboseAsm) return;
1587 O.PadToColumn(MAI->getCommentColumn());
1588 O << MAI->getCommentString() << " implicit-def: "
1589 << TRI->getName(MI->getOperand(0).getReg());
1592 /// printLabel - This method prints a local label used by debug and
1593 /// exception handling tables.
1594 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1595 printLabel(MI->getOperand(0).getImm());
1598 void AsmPrinter::printLabel(unsigned Id) const {
1599 O << MAI->getPrivateGlobalPrefix() << "label" << Id << ':';
1602 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1603 /// instruction, using the specified assembler variant. Targets should
1604 /// overried this to format as appropriate.
1605 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1606 unsigned AsmVariant, const char *ExtraCode) {
1607 // Target doesn't support this yet!
1611 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1612 unsigned AsmVariant,
1613 const char *ExtraCode) {
1614 // Target doesn't support this yet!
1618 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
1619 return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock());
1622 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1623 const BasicBlock *BB) const {
1624 assert(BB->hasName() &&
1625 "Address of anonymous basic block not supported yet!");
1627 // FIXME: This isn't guaranteed to produce a unique name even if the
1628 // block and function have a name.
1629 std::string Mangled =
1630 Mang->getMangledName(F, Mang->makeNameProper(BB->getName()).c_str(),
1631 /*ForcePrivate=*/true);
1633 return OutContext.GetOrCreateSymbol(StringRef(Mangled));
1636 MCSymbol *AsmPrinter::GetMBBSymbol(unsigned MBBID) const {
1637 SmallString<60> Name;
1638 raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "BB"
1639 << getFunctionNumber() << '_' << MBBID;
1641 return OutContext.GetOrCreateSymbol(Name.str());
1645 /// EmitBasicBlockStart - This method prints the label for the specified
1646 /// MachineBasicBlock, an alignment (if present) and a comment describing
1647 /// it if appropriate.
1648 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1649 // Emit an alignment directive for this block, if needed.
1650 if (unsigned Align = MBB->getAlignment())
1651 EmitAlignment(Log2_32(Align));
1653 // If the block has its address taken, emit a special label to satisfy
1654 // references to the block. This is done so that we don't need to
1655 // remember the number of this label, and so that we can make
1656 // forward references to labels without knowing what their numbers
1658 if (MBB->hasAddressTaken()) {
1659 GetBlockAddressSymbol(MBB->getBasicBlock()->getParent(),
1660 MBB->getBasicBlock())->print(O, MAI);
1663 O.PadToColumn(MAI->getCommentColumn());
1664 O << MAI->getCommentString() << " Address Taken";
1669 // Print the main label for the block.
1670 if (MBB->pred_empty() || MBB->isOnlyReachableByFallthrough()) {
1672 O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1674 GetMBBSymbol(MBB->getNumber())->print(O, MAI);
1680 // Print some comments to accompany the label.
1682 if (const BasicBlock *BB = MBB->getBasicBlock())
1683 if (BB->hasName()) {
1684 O.PadToColumn(MAI->getCommentColumn());
1685 O << MAI->getCommentString() << ' ';
1686 WriteAsOperand(O, BB, /*PrintType=*/false);
1694 /// printPICJumpTableSetLabel - This method prints a set label for the
1695 /// specified MachineBasicBlock for a jumptable entry.
1696 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
1697 const MachineBasicBlock *MBB) const {
1698 if (!MAI->getSetDirective())
1701 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1702 << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ',';
1703 GetMBBSymbol(MBB->getNumber())->print(O, MAI);
1704 O << '-' << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1705 << '_' << uid << '\n';
1708 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
1709 const MachineBasicBlock *MBB) const {
1710 if (!MAI->getSetDirective())
1713 O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1714 << getFunctionNumber() << '_' << uid << '_' << uid2
1715 << "_set_" << MBB->getNumber() << ',';
1716 GetMBBSymbol(MBB->getNumber())->print(O, MAI);
1717 O << '-' << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1718 << '_' << uid << '_' << uid2 << '\n';
1721 /// printDataDirective - This method prints the asm directive for the
1723 void AsmPrinter::printDataDirective(const Type *type, unsigned AddrSpace) {
1724 const TargetData *TD = TM.getTargetData();
1725 switch (type->getTypeID()) {
1726 case Type::FloatTyID: case Type::DoubleTyID:
1727 case Type::X86_FP80TyID: case Type::FP128TyID: case Type::PPC_FP128TyID:
1728 assert(0 && "Should have already output floating point constant.");
1730 assert(0 && "Can't handle printing this type of thing");
1731 case Type::IntegerTyID: {
1732 unsigned BitWidth = cast<IntegerType>(type)->getBitWidth();
1734 O << MAI->getData8bitsDirective(AddrSpace);
1735 else if (BitWidth <= 16)
1736 O << MAI->getData16bitsDirective(AddrSpace);
1737 else if (BitWidth <= 32)
1738 O << MAI->getData32bitsDirective(AddrSpace);
1739 else if (BitWidth <= 64) {
1740 assert(MAI->getData64bitsDirective(AddrSpace) &&
1741 "Target cannot handle 64-bit constant exprs!");
1742 O << MAI->getData64bitsDirective(AddrSpace);
1744 llvm_unreachable("Target cannot handle given data directive width!");
1748 case Type::PointerTyID:
1749 if (TD->getPointerSize() == 8) {
1750 assert(MAI->getData64bitsDirective(AddrSpace) &&
1751 "Target cannot handle 64-bit pointer exprs!");
1752 O << MAI->getData64bitsDirective(AddrSpace);
1753 } else if (TD->getPointerSize() == 2) {
1754 O << MAI->getData16bitsDirective(AddrSpace);
1755 } else if (TD->getPointerSize() == 1) {
1756 O << MAI->getData8bitsDirective(AddrSpace);
1758 O << MAI->getData32bitsDirective(AddrSpace);
1764 void AsmPrinter::printVisibility(const std::string& Name,
1765 unsigned Visibility) const {
1766 if (Visibility == GlobalValue::HiddenVisibility) {
1767 if (const char *Directive = MAI->getHiddenDirective())
1768 O << Directive << Name << '\n';
1769 } else if (Visibility == GlobalValue::ProtectedVisibility) {
1770 if (const char *Directive = MAI->getProtectedDirective())
1771 O << Directive << Name << '\n';
1775 void AsmPrinter::printOffset(int64_t Offset) const {
1778 else if (Offset < 0)
1782 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1783 if (!S->usesMetadata())
1786 gcp_iterator GCPI = GCMetadataPrinters.find(S);
1787 if (GCPI != GCMetadataPrinters.end())
1788 return GCPI->second;
1790 const char *Name = S->getName().c_str();
1792 for (GCMetadataPrinterRegistry::iterator
1793 I = GCMetadataPrinterRegistry::begin(),
1794 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1795 if (strcmp(Name, I->getName()) == 0) {
1796 GCMetadataPrinter *GMP = I->instantiate();
1798 GCMetadataPrinters.insert(std::make_pair(S, GMP));
1802 errs() << "no GCMetadataPrinter registered for GC: " << Name << "\n";
1803 llvm_unreachable(0);
1806 /// EmitComments - Pretty-print comments for instructions
1807 void AsmPrinter::EmitComments(const MachineInstr &MI) const {
1808 assert(VerboseAsm && !MI.getDebugLoc().isUnknown());
1810 DebugLocTuple DLT = MF->getDebugLocTuple(MI.getDebugLoc());
1812 // Print source line info.
1813 O.PadToColumn(MAI->getCommentColumn());
1814 O << MAI->getCommentString() << " SrcLine ";
1816 DICompileUnit CU(DLT.Scope);
1818 O << CU.getFilename() << " ";
1822 O << ":" << DLT.Col;
1825 /// PrintChildLoopComment - Print comments about child loops within
1826 /// the loop for this basic block, with nesting.
1828 static void PrintChildLoopComment(formatted_raw_ostream &O,
1829 const MachineLoop *loop,
1830 const MCAsmInfo *MAI,
1831 int FunctionNumber) {
1832 // Add child loop information
1833 for(MachineLoop::iterator cl = loop->begin(),
1834 clend = loop->end();
1837 MachineBasicBlock *Header = (*cl)->getHeader();
1838 assert(Header && "No header for loop");
1841 O.PadToColumn(MAI->getCommentColumn());
1843 O << MAI->getCommentString();
1844 O.indent(((*cl)->getLoopDepth()-1)*2)
1845 << " Child Loop BB" << FunctionNumber << "_"
1846 << Header->getNumber() << " Depth " << (*cl)->getLoopDepth();
1848 PrintChildLoopComment(O, *cl, MAI, FunctionNumber);
1852 /// EmitComments - Pretty-print comments for basic blocks
1853 void AsmPrinter::EmitComments(const MachineBasicBlock &MBB) const
1856 // Add loop depth information
1857 const MachineLoop *loop = LI->getLoopFor(&MBB);
1860 // Print a newline after bb# annotation.
1862 O.PadToColumn(MAI->getCommentColumn());
1863 O << MAI->getCommentString() << " Loop Depth " << loop->getLoopDepth()
1866 O.PadToColumn(MAI->getCommentColumn());
1868 MachineBasicBlock *Header = loop->getHeader();
1869 assert(Header && "No header for loop");
1871 if (Header == &MBB) {
1872 O << MAI->getCommentString() << " Loop Header";
1873 PrintChildLoopComment(O, loop, MAI, getFunctionNumber());
1876 O << MAI->getCommentString() << " Loop Header is BB"
1877 << getFunctionNumber() << "_" << loop->getHeader()->getNumber();
1880 if (loop->empty()) {
1882 O.PadToColumn(MAI->getCommentColumn());
1883 O << MAI->getCommentString() << " Inner Loop";
1886 // Add parent loop information
1887 for (const MachineLoop *CurLoop = loop->getParentLoop();
1889 CurLoop = CurLoop->getParentLoop()) {
1890 MachineBasicBlock *Header = CurLoop->getHeader();
1891 assert(Header && "No header for loop");
1894 O.PadToColumn(MAI->getCommentColumn());
1895 O << MAI->getCommentString();
1896 O.indent((CurLoop->getLoopDepth()-1)*2)
1897 << " Inside Loop BB" << getFunctionNumber() << "_"
1898 << Header->getNumber() << " Depth " << CurLoop->getLoopDepth();