inline and radically simplify printDataDirective. It will eventually
[oota-llvm.git] / lib / CodeGen / AsmPrinter / AsmPrinter.cpp
1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the AsmPrinter class.
11 //
12 //===----------------------------------------------------------------------===//
13
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"
46 #include <cerrno>
47 using namespace llvm;
48
49 static cl::opt<cl::boolOrDefault>
50 AsmVerbose("asm-verbose", cl::desc("Add comments to directives."),
51            cl::init(cl::BOU_UNSET));
52
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()),
58
59     OutContext(*new MCContext()),
60     // FIXME: Pass instprinter to streamer.
61     OutStreamer(*createAsmStreamer(OutContext, O, *T,
62                                    TM.getTargetData()->isLittleEndian(), 0)),
63
64     LastMI(0), LastFn(0), Counter(~0U), PrevDLT(NULL) {
65   DW = 0; MMI = 0;
66   switch (AsmVerbose) {
67   case cl::BOU_UNSET: VerboseAsm = VDef;  break;
68   case cl::BOU_TRUE:  VerboseAsm = true;  break;
69   case cl::BOU_FALSE: VerboseAsm = false; break;
70   }
71 }
72
73 AsmPrinter::~AsmPrinter() {
74   for (gcp_iterator I = GCMetadataPrinters.begin(),
75                     E = GCMetadataPrinters.end(); I != E; ++I)
76     delete I->second;
77   
78   delete &OutStreamer;
79   delete &OutContext;
80 }
81
82 TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
83   return TM.getTargetLowering()->getObjFileLowering();
84 }
85
86 /// getCurrentSection() - Return the current section we are emitting to.
87 const MCSection *AsmPrinter::getCurrentSection() const {
88   return OutStreamer.getCurrentSection();
89 }
90
91
92 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
93   AU.setPreservesAll();
94   MachineFunctionPass::getAnalysisUsage(AU);
95   AU.addRequired<GCModuleInfo>();
96   if (VerboseAsm)
97     AU.addRequired<MachineLoopInfo>();
98 }
99
100 bool AsmPrinter::doInitialization(Module &M) {
101   // Initialize TargetLoweringObjectFile.
102   const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
103     .Initialize(OutContext, TM);
104   
105   Mang = new Mangler(*MAI);
106   
107   // Allow the target to emit any magic that it wants at the start of the file.
108   EmitStartOfAsmFile(M);
109
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";
115   }
116
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);
122   
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";
128
129   MMI = getAnalysisIfAvailable<MachineModuleInfo>();
130   if (MMI)
131     MMI->AnalyzeModule(M);
132   DW = getAnalysisIfAvailable<DwarfWriter>();
133   if (DW)
134     DW->BeginModule(&M, MMI, O, this, MAI);
135
136   return false;
137 }
138
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.
142     return;
143   
144   // Check to see if this is a special global used by LLVM, if so, emit it.
145   if (EmitSpecialLLVMGlobal(GV))
146     return;
147
148   MCSymbol *GVSym = GetGlobalValueSymbol(GV);
149   printVisibility(GVSym, GV->getVisibility());
150
151   if (MAI->hasDotTypeDotSizeDirective()) {
152     O << "\t.type\t" << *GVSym;
153     if (MAI->getCommentString()[0] != '@')
154       O << ",@object\n";
155     else
156       O << ",%object\n";
157   }
158   
159   SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
160
161   const TargetData *TD = TM.getTargetData();
162   unsigned Size = TD->getTypeAllocSize(GV->getType()->getElementType());
163   unsigned AlignLog = TD->getPreferredAlignmentLog(GV);
164   
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.
168     
169     if (VerboseAsm) {
170       O.PadToColumn(MAI->getCommentColumn());
171       O << MAI->getCommentString() << ' ';
172       WriteAsOperand(O, GV, /*PrintType=*/false, GV->getParent());
173       O << '\n';
174     }
175     
176     // Handle common symbols.
177     if (GVKind.isCommon()) {
178       // .comm _foo, 42, 4
179       OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
180       return;
181     }
182     
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);
189       return;
190     }
191     
192     if (const char *LComm = MAI->getLCOMMDirective()) {
193       // .lcomm _foo, 42
194       O << LComm << *GVSym << ',' << Size;
195       O << '\n';
196       return;
197     }
198     
199     // .local _foo
200     O << "\t.local\t" << *GVSym << '\n';
201     // .comm _foo, 42, 4
202     OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
203     return;
204   }
205   
206   const MCSection *TheSection =
207     getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
208
209   // Handle the zerofill directive on darwin, which is a special form of BSS
210   // emission.
211   if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
212     // .globl _foo
213     OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
214     // .zerofill __DATA, __common, _foo, 400, 5
215     OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
216     return;
217   }
218
219   OutStreamer.SwitchSection(TheSection);
220
221   // TODO: Factor into an 'emit linkage' thing that is shared with function
222   // bodies.
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) {
231       // .globl _foo
232       OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
233       // .weak_definition _foo
234       OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::WeakDefinition);
235     } else if (const char *LinkOnce = MAI->getLinkOnceDirective()) {
236       // .globl _foo
237       OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
238       // .linkonce same_size
239       O << LinkOnce;
240     } else {
241       // .weak _foo
242       OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Weak);
243     }
244     break;
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.
251     // .globl _foo
252     OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
253     break;
254   case GlobalValue::PrivateLinkage:
255   case GlobalValue::InternalLinkage:
256      break;
257   default:
258     llvm_unreachable("Unknown linkage type!");
259   }
260
261   EmitAlignment(AlignLog, GV);
262   if (VerboseAsm) {
263     O.PadToColumn(MAI->getCommentColumn());
264     O << MAI->getCommentString() << ' ';
265     WriteAsOperand(O, GV, /*PrintType=*/false, GV->getParent());
266     O << '\n';
267   }
268   OutStreamer.EmitLabel(GVSym);
269
270   EmitGlobalConstant(GV->getInitializer());
271
272   if (MAI->hasDotTypeDotSizeDirective())
273     O << "\t.size\t" << *GVSym << ", " << Size << '\n';
274 }
275
276
277 bool AsmPrinter::doFinalization(Module &M) {
278   // Emit global variables.
279   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
280        I != E; ++I)
281     EmitGlobalVariable(I);
282   
283   // Emit final debug information.
284   if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
285     DW->EndModule();
286   
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.
293
294     // Print out module-level global variables here.
295     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
296          I != E; ++I) {
297       if (!I->hasExternalWeakLinkage()) continue;
298       O << MAI->getWeakRefDirective() << *GetGlobalValueSymbol(I) << '\n';
299     }
300     
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';
304     }
305   }
306
307   if (MAI->getSetDirective()) {
308     O << '\n';
309     for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
310          I != E; ++I) {
311       MCSymbol *Name = GetGlobalValueSymbol(I);
312
313       const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
314       MCSymbol *Target = GetGlobalValueSymbol(GV);
315
316       if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
317         O << "\t.globl\t" << *Name << '\n';
318       else if (I->hasWeakLinkage())
319         O << MAI->getWeakRefDirective() << *Name << '\n';
320       else
321         assert(I->hasLocalLinkage() && "Invalid alias linkage");
322
323       printVisibility(Name, I->getVisibility());
324
325       O << MAI->getSetDirective() << ' ' << *Name << ", " << *Target << '\n';
326     }
327   }
328
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);
334
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';
341
342   
343   // Allow the target to emit any magic that it wants at the end of the file,
344   // after everything else has gone out.
345   EmitEndOfAsmFile(M);
346   
347   delete Mang; Mang = 0;
348   DW = 0; MMI = 0;
349   
350   OutStreamer.Finish();
351   return false;
352 }
353
354 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
355   // Get the function symbol.
356   CurrentFnSym = GetGlobalValueSymbol(MF.getFunction());
357   IncrementFunctionNumber();
358
359   if (VerboseAsm)
360     LI = &getAnalysis<MachineLoopInfo>();
361 }
362
363 namespace {
364   // SectionCPs - Keep track the alignment, constpool entries per Section.
365   struct SectionCPs {
366     const MCSection *S;
367     unsigned Alignment;
368     SmallVector<unsigned, 4> CPEs;
369     SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
370   };
371 }
372
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.
377 ///
378 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
379   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
380   if (CP.empty()) return;
381
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();
388     
389     SectionKind Kind;
390     switch (CPE.getRelocationInfo()) {
391     default: llvm_unreachable("Unknown section kind");
392     case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
393     case 1:
394       Kind = SectionKind::getReadOnlyWithRelLocal();
395       break;
396     case 0:
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;
402     }
403     }
404
405     const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
406     
407     // The number of sections are small, just do a linear search from the
408     // last section to the first.
409     bool Found = false;
410     unsigned SecIdx = CPSections.size();
411     while (SecIdx != 0) {
412       if (CPSections[--SecIdx].S == S) {
413         Found = true;
414         break;
415       }
416     }
417     if (!Found) {
418       SecIdx = CPSections.size();
419       CPSections.push_back(SectionCPs(S, Align));
420     }
421
422     if (Align > CPSections[SecIdx].Alignment)
423       CPSections[SecIdx].Alignment = Align;
424     CPSections[SecIdx].CPEs.push_back(i);
425   }
426
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));
431
432     unsigned Offset = 0;
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];
436
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*/);
441
442       const Type *Ty = CPE.getType();
443       Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
444
445       O << MAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << '_'
446         << CPI << ':';
447       if (VerboseAsm) {
448         O.PadToColumn(MAI->getCommentColumn());
449         O << MAI->getCommentString() << " constant ";
450         WriteTypeSymbolic(O, CPE.getType(), MF->getFunction()->getParent());
451       }
452       O << '\n';
453       if (CPE.isMachineConstantPoolEntry())
454         EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
455       else
456         EmitGlobalConstant(CPE.Val.ConstVal);
457     }
458   }
459 }
460
461 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
462 /// by the current function to the current output stream.  
463 ///
464 void AsmPrinter::EmitJumpTableInfo(MachineJumpTableInfo *MJTI,
465                                    MachineFunction &MF) {
466   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
467   if (JT.empty()) return;
468
469   bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
470   
471   // Pick the directive to use to print the jump table entries, and switch to 
472   // the appropriate section.
473   TargetLowering *LoweringInfo = TM.getTargetLowering();
474
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,
484                                                                     TM));
485   } else {
486     // Otherwise, drop it in the readonly section.
487     const MCSection *ReadOnlySection = 
488       getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
489     OutStreamer.SwitchSection(ReadOnlySection);
490     JTInDiffSection = true;
491   }
492   
493   EmitAlignment(Log2_32(MJTI->getAlignment()));
494   
495   for (unsigned i = 0, e = JT.size(); i != e; ++i) {
496     const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
497     
498     // If this jump table was deleted, ignore it. 
499     if (JTBBs.empty()) continue;
500
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]);
509     
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";
517     }
518     
519     O << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber() 
520       << '_' << i << ":\n";
521     
522     for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
523       printPICJumpTableEntry(MJTI, JTBBs[ii], i);
524       O << '\n';
525     }
526   }
527 }
528
529 void AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
530                                         const MachineBasicBlock *MBB,
531                                         unsigned uid)  const {
532   bool isPIC = TM.getRelocationModel() == Reloc::PIC_;
533   
534   // Use JumpTableDirective otherwise honor the entry size from the jump table
535   // info.
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();
541   }
542
543   O << JTEntryDirective << ' ';
544
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.
550   if (!isPIC) {
551     O << *GetMBBSymbol(MBB->getNumber());
552   } else if (MAI->getSetDirective()) {
553     O << MAI->getPrivateGlobalPrefix() << getFunctionNumber()
554       << '_' << uid << "_set_" << MBB->getNumber();
555   } else {
556     O << *GetMBBSymbol(MBB->getNumber());
557     // If the arch uses custom Jump Table directives, don't calc relative to
558     // JT
559     if (!HadJTEntryDirective) 
560       O << '-' << MAI->getPrivateGlobalPrefix() << "JTI"
561         << getFunctionNumber() << '_' << uid;
562   }
563 }
564
565
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());
573     return true;
574   }
575
576   // Ignore debug and non-emitted data.  This handles llvm.compiler.used.
577   if (GV->getSection() == "llvm.metadata" ||
578       GV->hasAvailableExternallyLinkage())
579     return true;
580   
581   if (!GV->hasAppendingLinkage()) return false;
582
583   assert(GV->hasInitializer() && "Not a special LLVM global!");
584   
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());
591     
592     if (TM.getRelocationModel() == Reloc::Static &&
593         MAI->hasStaticCtorDtorReferenceInStaticMode())
594       O << ".reference .constructors_used\n";
595     return true;
596   } 
597   
598   if (GV->getName() == "llvm.global_dtors") {
599     OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
600     EmitAlignment(Align, 0);
601     EmitXXStructorList(GV->getInitializer());
602
603     if (TM.getRelocationModel() == Reloc::Static &&
604         MAI->hasStaticCtorDtorReferenceInStaticMode())
605       O << ".reference .destructors_used\n";
606     return true;
607   }
608   
609   return false;
610 }
611
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();
617
618   // Should be an array of 'i8*'.
619   ConstantArray *InitList = dyn_cast<ConstantArray>(List);
620   if (InitList == 0) return;
621   
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)) {
626       O << Directive;
627       EmitConstantValueOnly(InitList->getOperand(i));
628       O << '\n';
629     }
630   }
631 }
632
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.
643
644       if (CS->getOperand(1)->isNullValue())
645         return;  // Found a null terminator, exit printing.
646       // Emit the function pointer.
647       EmitGlobalConstant(CS->getOperand(1));
648     }
649 }
650
651
652 //===----------------------------------------------------------------------===//
653 /// LEB 128 number encoding.
654
655 /// PrintULEB128 - Print a series of hexadecimal values (separated by commas)
656 /// representing an unsigned leb128 value.
657 void AsmPrinter::PrintULEB128(unsigned Value) const {
658   do {
659     unsigned char Byte = static_cast<unsigned char>(Value & 0x7f);
660     Value >>= 7;
661     if (Value) Byte |= 0x80;
662     PrintHex(Byte);
663     if (Value) O << ", ";
664   } while (Value);
665 }
666
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);
671   bool IsMore;
672
673   do {
674     unsigned char Byte = static_cast<unsigned char>(Value & 0x7f);
675     Value >>= 7;
676     IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
677     if (IsMore) Byte |= 0x80;
678     PrintHex(Byte);
679     if (IsMore) O << ", ";
680   } while (IsMore);
681 }
682
683 //===--------------------------------------------------------------------===//
684 // Emission and print routines
685 //
686
687 /// PrintHex - Print a value as a hexadecimal value.
688 ///
689 void AsmPrinter::PrintHex(uint64_t Value) const {
690   O << "0x";
691   O.write_hex(Value);
692 }
693
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 {
697   O << '\n';
698 }
699
700 void AsmPrinter::EOL(const Twine &Comment) const {
701   if (VerboseAsm && !Comment.isTriviallyEmpty()) {
702     O.PadToColumn(MAI->getCommentColumn());
703     O << MAI->getCommentString() << ' ' << Comment;
704   }
705   O << '\n';
706 }
707
708 static const char *DecodeDWARFEncoding(unsigned Encoding) {
709   switch (Encoding) {
710   case dwarf::DW_EH_PE_absptr:
711     return "absptr";
712   case dwarf::DW_EH_PE_omit:
713     return "omit";
714   case dwarf::DW_EH_PE_pcrel:
715     return "pcrel";
716   case dwarf::DW_EH_PE_udata4:
717     return "udata4";
718   case dwarf::DW_EH_PE_udata8:
719     return "udata8";
720   case dwarf::DW_EH_PE_sdata4:
721     return "sdata4";
722   case dwarf::DW_EH_PE_sdata8:
723     return "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";
740   }
741
742   return 0;
743 }
744
745 void AsmPrinter::EOL(const Twine &Comment, unsigned Encoding) const {
746   if (VerboseAsm && !Comment.isTriviallyEmpty()) {
747     O.PadToColumn(MAI->getCommentColumn());
748     O << MAI->getCommentString()
749       << ' '
750       << Comment;
751
752     if (const char *EncStr = DecodeDWARFEncoding(Encoding))
753       O << " (" << EncStr << ')';
754   }
755   O << '\n';
756 }
757
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()) {
762     O << "\t.uleb128\t"
763       << Value;
764   } else {
765     O << MAI->getData8bitsDirective();
766     PrintULEB128(Value);
767   }
768 }
769
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()) {
774     O << "\t.sleb128\t"
775       << Value;
776   } else {
777     O << MAI->getData8bitsDirective();
778     PrintSLEB128(Value);
779   }
780 }
781
782 /// EmitInt8 - Emit a byte directive and value.
783 ///
784 void AsmPrinter::EmitInt8(int Value) const {
785   OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
786 }
787
788 /// EmitInt16 - Emit a short directive and value.
789 ///
790 void AsmPrinter::EmitInt16(int Value) const {
791   OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
792 }
793
794 /// EmitInt32 - Emit a long directive and value.
795 ///
796 void AsmPrinter::EmitInt32(int Value) const {
797   OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
798 }
799
800 /// EmitInt64 - Emit a long long directive and value.
801 ///
802 void AsmPrinter::EmitInt64(uint64_t Value) const {
803   OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
804 }
805
806 /// toOctal - Convert the low order bits of X into an octal digit.
807 ///
808 static inline char toOctal(int X) {
809   return (X&7)+'0';
810 }
811
812 /// printStringChar - Print a char, escaped if necessary.
813 ///
814 static void printStringChar(formatted_raw_ostream &O, unsigned char C) {
815   if (C == '"') {
816     O << "\\\"";
817   } else if (C == '\\') {
818     O << "\\\\";
819   } else if (isprint((unsigned char)C)) {
820     O << C;
821   } else {
822     switch(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;
828     default:
829       O << '\\';
830       O << toOctal(C >> 6);
831       O << toOctal(C >> 3);
832       O << toOctal(C >> 0);
833       break;
834     }
835   }
836 }
837
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());
843 }
844
845 void AsmPrinter::EmitString(const char *String, unsigned Size) const {
846   const char* AscizDirective = MAI->getAscizDirective();
847   if (AscizDirective)
848     O << AscizDirective;
849   else
850     O << MAI->getAsciiDirective();
851   O << '\"';
852   for (unsigned i = 0; i < Size; ++i)
853     printStringChar(O, String[i]);
854   if (AscizDirective)
855     O << '\"';
856   else
857     O << "\\0\"";
858 }
859
860
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]);
866   O << '\"';
867 }
868
869
870 //===----------------------------------------------------------------------===//
871
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.
879 //
880 // The algorithm is:
881 //     Align = NumBits;
882 //     if (GV && GV->hasalignment) Align = GV->getalignment();
883 //     Align = std::max(Align, ForcedAlignBits);
884 //
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);
891   
892   if (NumBits == 0) return;   // No need to emit alignment.
893   
894   unsigned FillValue = 0;
895   if (getCurrentSection()->getKind().isText())
896     FillValue = MAI->getTextAlignFillValue();
897   
898   OutStreamer.EmitValueToAlignment(1 << NumBits, FillValue, 1, 0);
899 }
900
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)) {
905     O << '0';
906     return;
907   }
908
909   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
910     O << CI->getZExtValue();
911     return;
912   }
913   
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);
918     return;
919   }
920   
921   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
922     O << *GetBlockAddressSymbol(BA);
923     return;
924   }
925   
926   const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
927   if (CE == 0) {
928     llvm_unreachable("Unknown constant value!");
929     O << '0';
930     return;
931   }
932   
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:
942   default:
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],
950                                           idxVec.size());
951     if (Offset == 0)
952       return EmitConstantValueOnly(ptrVal);
953     
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;
958     }
959     
960     if (Offset)
961       O << '(';
962     EmitConstantValueOnly(ptrVal);
963     if (Offset > 0)
964       O << ") + " << Offset;
965     else
966       O << ") - " << -Offset;
967     return;
968   }
969   case Instruction::BitCast:
970     return EmitConstantValueOnly(CE->getOperand(0));
971
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()),
978                                       false/*ZExt*/);
979     return EmitConstantValueOnly(Op);
980   }
981     
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();
988
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);
993
994     O << "((";
995     EmitConstantValueOnly(Op);
996     APInt ptrMask =
997       APInt::getAllOnesValue(TD->getTypeAllocSizeInBits(Op->getType()));
998     
999     SmallString<40> S;
1000     ptrMask.toStringUnsigned(S);
1001     O << ") & " << S.str() << ')';
1002     return;
1003   }
1004       
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));
1011       
1012   case Instruction::Add:
1013   case Instruction::Sub:
1014   case Instruction::And:
1015   case Instruction::Or:
1016   case Instruction::Xor:
1017     O << '(';
1018     EmitConstantValueOnly(CE->getOperand(0));
1019     O << ')';
1020     switch (CE->getOpcode()) {
1021     case Instruction::Add:
1022      O << " + ";
1023      break;
1024     case Instruction::Sub:
1025      O << " - ";
1026      break;
1027     case Instruction::And:
1028      O << " & ";
1029      break;
1030     case Instruction::Or:
1031      O << " | ";
1032      break;
1033     case Instruction::Xor:
1034      O << " ^ ";
1035      break;
1036     default:
1037      break;
1038     }
1039     O << '(';
1040     EmitConstantValueOnly(CE->getOperand(1));
1041     O << ')';
1042     break;
1043   }
1044 }
1045
1046 /// printAsCString - Print the specified array as a C compatible string, only if
1047 /// the predicate isString is true.
1048 ///
1049 static void printAsCString(formatted_raw_ostream &O, const ConstantArray *CVA,
1050                            unsigned LastElt) {
1051   assert(CVA->isString() && "Array is not string compatible!");
1052
1053   O << '\"';
1054   for (unsigned i = 0; i != LastElt; ++i) {
1055     unsigned char C =
1056         (unsigned char)cast<ConstantInt>(CVA->getOperand(i))->getZExtValue();
1057     printStringChar(O, C);
1058   }
1059   O << '\"';
1060 }
1061
1062 /// EmitString - Emit a zero-byte-terminated string constant.
1063 ///
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);
1070   } else {
1071     O << MAI->getAsciiDirective();
1072     printAsCString(O, CVA, NumElts);
1073   }
1074   O << '\n';
1075 }
1076
1077 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
1078                                     AsmPrinter &AP) {
1079   if (AddrSpace == 0 && CA->isString()) {
1080     AP.EmitString(CA);
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);
1084   }
1085 }
1086
1087 static void EmitGlobalConstantVector(const ConstantVector *CV,
1088                                      unsigned AddrSpace, AsmPrinter &AP) {
1089   const VectorType *VTy = CV->getType();
1090   for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i)
1091     AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
1092 }
1093
1094 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
1095                                      unsigned AddrSpace, AsmPrinter &AP) {
1096   // Print the fields in successive locations. Pad to align if needed!
1097   const TargetData *TD = AP.TM.getTargetData();
1098   unsigned Size = TD->getTypeAllocSize(CS->getType());
1099   const StructLayout *Layout = TD->getStructLayout(CS->getType());
1100   uint64_t SizeSoFar = 0;
1101   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1102     const Constant *field = CS->getOperand(i);
1103
1104     // Check if padding is needed and insert one or more 0s.
1105     uint64_t FieldSize = TD->getTypeAllocSize(field->getType());
1106     uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1107                         - Layout->getElementOffset(i)) - FieldSize;
1108     SizeSoFar += FieldSize + PadSize;
1109
1110     // Now print the actual field value.
1111     AP.EmitGlobalConstant(field, AddrSpace);
1112
1113     // Insert padding - this may include padding to increase the size of the
1114     // current field up to the ABI size (if the struct is not packed) as well
1115     // as padding to ensure that the next field starts at the right offset.
1116     AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
1117   }
1118   assert(SizeSoFar == Layout->getSizeInBytes() &&
1119          "Layout of constant struct may be incorrect!");
1120 }
1121
1122 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
1123                                  AsmPrinter &AP) {
1124   // FP Constants are printed as integer constants to avoid losing
1125   // precision.
1126   if (CFP->getType()->isDoubleTy()) {
1127     if (AP.VerboseAsm) {
1128       double Val = CFP->getValueAPF().convertToDouble();  // for comment only
1129       AP.O.PadToColumn(AP.MAI->getCommentColumn());
1130       AP.O << AP.MAI->getCommentString() << " double " << Val << '\n';
1131     }
1132
1133     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1134     AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1135     return;
1136   }
1137   
1138   if (CFP->getType()->isFloatTy()) {
1139     if (AP.VerboseAsm) {
1140       float Val = CFP->getValueAPF().convertToFloat();  // for comment only
1141       AP.O.PadToColumn(AP.MAI->getCommentColumn());
1142       AP.O << AP.MAI->getCommentString() << " float " << Val << '\n';
1143     }
1144     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1145     AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
1146     return;
1147   }
1148   
1149   if (CFP->getType()->isX86_FP80Ty()) {
1150     // all long double variants are printed as hex
1151     // api needed to prevent premature destruction
1152     APInt API = CFP->getValueAPF().bitcastToAPInt();
1153     const uint64_t *p = API.getRawData();
1154     if (AP.VerboseAsm) {
1155       // Convert to double so we can print the approximate val as a comment.
1156       APFloat DoubleVal = CFP->getValueAPF();
1157       bool ignored;
1158       DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1159                         &ignored);
1160       AP.O.PadToColumn(AP.MAI->getCommentColumn());
1161       AP.O << AP.MAI->getCommentString() << " x86_fp80 ~= "
1162            << DoubleVal.convertToDouble() << '\n';
1163     }
1164     
1165     if (AP.TM.getTargetData()->isBigEndian()) {
1166       AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1167       AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1168     } else {
1169       AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1170       AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1171     }
1172     
1173     // Emit the tail padding for the long double.
1174     const TargetData &TD = *AP.TM.getTargetData();
1175     AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
1176                              TD.getTypeStoreSize(CFP->getType()), AddrSpace);
1177     return;
1178   }
1179   
1180   assert(CFP->getType()->isPPC_FP128Ty() &&
1181          "Floating point constant type not handled");
1182   // All long double variants are printed as hex api needed to prevent
1183   // premature destruction.
1184   APInt API = CFP->getValueAPF().bitcastToAPInt();
1185   const uint64_t *p = API.getRawData();
1186   if (AP.TM.getTargetData()->isBigEndian()) {
1187     AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1188     AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1189   } else {
1190     AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1191     AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1192   }
1193 }
1194
1195 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
1196                                        unsigned AddrSpace, AsmPrinter &AP) {
1197   const TargetData *TD = AP.TM.getTargetData();
1198   unsigned BitWidth = CI->getBitWidth();
1199   assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
1200
1201   // We don't expect assemblers to support integer data directives
1202   // for more than 64 bits, so we emit the data in at most 64-bit
1203   // quantities at a time.
1204   const uint64_t *RawData = CI->getValue().getRawData();
1205   for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1206     uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1207     AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1208   }
1209 }
1210
1211 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1212 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1213   if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
1214     uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1215     return OutStreamer.EmitZeros(Size, AddrSpace);
1216   }
1217
1218   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1219     unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1220     switch (Size) {
1221     case 1:
1222     case 2:
1223     case 4:
1224     case 8:
1225       if (VerboseAsm) {
1226         O.PadToColumn(MAI->getCommentColumn());
1227         O << MAI->getCommentString() << " 0x";
1228         O.write_hex(CI->getZExtValue());
1229         O << '\n';
1230       }
1231       OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1232       return;
1233     default:
1234       EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
1235       return;
1236     }
1237   }
1238   
1239   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1240     return EmitGlobalConstantArray(CVA, AddrSpace, *this);
1241   
1242   if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1243     return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
1244
1245   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1246     return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1247   
1248   if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1249     return EmitGlobalConstantVector(V, AddrSpace, *this);
1250
1251   // Otherwise, it must be a ConstantExpr.  Emit the data directive, then emit
1252   // the expression value.
1253   switch (TM.getTargetData()->getTypeAllocSize(CV->getType())) {
1254   case 0: return;
1255   case 1: O << MAI->getData8bitsDirective(AddrSpace); break;
1256   case 2: O << MAI->getData16bitsDirective(AddrSpace); break;
1257   case 4: O << MAI->getData32bitsDirective(AddrSpace); break;
1258   case 8:
1259     if (const char *Dir = MAI->getData64bitsDirective(AddrSpace)) {
1260       O << Dir;
1261       break;
1262     }
1263     // FALL THROUGH.
1264   default:
1265     llvm_unreachable("Target cannot handle given data directive width!");
1266     return;
1267   }
1268   
1269   EmitConstantValueOnly(CV);
1270   O << '\n';
1271 }
1272
1273 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1274   // Target doesn't support this yet!
1275   llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1276 }
1277
1278 /// PrintSpecial - Print information related to the specified machine instr
1279 /// that is independent of the operand, and may be independent of the instr
1280 /// itself.  This can be useful for portably encoding the comment character
1281 /// or other bits of target-specific knowledge into the asmstrings.  The
1282 /// syntax used is ${:comment}.  Targets can override this to add support
1283 /// for their own strange codes.
1284 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1285   if (!strcmp(Code, "private")) {
1286     O << MAI->getPrivateGlobalPrefix();
1287   } else if (!strcmp(Code, "comment")) {
1288     if (VerboseAsm)
1289       O << MAI->getCommentString();
1290   } else if (!strcmp(Code, "uid")) {
1291     // Comparing the address of MI isn't sufficient, because machineinstrs may
1292     // be allocated to the same address across functions.
1293     const Function *ThisF = MI->getParent()->getParent()->getFunction();
1294     
1295     // If this is a new LastFn instruction, bump the counter.
1296     if (LastMI != MI || LastFn != ThisF) {
1297       ++Counter;
1298       LastMI = MI;
1299       LastFn = ThisF;
1300     }
1301     O << Counter;
1302   } else {
1303     std::string msg;
1304     raw_string_ostream Msg(msg);
1305     Msg << "Unknown special formatter '" << Code
1306          << "' for machine instr: " << *MI;
1307     llvm_report_error(Msg.str());
1308   }    
1309 }
1310
1311 /// processDebugLoc - Processes the debug information of each machine
1312 /// instruction's DebugLoc.
1313 void AsmPrinter::processDebugLoc(const MachineInstr *MI, 
1314                                  bool BeforePrintingInsn) {
1315   if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1316       || !DW->ShouldEmitDwarfDebug())
1317     return;
1318   DebugLoc DL = MI->getDebugLoc();
1319   if (DL.isUnknown())
1320     return;
1321   DILocation CurDLT = MF->getDILocation(DL);
1322   if (CurDLT.getScope().isNull())
1323     return;
1324
1325   if (!BeforePrintingInsn) {
1326     // After printing instruction
1327     DW->EndScope(MI);
1328   } else if (CurDLT.getNode() != PrevDLT) {
1329     unsigned L = DW->RecordSourceLine(CurDLT.getLineNumber(), 
1330                                       CurDLT.getColumnNumber(),
1331                                       CurDLT.getScope().getNode());
1332     printLabel(L);
1333     O << '\n';
1334     DW->BeginScope(MI, L);
1335     PrevDLT = CurDLT.getNode();
1336   }
1337 }
1338
1339
1340 /// printInlineAsm - This method formats and prints the specified machine
1341 /// instruction that is an inline asm.
1342 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1343   unsigned NumOperands = MI->getNumOperands();
1344   
1345   // Count the number of register definitions.
1346   unsigned NumDefs = 0;
1347   for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1348        ++NumDefs)
1349     assert(NumDefs != NumOperands-1 && "No asm string?");
1350   
1351   assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1352
1353   // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1354   const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1355
1356   O << '\t';
1357
1358   // If this asmstr is empty, just print the #APP/#NOAPP markers.
1359   // These are useful to see where empty asm's wound up.
1360   if (AsmStr[0] == 0) {
1361     O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1362     O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1363     return;
1364   }
1365   
1366   O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1367
1368   // The variant of the current asmprinter.
1369   int AsmPrinterVariant = MAI->getAssemblerDialect();
1370
1371   int CurVariant = -1;            // The number of the {.|.|.} region we are in.
1372   const char *LastEmitted = AsmStr; // One past the last character emitted.
1373   
1374   while (*LastEmitted) {
1375     switch (*LastEmitted) {
1376     default: {
1377       // Not a special case, emit the string section literally.
1378       const char *LiteralEnd = LastEmitted+1;
1379       while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1380              *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1381         ++LiteralEnd;
1382       if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1383         O.write(LastEmitted, LiteralEnd-LastEmitted);
1384       LastEmitted = LiteralEnd;
1385       break;
1386     }
1387     case '\n':
1388       ++LastEmitted;   // Consume newline character.
1389       O << '\n';       // Indent code with newline.
1390       break;
1391     case '$': {
1392       ++LastEmitted;   // Consume '$' character.
1393       bool Done = true;
1394
1395       // Handle escapes.
1396       switch (*LastEmitted) {
1397       default: Done = false; break;
1398       case '$':     // $$ -> $
1399         if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1400           O << '$';
1401         ++LastEmitted;  // Consume second '$' character.
1402         break;
1403       case '(':             // $( -> same as GCC's { character.
1404         ++LastEmitted;      // Consume '(' character.
1405         if (CurVariant != -1) {
1406           llvm_report_error("Nested variants found in inline asm string: '"
1407                             + std::string(AsmStr) + "'");
1408         }
1409         CurVariant = 0;     // We're in the first variant now.
1410         break;
1411       case '|':
1412         ++LastEmitted;  // consume '|' character.
1413         if (CurVariant == -1)
1414           O << '|';       // this is gcc's behavior for | outside a variant
1415         else
1416           ++CurVariant;   // We're in the next variant.
1417         break;
1418       case ')':         // $) -> same as GCC's } char.
1419         ++LastEmitted;  // consume ')' character.
1420         if (CurVariant == -1)
1421           O << '}';     // this is gcc's behavior for } outside a variant
1422         else 
1423           CurVariant = -1;
1424         break;
1425       }
1426       if (Done) break;
1427       
1428       bool HasCurlyBraces = false;
1429       if (*LastEmitted == '{') {     // ${variable}
1430         ++LastEmitted;               // Consume '{' character.
1431         HasCurlyBraces = true;
1432       }
1433       
1434       // If we have ${:foo}, then this is not a real operand reference, it is a
1435       // "magic" string reference, just like in .td files.  Arrange to call
1436       // PrintSpecial.
1437       if (HasCurlyBraces && *LastEmitted == ':') {
1438         ++LastEmitted;
1439         const char *StrStart = LastEmitted;
1440         const char *StrEnd = strchr(StrStart, '}');
1441         if (StrEnd == 0) {
1442           llvm_report_error("Unterminated ${:foo} operand in inline asm string: '" 
1443                             + std::string(AsmStr) + "'");
1444         }
1445         
1446         std::string Val(StrStart, StrEnd);
1447         PrintSpecial(MI, Val.c_str());
1448         LastEmitted = StrEnd+1;
1449         break;
1450       }
1451             
1452       const char *IDStart = LastEmitted;
1453       char *IDEnd;
1454       errno = 0;
1455       long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1456       if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1457         llvm_report_error("Bad $ operand number in inline asm string: '" 
1458                           + std::string(AsmStr) + "'");
1459       }
1460       LastEmitted = IDEnd;
1461       
1462       char Modifier[2] = { 0, 0 };
1463       
1464       if (HasCurlyBraces) {
1465         // If we have curly braces, check for a modifier character.  This
1466         // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1467         if (*LastEmitted == ':') {
1468           ++LastEmitted;    // Consume ':' character.
1469           if (*LastEmitted == 0) {
1470             llvm_report_error("Bad ${:} expression in inline asm string: '" 
1471                               + std::string(AsmStr) + "'");
1472           }
1473           
1474           Modifier[0] = *LastEmitted;
1475           ++LastEmitted;    // Consume modifier character.
1476         }
1477         
1478         if (*LastEmitted != '}') {
1479           llvm_report_error("Bad ${} expression in inline asm string: '" 
1480                             + std::string(AsmStr) + "'");
1481         }
1482         ++LastEmitted;    // Consume '}' character.
1483       }
1484       
1485       if ((unsigned)Val >= NumOperands-1) {
1486         llvm_report_error("Invalid $ operand number in inline asm string: '" 
1487                           + std::string(AsmStr) + "'");
1488       }
1489       
1490       // Okay, we finally have a value number.  Ask the target to print this
1491       // operand!
1492       if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1493         unsigned OpNo = 1;
1494
1495         bool Error = false;
1496
1497         // Scan to find the machine operand number for the operand.
1498         for (; Val; --Val) {
1499           if (OpNo >= MI->getNumOperands()) break;
1500           unsigned OpFlags = MI->getOperand(OpNo).getImm();
1501           OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1502         }
1503
1504         if (OpNo >= MI->getNumOperands()) {
1505           Error = true;
1506         } else {
1507           unsigned OpFlags = MI->getOperand(OpNo).getImm();
1508           ++OpNo;  // Skip over the ID number.
1509
1510           if (Modifier[0] == 'l')  // labels are target independent
1511             O << *GetMBBSymbol(MI->getOperand(OpNo).getMBB()->getNumber());
1512           else {
1513             AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1514             if ((OpFlags & 7) == 4) {
1515               Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1516                                                 Modifier[0] ? Modifier : 0);
1517             } else {
1518               Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1519                                           Modifier[0] ? Modifier : 0);
1520             }
1521           }
1522         }
1523         if (Error) {
1524           std::string msg;
1525           raw_string_ostream Msg(msg);
1526           Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1527           MI->print(Msg);
1528           llvm_report_error(Msg.str());
1529         }
1530       }
1531       break;
1532     }
1533     }
1534   }
1535   O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1536 }
1537
1538 /// printImplicitDef - This method prints the specified machine instruction
1539 /// that is an implicit def.
1540 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1541   if (!VerboseAsm) return;
1542   O.PadToColumn(MAI->getCommentColumn());
1543   O << MAI->getCommentString() << " implicit-def: "
1544     << TRI->getName(MI->getOperand(0).getReg());
1545 }
1546
1547 void AsmPrinter::printKill(const MachineInstr *MI) const {
1548   if (!VerboseAsm) return;
1549   O.PadToColumn(MAI->getCommentColumn());
1550   O << MAI->getCommentString() << " kill:";
1551   for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1552     const MachineOperand &op = MI->getOperand(n);
1553     assert(op.isReg() && "KILL instruction must have only register operands");
1554     O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1555   }
1556 }
1557
1558 /// printLabel - This method prints a local label used by debug and
1559 /// exception handling tables.
1560 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1561   printLabel(MI->getOperand(0).getImm());
1562 }
1563
1564 void AsmPrinter::printLabel(unsigned Id) const {
1565   O << MAI->getPrivateGlobalPrefix() << "label" << Id << ':';
1566 }
1567
1568 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1569 /// instruction, using the specified assembler variant.  Targets should
1570 /// override this to format as appropriate.
1571 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1572                                  unsigned AsmVariant, const char *ExtraCode) {
1573   // Target doesn't support this yet!
1574   return true;
1575 }
1576
1577 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1578                                        unsigned AsmVariant,
1579                                        const char *ExtraCode) {
1580   // Target doesn't support this yet!
1581   return true;
1582 }
1583
1584 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA,
1585                                             const char *Suffix) const {
1586   return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock(), Suffix);
1587 }
1588
1589 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1590                                             const BasicBlock *BB,
1591                                             const char *Suffix) const {
1592   assert(BB->hasName() &&
1593          "Address of anonymous basic block not supported yet!");
1594
1595   // This code must use the function name itself, and not the function number,
1596   // since it must be possible to generate the label name from within other
1597   // functions.
1598   SmallString<60> FnName;
1599   Mang->getNameWithPrefix(FnName, F, false);
1600
1601   // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1602   SmallString<60> NameResult;
1603   Mang->getNameWithPrefix(NameResult,
1604                           StringRef("BA") + Twine((unsigned)FnName.size()) + 
1605                           "_" + FnName.str() + "_" + BB->getName() + Suffix, 
1606                           Mangler::Private);
1607
1608   return OutContext.GetOrCreateSymbol(NameResult.str());
1609 }
1610
1611 MCSymbol *AsmPrinter::GetMBBSymbol(unsigned MBBID) const {
1612   SmallString<60> Name;
1613   raw_svector_ostream(Name) << MAI->getPrivateGlobalPrefix() << "BB"
1614     << getFunctionNumber() << '_' << MBBID;
1615   
1616   return OutContext.GetOrCreateSymbol(Name.str());
1617 }
1618
1619 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
1620 /// value.
1621 MCSymbol *AsmPrinter::GetGlobalValueSymbol(const GlobalValue *GV) const {
1622   SmallString<60> NameStr;
1623   Mang->getNameWithPrefix(NameStr, GV, false);
1624   return OutContext.GetOrCreateSymbol(NameStr.str());
1625 }
1626
1627 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1628 /// global value name as its base, with the specified suffix, and where the
1629 /// symbol is forced to have private linkage if ForcePrivate is true.
1630 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1631                                                    StringRef Suffix,
1632                                                    bool ForcePrivate) const {
1633   SmallString<60> NameStr;
1634   Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1635   NameStr.append(Suffix.begin(), Suffix.end());
1636   return OutContext.GetOrCreateSymbol(NameStr.str());
1637 }
1638
1639 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1640 /// ExternalSymbol.
1641 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1642   SmallString<60> NameStr;
1643   Mang->getNameWithPrefix(NameStr, Sym);
1644   return OutContext.GetOrCreateSymbol(NameStr.str());
1645 }  
1646
1647
1648 /// EmitBasicBlockStart - This method prints the label for the specified
1649 /// MachineBasicBlock, an alignment (if present) and a comment describing
1650 /// it if appropriate.
1651 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1652   // Emit an alignment directive for this block, if needed.
1653   if (unsigned Align = MBB->getAlignment())
1654     EmitAlignment(Log2_32(Align));
1655
1656   // If the block has its address taken, emit a special label to satisfy
1657   // references to the block. This is done so that we don't need to
1658   // remember the number of this label, and so that we can make
1659   // forward references to labels without knowing what their numbers
1660   // will be.
1661   if (MBB->hasAddressTaken()) {
1662     const BasicBlock *BB = MBB->getBasicBlock();
1663     OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1664     if (VerboseAsm) {
1665       O.PadToColumn(MAI->getCommentColumn());
1666       O << MAI->getCommentString() << " Address Taken" << '\n';
1667     }
1668   }
1669
1670   // Print the main label for the block.
1671   if (MBB->pred_empty() || MBB->isOnlyReachableByFallthrough()) {
1672     if (VerboseAsm)
1673       O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1674   } else {
1675     OutStreamer.EmitLabel(GetMBBSymbol(MBB->getNumber()));
1676   }
1677   
1678   // Print some comments to accompany the label.
1679   if (VerboseAsm) {
1680     if (const BasicBlock *BB = MBB->getBasicBlock())
1681       if (BB->hasName()) {
1682         O.PadToColumn(MAI->getCommentColumn());
1683         O << MAI->getCommentString() << ' ';
1684         WriteAsOperand(O, BB, /*PrintType=*/false);
1685       }
1686
1687     EmitComments(*MBB);
1688     O << '\n';
1689   }
1690 }
1691
1692 /// printPICJumpTableSetLabel - This method prints a set label for the
1693 /// specified MachineBasicBlock for a jumptable entry.
1694 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid, 
1695                                            const MachineBasicBlock *MBB) const {
1696   if (!MAI->getSetDirective())
1697     return;
1698   
1699   O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1700     << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ','
1701     << *GetMBBSymbol(MBB->getNumber())
1702     << '-' << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber() 
1703     << '_' << uid << '\n';
1704 }
1705
1706 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
1707                                            const MachineBasicBlock *MBB) const {
1708   if (!MAI->getSetDirective())
1709     return;
1710   
1711   O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
1712     << getFunctionNumber() << '_' << uid << '_' << uid2
1713     << "_set_" << MBB->getNumber() << ','
1714     << *GetMBBSymbol(MBB->getNumber())
1715     << '-' << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber() 
1716     << '_' << uid << '_' << uid2 << '\n';
1717 }
1718
1719 void AsmPrinter::printVisibility(const MCSymbol *Sym,
1720                                  unsigned Visibility) const {
1721   if (Visibility == GlobalValue::HiddenVisibility) {
1722     if (const char *Directive = MAI->getHiddenDirective())
1723       O << Directive << *Sym << '\n';
1724   } else if (Visibility == GlobalValue::ProtectedVisibility) {
1725     if (const char *Directive = MAI->getProtectedDirective())
1726       O << Directive << *Sym << '\n';
1727   }
1728 }
1729
1730 void AsmPrinter::printOffset(int64_t Offset) const {
1731   if (Offset > 0)
1732     O << '+' << Offset;
1733   else if (Offset < 0)
1734     O << Offset;
1735 }
1736
1737 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1738   if (!S->usesMetadata())
1739     return 0;
1740   
1741   gcp_iterator GCPI = GCMetadataPrinters.find(S);
1742   if (GCPI != GCMetadataPrinters.end())
1743     return GCPI->second;
1744   
1745   const char *Name = S->getName().c_str();
1746   
1747   for (GCMetadataPrinterRegistry::iterator
1748          I = GCMetadataPrinterRegistry::begin(),
1749          E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1750     if (strcmp(Name, I->getName()) == 0) {
1751       GCMetadataPrinter *GMP = I->instantiate();
1752       GMP->S = S;
1753       GCMetadataPrinters.insert(std::make_pair(S, GMP));
1754       return GMP;
1755     }
1756   
1757   errs() << "no GCMetadataPrinter registered for GC: " << Name << "\n";
1758   llvm_unreachable(0);
1759 }
1760
1761 /// EmitComments - Pretty-print comments for instructions
1762 void AsmPrinter::EmitComments(const MachineInstr &MI) const {
1763   if (!VerboseAsm)
1764     return;
1765
1766   bool Newline = false;
1767
1768   if (!MI.getDebugLoc().isUnknown()) {
1769     DILocation DLT = MF->getDILocation(MI.getDebugLoc());
1770
1771     // Print source line info.
1772     O.PadToColumn(MAI->getCommentColumn());
1773     O << MAI->getCommentString() << ' ';
1774     DIScope Scope = DLT.getScope();
1775     // Omit the directory, because it's likely to be long and uninteresting.
1776     if (!Scope.isNull())
1777       O << Scope.getFilename();
1778     else
1779       O << "<unknown>";
1780     O << ':' << DLT.getLineNumber();
1781     if (DLT.getColumnNumber() != 0)
1782       O << ':' << DLT.getColumnNumber();
1783     Newline = true;
1784   }
1785
1786   // Check for spills and reloads
1787   int FI;
1788
1789   const MachineFrameInfo *FrameInfo =
1790     MI.getParent()->getParent()->getFrameInfo();
1791
1792   // We assume a single instruction only has a spill or reload, not
1793   // both.
1794   const MachineMemOperand *MMO;
1795   if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
1796     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1797       MMO = *MI.memoperands_begin();
1798       if (Newline) O << '\n';
1799       O.PadToColumn(MAI->getCommentColumn());
1800       O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Reload";
1801       Newline = true;
1802     }
1803   }
1804   else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
1805     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1806       if (Newline) O << '\n';
1807       O.PadToColumn(MAI->getCommentColumn());
1808       O << MAI->getCommentString() << ' '
1809         << MMO->getSize() << "-byte Folded Reload";
1810       Newline = true;
1811     }
1812   }
1813   else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
1814     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1815       MMO = *MI.memoperands_begin();
1816       if (Newline) O << '\n';
1817       O.PadToColumn(MAI->getCommentColumn());
1818       O << MAI->getCommentString() << ' ' << MMO->getSize() << "-byte Spill";
1819       Newline = true;
1820     }
1821   }
1822   else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
1823     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
1824       if (Newline) O << '\n';
1825       O.PadToColumn(MAI->getCommentColumn());
1826       O << MAI->getCommentString() << ' '
1827         << MMO->getSize() << "-byte Folded Spill";
1828       Newline = true;
1829     }
1830   }
1831
1832   // Check for spill-induced copies
1833   unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1834   if (TM.getInstrInfo()->isMoveInstr(MI, SrcReg, DstReg,
1835                                       SrcSubIdx, DstSubIdx)) {
1836     if (MI.getAsmPrinterFlag(ReloadReuse)) {
1837       if (Newline) O << '\n';
1838       O.PadToColumn(MAI->getCommentColumn());
1839       O << MAI->getCommentString() << " Reload Reuse";
1840     }
1841   }
1842 }
1843
1844 /// PrintChildLoopComment - Print comments about child loops within
1845 /// the loop for this basic block, with nesting.
1846 ///
1847 static void PrintChildLoopComment(formatted_raw_ostream &O,
1848                                   const MachineLoop *loop,
1849                                   const MCAsmInfo *MAI,
1850                                   int FunctionNumber) {
1851   // Add child loop information
1852   for(MachineLoop::iterator cl = loop->begin(),
1853         clend = loop->end();
1854       cl != clend;
1855       ++cl) {
1856     MachineBasicBlock *Header = (*cl)->getHeader();
1857     assert(Header && "No header for loop");
1858
1859     O << '\n';
1860     O.PadToColumn(MAI->getCommentColumn());
1861
1862     O << MAI->getCommentString();
1863     O.indent(((*cl)->getLoopDepth()-1)*2)
1864       << " Child Loop BB" << FunctionNumber << "_"
1865       << Header->getNumber() << " Depth " << (*cl)->getLoopDepth();
1866
1867     PrintChildLoopComment(O, *cl, MAI, FunctionNumber);
1868   }
1869 }
1870
1871 /// EmitComments - Pretty-print comments for basic blocks
1872 void AsmPrinter::EmitComments(const MachineBasicBlock &MBB) const {
1873   if (VerboseAsm) {
1874     // Add loop depth information
1875     const MachineLoop *loop = LI->getLoopFor(&MBB);
1876
1877     if (loop) {
1878       // Print a newline after bb# annotation.
1879       O << "\n";
1880       O.PadToColumn(MAI->getCommentColumn());
1881       O << MAI->getCommentString() << " Loop Depth " << loop->getLoopDepth()
1882         << '\n';
1883
1884       O.PadToColumn(MAI->getCommentColumn());
1885
1886       MachineBasicBlock *Header = loop->getHeader();
1887       assert(Header && "No header for loop");
1888       
1889       if (Header == &MBB) {
1890         O << MAI->getCommentString() << " Loop Header";
1891         PrintChildLoopComment(O, loop, MAI, getFunctionNumber());
1892       }
1893       else {
1894         O << MAI->getCommentString() << " Loop Header is BB"
1895           << getFunctionNumber() << "_" << loop->getHeader()->getNumber();
1896       }
1897
1898       if (loop->empty()) {
1899         O << '\n';
1900         O.PadToColumn(MAI->getCommentColumn());
1901         O << MAI->getCommentString() << " Inner Loop";
1902       }
1903
1904       // Add parent loop information
1905       for (const MachineLoop *CurLoop = loop->getParentLoop();
1906            CurLoop;
1907            CurLoop = CurLoop->getParentLoop()) {
1908         MachineBasicBlock *Header = CurLoop->getHeader();
1909         assert(Header && "No header for loop");
1910
1911         O << '\n';
1912         O.PadToColumn(MAI->getCommentColumn());
1913         O << MAI->getCommentString();
1914         O.indent((CurLoop->getLoopDepth()-1)*2)
1915           << " Inside Loop BB" << getFunctionNumber() << "_"
1916           << Header->getNumber() << " Depth " << CurLoop->getLoopDepth();
1917       }
1918     }
1919   }
1920 }