f740c7400bc84636f15ea6e1d481af14450c5ea0
[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 #define DEBUG_TYPE "asm-printer"
15 #include "llvm/CodeGen/AsmPrinter.h"
16 #include "DwarfDebug.h"
17 #include "DwarfException.h"
18 #include "llvm/Module.h"
19 #include "llvm/CodeGen/GCMetadataPrinter.h"
20 #include "llvm/CodeGen/MachineConstantPool.h"
21 #include "llvm/CodeGen/MachineFrameInfo.h"
22 #include "llvm/CodeGen/MachineFunction.h"
23 #include "llvm/CodeGen/MachineJumpTableInfo.h"
24 #include "llvm/CodeGen/MachineLoopInfo.h"
25 #include "llvm/CodeGen/MachineModuleInfo.h"
26 #include "llvm/Analysis/ConstantFolding.h"
27 #include "llvm/Analysis/DebugInfo.h"
28 #include "llvm/MC/MCAsmInfo.h"
29 #include "llvm/MC/MCContext.h"
30 #include "llvm/MC/MCExpr.h"
31 #include "llvm/MC/MCInst.h"
32 #include "llvm/MC/MCSection.h"
33 #include "llvm/MC/MCStreamer.h"
34 #include "llvm/MC/MCSymbol.h"
35 #include "llvm/Target/Mangler.h"
36 #include "llvm/Target/TargetData.h"
37 #include "llvm/Target/TargetInstrInfo.h"
38 #include "llvm/Target/TargetLowering.h"
39 #include "llvm/Target/TargetLoweringObjectFile.h"
40 #include "llvm/Target/TargetRegisterInfo.h"
41 #include "llvm/Assembly/Writer.h"
42 #include "llvm/ADT/SmallString.h"
43 #include "llvm/ADT/Statistic.h"
44 #include "llvm/Support/ErrorHandling.h"
45 #include "llvm/Support/Format.h"
46 #include "llvm/Support/Timer.h"
47 using namespace llvm;
48
49 static const char *DWARFGroupName = "DWARF Emission";
50 static const char *DbgTimerName = "DWARF Debug Writer";
51 static const char *EHTimerName = "DWARF Exception Writer";
52
53 STATISTIC(EmittedInsts, "Number of machine instrs printed");
54
55 char AsmPrinter::ID = 0;
56
57 typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
58 static gcp_map_type &getGCMap(void *&P) {
59   if (P == 0)
60     P = new gcp_map_type();
61   return *(gcp_map_type*)P;
62 }
63
64
65 /// getGVAlignmentLog2 - Return the alignment to use for the specified global
66 /// value in log2 form.  This rounds up to the preferred alignment if possible
67 /// and legal.
68 static unsigned getGVAlignmentLog2(const GlobalValue *GV, const TargetData &TD,
69                                    unsigned InBits = 0) {
70   unsigned NumBits = 0;
71   if (const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV))
72     NumBits = TD.getPreferredAlignmentLog(GVar);
73   
74   // If InBits is specified, round it to it.
75   if (InBits > NumBits)
76     NumBits = InBits;
77   
78   // If the GV has a specified alignment, take it into account.
79   if (GV->getAlignment() == 0)
80     return NumBits;
81   
82   unsigned GVAlign = Log2_32(GV->getAlignment());
83   
84   // If the GVAlign is larger than NumBits, or if we are required to obey
85   // NumBits because the GV has an assigned section, obey it.
86   if (GVAlign > NumBits || GV->hasSection())
87     NumBits = GVAlign;
88   return NumBits;
89 }
90
91
92
93
94 AsmPrinter::AsmPrinter(TargetMachine &tm, MCStreamer &Streamer)
95   : MachineFunctionPass(ID),
96     TM(tm), MAI(tm.getMCAsmInfo()),
97     OutContext(Streamer.getContext()),
98     OutStreamer(Streamer),
99     LastMI(0), LastFn(0), Counter(~0U), SetCounter(0) {
100   DD = 0; DE = 0; MMI = 0; LI = 0;
101   GCMetadataPrinters = 0;
102   VerboseAsm = Streamer.isVerboseAsm();
103 }
104
105 AsmPrinter::~AsmPrinter() {
106   assert(DD == 0 && DE == 0 && "Debug/EH info didn't get finalized");
107   
108   if (GCMetadataPrinters != 0) {
109     gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
110     
111     for (gcp_map_type::iterator I = GCMap.begin(), E = GCMap.end(); I != E; ++I)
112       delete I->second;
113     delete &GCMap;
114     GCMetadataPrinters = 0;
115   }
116   
117   delete &OutStreamer;
118 }
119
120 /// getFunctionNumber - Return a unique ID for the current function.
121 ///
122 unsigned AsmPrinter::getFunctionNumber() const {
123   return MF->getFunctionNumber();
124 }
125
126 const TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
127   return TM.getTargetLowering()->getObjFileLowering();
128 }
129
130
131 /// getTargetData - Return information about data layout.
132 const TargetData &AsmPrinter::getTargetData() const {
133   return *TM.getTargetData();
134 }
135
136 /// getCurrentSection() - Return the current section we are emitting to.
137 const MCSection *AsmPrinter::getCurrentSection() const {
138   return OutStreamer.getCurrentSection();
139 }
140
141
142
143 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
144   AU.setPreservesAll();
145   MachineFunctionPass::getAnalysisUsage(AU);
146   AU.addRequired<MachineModuleInfo>();
147   AU.addRequired<GCModuleInfo>();
148   if (isVerbose())
149     AU.addRequired<MachineLoopInfo>();
150 }
151
152 bool AsmPrinter::doInitialization(Module &M) {
153   MMI = getAnalysisIfAvailable<MachineModuleInfo>();
154   MMI->AnalyzeModule(M);
155
156   // Initialize TargetLoweringObjectFile.
157   const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
158     .Initialize(OutContext, TM);
159   
160   Mang = new Mangler(OutContext, *TM.getTargetData());
161   
162   // Allow the target to emit any magic that it wants at the start of the file.
163   EmitStartOfAsmFile(M);
164
165   // Very minimal debug info. It is ignored if we emit actual debug info. If we
166   // don't, this at least helps the user find where a global came from.
167   if (MAI->hasSingleParameterDotFile()) {
168     // .file "foo.c"
169     OutStreamer.EmitFileDirective(M.getModuleIdentifier());
170   }
171
172   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
173   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
174   for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
175     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
176       MP->beginAssembly(*this);
177
178   // Emit module-level inline asm if it exists.
179   if (!M.getModuleInlineAsm().empty()) {
180     OutStreamer.AddComment("Start of file scope inline assembly");
181     OutStreamer.AddBlankLine();
182     EmitInlineAsm(M.getModuleInlineAsm()+"\n");
183     OutStreamer.AddComment("End of file scope inline assembly");
184     OutStreamer.AddBlankLine();
185   }
186
187   if (MAI->doesSupportDebugInformation())
188     DD = new DwarfDebug(this, &M);
189
190   if (MAI->doesSupportExceptionHandling())
191     switch (MAI->getExceptionHandlingType()) {
192     default:
193     case ExceptionHandling::DwarfTable:
194       DE = new DwarfTableException(this);
195       break;
196     case ExceptionHandling::DwarfCFI:
197       DE = new DwarfCFIException(this);
198       break;
199     case ExceptionHandling::ARM:
200       DE = new ARMException(this);
201       break;
202     }
203
204   return false;
205 }
206
207 void AsmPrinter::EmitLinkage(unsigned Linkage, MCSymbol *GVSym) const {
208   switch ((GlobalValue::LinkageTypes)Linkage) {
209   case GlobalValue::CommonLinkage:
210   case GlobalValue::LinkOnceAnyLinkage:
211   case GlobalValue::LinkOnceODRLinkage:
212   case GlobalValue::WeakAnyLinkage:
213   case GlobalValue::WeakODRLinkage:
214   case GlobalValue::LinkerPrivateWeakLinkage:
215   case GlobalValue::LinkerPrivateWeakDefAutoLinkage:
216     if (MAI->getWeakDefDirective() != 0) {
217       // .globl _foo
218       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
219
220       if ((GlobalValue::LinkageTypes)Linkage !=
221           GlobalValue::LinkerPrivateWeakDefAutoLinkage)
222         // .weak_definition _foo
223         OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
224       else
225         OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefAutoPrivate);
226     } else if (MAI->getLinkOnceDirective() != 0) {
227       // .globl _foo
228       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
229       //NOTE: linkonce is handled by the section the symbol was assigned to.
230     } else {
231       // .weak _foo
232       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
233     }
234     break;
235   case GlobalValue::DLLExportLinkage:
236   case GlobalValue::AppendingLinkage:
237     // FIXME: appending linkage variables should go into a section of
238     // their name or something.  For now, just emit them as external.
239   case GlobalValue::ExternalLinkage:
240     // If external or appending, declare as a global symbol.
241     // .globl _foo
242     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
243     break;
244   case GlobalValue::PrivateLinkage:
245   case GlobalValue::InternalLinkage:
246   case GlobalValue::LinkerPrivateLinkage:
247     break;
248   default:
249     llvm_unreachable("Unknown linkage type!");
250   }
251 }
252
253
254 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
255 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
256   if (!GV->hasInitializer())   // External globals require no code.
257     return;
258   
259   // Check to see if this is a special global used by LLVM, if so, emit it.
260   if (EmitSpecialLLVMGlobal(GV))
261     return;
262
263   if (isVerbose()) {
264     WriteAsOperand(OutStreamer.GetCommentOS(), GV,
265                    /*PrintType=*/false, GV->getParent());
266     OutStreamer.GetCommentOS() << '\n';
267   }
268   
269   MCSymbol *GVSym = Mang->getSymbol(GV);
270   EmitVisibility(GVSym, GV->getVisibility());
271
272   if (MAI->hasDotTypeDotSizeDirective())
273     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
274   
275   SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
276
277   const TargetData *TD = TM.getTargetData();
278   uint64_t Size = TD->getTypeAllocSize(GV->getType()->getElementType());
279   
280   // If the alignment is specified, we *must* obey it.  Overaligning a global
281   // with a specified alignment is a prompt way to break globals emitted to
282   // sections and expected to be contiguous (e.g. ObjC metadata).
283   unsigned AlignLog = getGVAlignmentLog2(GV, *TD);
284   
285   // Handle common and BSS local symbols (.lcomm).
286   if (GVKind.isCommon() || GVKind.isBSSLocal()) {
287     if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
288     
289     if (isVerbose()) {
290       WriteAsOperand(OutStreamer.GetCommentOS(), GV,
291                      /*PrintType=*/false, GV->getParent());
292       OutStreamer.GetCommentOS() << '\n';
293     }
294     
295     // Handle common symbols.
296     if (GVKind.isCommon()) {
297       unsigned Align = 1 << AlignLog;
298       if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
299         Align = 0;
300           
301       // .comm _foo, 42, 4
302       OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
303       return;
304     }
305     
306     // Handle local BSS symbols.
307     if (MAI->hasMachoZeroFillDirective()) {
308       const MCSection *TheSection =
309         getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
310       // .zerofill __DATA, __bss, _foo, 400, 5
311       OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
312       return;
313     }
314     
315     if (MAI->hasLCOMMDirective()) {
316       // .lcomm _foo, 42
317       OutStreamer.EmitLocalCommonSymbol(GVSym, Size);
318       return;
319     }
320
321     unsigned Align = 1 << AlignLog;
322     if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
323       Align = 0;
324     
325     // .local _foo
326     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
327     // .comm _foo, 42, 4
328     OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
329     return;
330   }
331   
332   const MCSection *TheSection =
333     getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
334
335   // Handle the zerofill directive on darwin, which is a special form of BSS
336   // emission.
337   if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
338     if (Size == 0) Size = 1;  // zerofill of 0 bytes is undefined.
339     
340     // .globl _foo
341     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
342     // .zerofill __DATA, __common, _foo, 400, 5
343     OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
344     return;
345   }
346   
347   // Handle thread local data for mach-o which requires us to output an
348   // additional structure of data and mangle the original symbol so that we
349   // can reference it later.
350   //
351   // TODO: This should become an "emit thread local global" method on TLOF.
352   // All of this macho specific stuff should be sunk down into TLOFMachO and
353   // stuff like "TLSExtraDataSection" should no longer be part of the parent
354   // TLOF class.  This will also make it more obvious that stuff like
355   // MCStreamer::EmitTBSSSymbol is macho specific and only called from macho
356   // specific code.
357   if (GVKind.isThreadLocal() && MAI->hasMachoTBSSDirective()) {
358     // Emit the .tbss symbol
359     MCSymbol *MangSym = 
360       OutContext.GetOrCreateSymbol(GVSym->getName() + Twine("$tlv$init"));
361     
362     if (GVKind.isThreadBSS())
363       OutStreamer.EmitTBSSSymbol(TheSection, MangSym, Size, 1 << AlignLog);
364     else if (GVKind.isThreadData()) {
365       OutStreamer.SwitchSection(TheSection);
366
367       EmitAlignment(AlignLog, GV);      
368       OutStreamer.EmitLabel(MangSym);
369       
370       EmitGlobalConstant(GV->getInitializer());
371     }
372     
373     OutStreamer.AddBlankLine();
374     
375     // Emit the variable struct for the runtime.
376     const MCSection *TLVSect 
377       = getObjFileLowering().getTLSExtraDataSection();
378       
379     OutStreamer.SwitchSection(TLVSect);
380     // Emit the linkage here.
381     EmitLinkage(GV->getLinkage(), GVSym);
382     OutStreamer.EmitLabel(GVSym);
383     
384     // Three pointers in size:
385     //   - __tlv_bootstrap - used to make sure support exists
386     //   - spare pointer, used when mapped by the runtime
387     //   - pointer to mangled symbol above with initializer
388     unsigned PtrSize = TD->getPointerSizeInBits()/8;
389     OutStreamer.EmitSymbolValue(GetExternalSymbolSymbol("_tlv_bootstrap"),
390                           PtrSize, 0);
391     OutStreamer.EmitIntValue(0, PtrSize, 0);
392     OutStreamer.EmitSymbolValue(MangSym, PtrSize, 0);
393     
394     OutStreamer.AddBlankLine();
395     return;
396   }
397
398   OutStreamer.SwitchSection(TheSection);
399
400   EmitLinkage(GV->getLinkage(), GVSym);
401   EmitAlignment(AlignLog, GV);
402
403   OutStreamer.EmitLabel(GVSym);
404
405   EmitGlobalConstant(GV->getInitializer());
406
407   if (MAI->hasDotTypeDotSizeDirective())
408     // .size foo, 42
409     OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
410   
411   OutStreamer.AddBlankLine();
412 }
413
414 /// EmitFunctionHeader - This method emits the header for the current
415 /// function.
416 void AsmPrinter::EmitFunctionHeader() {
417   // Print out constants referenced by the function
418   EmitConstantPool();
419   
420   // Print the 'header' of function.
421   const Function *F = MF->getFunction();
422
423   OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang, TM));
424   EmitVisibility(CurrentFnSym, F->getVisibility());
425
426   EmitLinkage(F->getLinkage(), CurrentFnSym);
427   EmitAlignment(MF->getAlignment(), F);
428
429   if (MAI->hasDotTypeDotSizeDirective())
430     OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
431
432   if (isVerbose()) {
433     WriteAsOperand(OutStreamer.GetCommentOS(), F,
434                    /*PrintType=*/false, F->getParent());
435     OutStreamer.GetCommentOS() << '\n';
436   }
437
438   // Emit the CurrentFnSym.  This is a virtual function to allow targets to
439   // do their wild and crazy things as required.
440   EmitFunctionEntryLabel();
441   
442   // If the function had address-taken blocks that got deleted, then we have
443   // references to the dangling symbols.  Emit them at the start of the function
444   // so that we don't get references to undefined symbols.
445   std::vector<MCSymbol*> DeadBlockSyms;
446   MMI->takeDeletedSymbolsForFunction(F, DeadBlockSyms);
447   for (unsigned i = 0, e = DeadBlockSyms.size(); i != e; ++i) {
448     OutStreamer.AddComment("Address taken block that was later removed");
449     OutStreamer.EmitLabel(DeadBlockSyms[i]);
450   }
451   
452   // Add some workaround for linkonce linkage on Cygwin\MinGW.
453   if (MAI->getLinkOnceDirective() != 0 &&
454       (F->hasLinkOnceLinkage() || F->hasWeakLinkage())) {
455     // FIXME: What is this?
456     MCSymbol *FakeStub = 
457       OutContext.GetOrCreateSymbol(Twine("Lllvm$workaround$fake$stub$")+
458                                    CurrentFnSym->getName());
459     OutStreamer.EmitLabel(FakeStub);
460   }
461   
462   // Emit pre-function debug and/or EH information.
463   if (DE) {
464     NamedRegionTimer T(EHTimerName, DWARFGroupName, TimePassesIsEnabled);
465     DE->BeginFunction(MF);
466   }
467   if (DD) {
468     NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
469     DD->beginFunction(MF);
470   }
471 }
472
473 /// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the
474 /// function.  This can be overridden by targets as required to do custom stuff.
475 void AsmPrinter::EmitFunctionEntryLabel() {
476   // The function label could have already been emitted if two symbols end up
477   // conflicting due to asm renaming.  Detect this and emit an error.
478   if (CurrentFnSym->isUndefined())
479     return OutStreamer.EmitLabel(CurrentFnSym);
480
481   report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
482                      "' label emitted multiple times to assembly file");
483 }
484
485
486 static void EmitDebugLoc(DebugLoc DL, const MachineFunction *MF, 
487                          raw_ostream &CommentOS) {
488   const LLVMContext &Ctx = MF->getFunction()->getContext();
489   if (!DL.isUnknown()) {          // Print source line info.
490     DIScope Scope(DL.getScope(Ctx));
491     // Omit the directory, because it's likely to be long and uninteresting.
492     if (Scope.Verify())
493       CommentOS << Scope.getFilename();
494     else
495       CommentOS << "<unknown>";
496     CommentOS << ':' << DL.getLine();
497     if (DL.getCol() != 0)
498       CommentOS << ':' << DL.getCol();
499     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
500     if (!InlinedAtDL.isUnknown()) {
501       CommentOS << "[ ";
502       EmitDebugLoc(InlinedAtDL, MF, CommentOS);
503       CommentOS << " ]";
504     }
505   }
506 }
507
508 /// EmitComments - Pretty-print comments for instructions.
509 static void EmitComments(const MachineInstr &MI, raw_ostream &CommentOS) {
510   const MachineFunction *MF = MI.getParent()->getParent();
511   const TargetMachine &TM = MF->getTarget();
512   
513   DebugLoc DL = MI.getDebugLoc();
514   if (!DL.isUnknown()) {          // Print source line info.
515     EmitDebugLoc(DL, MF, CommentOS);
516     CommentOS << '\n';
517   }
518   
519   // Check for spills and reloads
520   int FI;
521   
522   const MachineFrameInfo *FrameInfo = MF->getFrameInfo();
523   
524   // We assume a single instruction only has a spill or reload, not
525   // both.
526   const MachineMemOperand *MMO;
527   if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
528     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
529       MMO = *MI.memoperands_begin();
530       CommentOS << MMO->getSize() << "-byte Reload\n";
531     }
532   } else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
533     if (FrameInfo->isSpillSlotObjectIndex(FI))
534       CommentOS << MMO->getSize() << "-byte Folded Reload\n";
535   } else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
536     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
537       MMO = *MI.memoperands_begin();
538       CommentOS << MMO->getSize() << "-byte Spill\n";
539     }
540   } else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
541     if (FrameInfo->isSpillSlotObjectIndex(FI))
542       CommentOS << MMO->getSize() << "-byte Folded Spill\n";
543   }
544   
545   // Check for spill-induced copies
546   if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse))
547     CommentOS << " Reload Reuse\n";
548 }
549
550 /// EmitImplicitDef - This method emits the specified machine instruction
551 /// that is an implicit def.
552 static void EmitImplicitDef(const MachineInstr *MI, AsmPrinter &AP) {
553   unsigned RegNo = MI->getOperand(0).getReg();
554   AP.OutStreamer.AddComment(Twine("implicit-def: ") +
555                             AP.TM.getRegisterInfo()->getName(RegNo));
556   AP.OutStreamer.AddBlankLine();
557 }
558
559 static void EmitKill(const MachineInstr *MI, AsmPrinter &AP) {
560   std::string Str = "kill:";
561   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
562     const MachineOperand &Op = MI->getOperand(i);
563     assert(Op.isReg() && "KILL instruction must have only register operands");
564     Str += ' ';
565     Str += AP.TM.getRegisterInfo()->getName(Op.getReg());
566     Str += (Op.isDef() ? "<def>" : "<kill>");
567   }
568   AP.OutStreamer.AddComment(Str);
569   AP.OutStreamer.AddBlankLine();
570 }
571
572 /// EmitDebugValueComment - This method handles the target-independent form
573 /// of DBG_VALUE, returning true if it was able to do so.  A false return
574 /// means the target will need to handle MI in EmitInstruction.
575 static bool EmitDebugValueComment(const MachineInstr *MI, AsmPrinter &AP) {
576   // This code handles only the 3-operand target-independent form.
577   if (MI->getNumOperands() != 3)
578     return false;
579
580   SmallString<128> Str;
581   raw_svector_ostream OS(Str);
582   OS << '\t' << AP.MAI->getCommentString() << "DEBUG_VALUE: ";
583
584   // cast away const; DIetc do not take const operands for some reason.
585   DIVariable V(const_cast<MDNode*>(MI->getOperand(2).getMetadata()));
586   if (V.getContext().isSubprogram())
587     OS << DISubprogram(V.getContext()).getDisplayName() << ":";
588   OS << V.getName() << " <- ";
589
590   // Register or immediate value. Register 0 means undef.
591   if (MI->getOperand(0).isFPImm()) {
592     APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
593     if (MI->getOperand(0).getFPImm()->getType()->isFloatTy()) {
594       OS << (double)APF.convertToFloat();
595     } else if (MI->getOperand(0).getFPImm()->getType()->isDoubleTy()) {
596       OS << APF.convertToDouble();
597     } else {
598       // There is no good way to print long double.  Convert a copy to
599       // double.  Ah well, it's only a comment.
600       bool ignored;
601       APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
602                   &ignored);
603       OS << "(long double) " << APF.convertToDouble();
604     }
605   } else if (MI->getOperand(0).isImm()) {
606     OS << MI->getOperand(0).getImm();
607   } else {
608     assert(MI->getOperand(0).isReg() && "Unknown operand type");
609     if (MI->getOperand(0).getReg() == 0) {
610       // Suppress offset, it is not meaningful here.
611       OS << "undef";
612       // NOTE: Want this comment at start of line, don't emit with AddComment.
613       AP.OutStreamer.EmitRawText(OS.str());
614       return true;
615     }
616     OS << AP.TM.getRegisterInfo()->getName(MI->getOperand(0).getReg());
617   }
618   
619   OS << '+' << MI->getOperand(1).getImm();
620   // NOTE: Want this comment at start of line, don't emit with AddComment.
621   AP.OutStreamer.EmitRawText(OS.str());
622   return true;
623 }
624
625 /// EmitFunctionBody - This method emits the body and trailer for a
626 /// function.
627 void AsmPrinter::EmitFunctionBody() {
628   // Emit target-specific gunk before the function body.
629   EmitFunctionBodyStart();
630   
631   bool ShouldPrintDebugScopes = DD && MMI->hasDebugInfo();
632   
633   // Print out code for the function.
634   bool HasAnyRealCode = false;
635   const MachineInstr *LastMI = 0;
636   for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
637        I != E; ++I) {
638     // Print a label for the basic block.
639     EmitBasicBlockStart(I);
640     for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
641          II != IE; ++II) {
642       LastMI = II;
643
644       // Print the assembly for the instruction.
645       if (!II->isLabel() && !II->isImplicitDef() && !II->isKill() &&
646           !II->isDebugValue()) {
647         HasAnyRealCode = true;
648         ++EmittedInsts;
649       }
650
651       if (ShouldPrintDebugScopes) {
652         NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
653         DD->beginInstruction(II);
654       }
655       
656       if (isVerbose())
657         EmitComments(*II, OutStreamer.GetCommentOS());
658
659       switch (II->getOpcode()) {
660       case TargetOpcode::PROLOG_LABEL:
661       case TargetOpcode::EH_LABEL:
662       case TargetOpcode::GC_LABEL:
663         OutStreamer.EmitLabel(II->getOperand(0).getMCSymbol());
664         break;
665       case TargetOpcode::INLINEASM:
666         EmitInlineAsm(II);
667         break;
668       case TargetOpcode::DBG_VALUE:
669         if (isVerbose()) {
670           if (!EmitDebugValueComment(II, *this))
671             EmitInstruction(II);
672         }
673         break;
674       case TargetOpcode::IMPLICIT_DEF:
675         if (isVerbose()) EmitImplicitDef(II, *this);
676         break;
677       case TargetOpcode::KILL:
678         if (isVerbose()) EmitKill(II, *this);
679         break;
680       default:
681         EmitInstruction(II);
682         break;
683       }
684       
685       if (ShouldPrintDebugScopes) {
686         NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
687         DD->endInstruction(II);
688       }
689     }
690   }
691
692   // If the last instruction was a prolog label, then we have a situation where
693   // we emitted a prolog but no function body. This results in the ending prolog
694   // label equaling the end of function label and an invalid "row" in the
695   // FDE. We need to emit a noop in this situation so that the FDE's rows are
696   // valid.
697   bool RequiresNoop = LastMI && LastMI->isPrologLabel();
698
699   // If the function is empty and the object file uses .subsections_via_symbols,
700   // then we need to emit *something* to the function body to prevent the
701   // labels from collapsing together.  Just emit a noop.
702   if ((MAI->hasSubsectionsViaSymbols() && !HasAnyRealCode) || RequiresNoop) {
703     MCInst Noop;
704     TM.getInstrInfo()->getNoopForMachoTarget(Noop);
705     if (Noop.getOpcode()) {
706       OutStreamer.AddComment("avoids zero-length function");
707       OutStreamer.EmitInstruction(Noop);
708     } else  // Target not mc-ized yet.
709       OutStreamer.EmitRawText(StringRef("\tnop\n"));
710   }
711   
712   // Emit target-specific gunk after the function body.
713   EmitFunctionBodyEnd();
714   
715   // If the target wants a .size directive for the size of the function, emit
716   // it.
717   if (MAI->hasDotTypeDotSizeDirective()) {
718     // Create a symbol for the end of function, so we can get the size as
719     // difference between the function label and the temp label.
720     MCSymbol *FnEndLabel = OutContext.CreateTempSymbol();
721     OutStreamer.EmitLabel(FnEndLabel);
722     
723     const MCExpr *SizeExp =
724       MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(FnEndLabel, OutContext),
725                               MCSymbolRefExpr::Create(CurrentFnSym, OutContext),
726                               OutContext);
727     OutStreamer.EmitELFSize(CurrentFnSym, SizeExp);
728   }
729   
730   // Emit post-function debug information.
731   if (DD) {
732     NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
733     DD->endFunction(MF);
734   }
735   if (DE) {
736     NamedRegionTimer T(EHTimerName, DWARFGroupName, TimePassesIsEnabled);
737     DE->EndFunction();
738   }
739   MMI->EndFunction();
740   
741   // Print out jump tables referenced by the function.
742   EmitJumpTableInfo();
743   
744   OutStreamer.AddBlankLine();
745 }
746
747 /// getDebugValueLocation - Get location information encoded by DBG_VALUE
748 /// operands.
749 MachineLocation AsmPrinter::getDebugValueLocation(const MachineInstr *MI) const {
750   // Target specific DBG_VALUE instructions are handled by each target.
751   return MachineLocation();
752 }
753
754 bool AsmPrinter::doFinalization(Module &M) {
755   // Emit global variables.
756   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
757        I != E; ++I)
758     EmitGlobalVariable(I);
759
760   // Emit visibility info for declarations
761   for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
762     const Function &F = *I;
763     if (!F.isDeclaration())
764       continue;
765     GlobalValue::VisibilityTypes V = F.getVisibility();
766     if (V == GlobalValue::DefaultVisibility)
767       continue;
768
769     MCSymbol *Name = Mang->getSymbol(&F);
770     EmitVisibility(Name, V, false);
771   }
772
773   // Finalize debug and EH information.
774   if (DE) {
775     {
776       NamedRegionTimer T(EHTimerName, DWARFGroupName, TimePassesIsEnabled);
777       DE->EndModule();
778     }
779     delete DE; DE = 0;
780   }
781   if (DD) {
782     {
783       NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
784       DD->endModule();
785     }
786     delete DD; DD = 0;
787   }
788   
789   // If the target wants to know about weak references, print them all.
790   if (MAI->getWeakRefDirective()) {
791     // FIXME: This is not lazy, it would be nice to only print weak references
792     // to stuff that is actually used.  Note that doing so would require targets
793     // to notice uses in operands (due to constant exprs etc).  This should
794     // happen with the MC stuff eventually.
795
796     // Print out module-level global variables here.
797     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
798          I != E; ++I) {
799       if (!I->hasExternalWeakLinkage()) continue;
800       OutStreamer.EmitSymbolAttribute(Mang->getSymbol(I), MCSA_WeakReference);
801     }
802     
803     for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
804       if (!I->hasExternalWeakLinkage()) continue;
805       OutStreamer.EmitSymbolAttribute(Mang->getSymbol(I), MCSA_WeakReference);
806     }
807   }
808
809   if (MAI->hasSetDirective()) {
810     OutStreamer.AddBlankLine();
811     for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
812          I != E; ++I) {
813       MCSymbol *Name = Mang->getSymbol(I);
814
815       const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
816       MCSymbol *Target = Mang->getSymbol(GV);
817
818       if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
819         OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
820       else if (I->hasWeakLinkage())
821         OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
822       else
823         assert(I->hasLocalLinkage() && "Invalid alias linkage");
824
825       EmitVisibility(Name, I->getVisibility());
826
827       // Emit the directives as assignments aka .set:
828       OutStreamer.EmitAssignment(Name, 
829                                  MCSymbolRefExpr::Create(Target, OutContext));
830     }
831   }
832
833   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
834   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
835   for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
836     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
837       MP->finishAssembly(*this);
838
839   // If we don't have any trampolines, then we don't require stack memory
840   // to be executable. Some targets have a directive to declare this.
841   Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
842   if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
843     if (const MCSection *S = MAI->getNonexecutableStackSection(OutContext))
844       OutStreamer.SwitchSection(S);
845   
846   // Allow the target to emit any magic that it wants at the end of the file,
847   // after everything else has gone out.
848   EmitEndOfAsmFile(M);
849   
850   delete Mang; Mang = 0;
851   MMI = 0;
852   
853   OutStreamer.Finish();
854   return false;
855 }
856
857 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
858   this->MF = &MF;
859   // Get the function symbol.
860   CurrentFnSym = Mang->getSymbol(MF.getFunction());
861
862   if (isVerbose())
863     LI = &getAnalysis<MachineLoopInfo>();
864 }
865
866 namespace {
867   // SectionCPs - Keep track the alignment, constpool entries per Section.
868   struct SectionCPs {
869     const MCSection *S;
870     unsigned Alignment;
871     SmallVector<unsigned, 4> CPEs;
872     SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
873   };
874 }
875
876 /// EmitConstantPool - Print to the current output stream assembly
877 /// representations of the constants in the constant pool MCP. This is
878 /// used to print out constants which have been "spilled to memory" by
879 /// the code generator.
880 ///
881 void AsmPrinter::EmitConstantPool() {
882   const MachineConstantPool *MCP = MF->getConstantPool();
883   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
884   if (CP.empty()) return;
885
886   // Calculate sections for constant pool entries. We collect entries to go into
887   // the same section together to reduce amount of section switch statements.
888   SmallVector<SectionCPs, 4> CPSections;
889   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
890     const MachineConstantPoolEntry &CPE = CP[i];
891     unsigned Align = CPE.getAlignment();
892     
893     SectionKind Kind;
894     switch (CPE.getRelocationInfo()) {
895     default: llvm_unreachable("Unknown section kind");
896     case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
897     case 1:
898       Kind = SectionKind::getReadOnlyWithRelLocal();
899       break;
900     case 0:
901     switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
902     case 4:  Kind = SectionKind::getMergeableConst4(); break;
903     case 8:  Kind = SectionKind::getMergeableConst8(); break;
904     case 16: Kind = SectionKind::getMergeableConst16();break;
905     default: Kind = SectionKind::getMergeableConst(); break;
906     }
907     }
908
909     const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
910     
911     // The number of sections are small, just do a linear search from the
912     // last section to the first.
913     bool Found = false;
914     unsigned SecIdx = CPSections.size();
915     while (SecIdx != 0) {
916       if (CPSections[--SecIdx].S == S) {
917         Found = true;
918         break;
919       }
920     }
921     if (!Found) {
922       SecIdx = CPSections.size();
923       CPSections.push_back(SectionCPs(S, Align));
924     }
925
926     if (Align > CPSections[SecIdx].Alignment)
927       CPSections[SecIdx].Alignment = Align;
928     CPSections[SecIdx].CPEs.push_back(i);
929   }
930
931   // Now print stuff into the calculated sections.
932   for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
933     OutStreamer.SwitchSection(CPSections[i].S);
934     EmitAlignment(Log2_32(CPSections[i].Alignment));
935
936     unsigned Offset = 0;
937     for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
938       unsigned CPI = CPSections[i].CPEs[j];
939       MachineConstantPoolEntry CPE = CP[CPI];
940
941       // Emit inter-object padding for alignment.
942       unsigned AlignMask = CPE.getAlignment() - 1;
943       unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
944       OutStreamer.EmitFill(NewOffset - Offset, 0/*fillval*/, 0/*addrspace*/);
945
946       const Type *Ty = CPE.getType();
947       Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
948       OutStreamer.EmitLabel(GetCPISymbol(CPI));
949
950       if (CPE.isMachineConstantPoolEntry())
951         EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
952       else
953         EmitGlobalConstant(CPE.Val.ConstVal);
954     }
955   }
956 }
957
958 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
959 /// by the current function to the current output stream.  
960 ///
961 void AsmPrinter::EmitJumpTableInfo() {
962   const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
963   if (MJTI == 0) return;
964   if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
965   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
966   if (JT.empty()) return;
967
968   // Pick the directive to use to print the jump table entries, and switch to 
969   // the appropriate section.
970   const Function *F = MF->getFunction();
971   bool JTInDiffSection = false;
972   if (// In PIC mode, we need to emit the jump table to the same section as the
973       // function body itself, otherwise the label differences won't make sense.
974       // FIXME: Need a better predicate for this: what about custom entries?
975       MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
976       // We should also do if the section name is NULL or function is declared
977       // in discardable section
978       // FIXME: this isn't the right predicate, should be based on the MCSection
979       // for the function.
980       F->isWeakForLinker()) {
981     OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F,Mang,TM));
982   } else {
983     // Otherwise, drop it in the readonly section.
984     const MCSection *ReadOnlySection = 
985       getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
986     OutStreamer.SwitchSection(ReadOnlySection);
987     JTInDiffSection = true;
988   }
989
990   EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getTargetData())));
991   
992   for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
993     const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
994     
995     // If this jump table was deleted, ignore it. 
996     if (JTBBs.empty()) continue;
997
998     // For the EK_LabelDifference32 entry, if the target supports .set, emit a
999     // .set directive for each unique entry.  This reduces the number of
1000     // relocations the assembler will generate for the jump table.
1001     if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
1002         MAI->hasSetDirective()) {
1003       SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
1004       const TargetLowering *TLI = TM.getTargetLowering();
1005       const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
1006       for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
1007         const MachineBasicBlock *MBB = JTBBs[ii];
1008         if (!EmittedSets.insert(MBB)) continue;
1009         
1010         // .set LJTSet, LBB32-base
1011         const MCExpr *LHS =
1012           MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1013         OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
1014                                 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
1015       }
1016     }          
1017     
1018     // On some targets (e.g. Darwin) we want to emit two consecutive labels
1019     // before each jump table.  The first label is never referenced, but tells
1020     // the assembler and linker the extents of the jump table object.  The
1021     // second label is actually referenced by the code.
1022     if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
1023       // FIXME: This doesn't have to have any specific name, just any randomly
1024       // named and numbered 'l' label would work.  Simplify GetJTISymbol.
1025       OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
1026
1027     OutStreamer.EmitLabel(GetJTISymbol(JTI));
1028
1029     for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
1030       EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
1031   }
1032 }
1033
1034 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
1035 /// current stream.
1036 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
1037                                     const MachineBasicBlock *MBB,
1038                                     unsigned UID) const {
1039   assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
1040   const MCExpr *Value = 0;
1041   switch (MJTI->getEntryKind()) {
1042   case MachineJumpTableInfo::EK_Inline:
1043     llvm_unreachable("Cannot emit EK_Inline jump table entry"); break;
1044   case MachineJumpTableInfo::EK_Custom32:
1045     Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, UID,
1046                                                               OutContext);
1047     break;
1048   case MachineJumpTableInfo::EK_BlockAddress:
1049     // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1050     //     .word LBB123
1051     Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1052     break;
1053   case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
1054     // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
1055     // with a relocation as gp-relative, e.g.:
1056     //     .gprel32 LBB123
1057     MCSymbol *MBBSym = MBB->getSymbol();
1058     OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1059     return;
1060   }
1061
1062   case MachineJumpTableInfo::EK_LabelDifference32: {
1063     // EK_LabelDifference32 - Each entry is the address of the block minus
1064     // the address of the jump table.  This is used for PIC jump tables where
1065     // gprel32 is not supported.  e.g.:
1066     //      .word LBB123 - LJTI1_2
1067     // If the .set directive is supported, this is emitted as:
1068     //      .set L4_5_set_123, LBB123 - LJTI1_2
1069     //      .word L4_5_set_123
1070     
1071     // If we have emitted set directives for the jump table entries, print 
1072     // them rather than the entries themselves.  If we're emitting PIC, then
1073     // emit the table entries as differences between two text section labels.
1074     if (MAI->hasSetDirective()) {
1075       // If we used .set, reference the .set's symbol.
1076       Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
1077                                       OutContext);
1078       break;
1079     }
1080     // Otherwise, use the difference as the jump table entry.
1081     Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1082     const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
1083     Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
1084     break;
1085   }
1086   }
1087   
1088   assert(Value && "Unknown entry kind!");
1089  
1090   unsigned EntrySize = MJTI->getEntrySize(*TM.getTargetData());
1091   OutStreamer.EmitValue(Value, EntrySize, /*addrspace*/0);
1092 }
1093
1094
1095 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
1096 /// special global used by LLVM.  If so, emit it and return true, otherwise
1097 /// do nothing and return false.
1098 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
1099   if (GV->getName() == "llvm.used") {
1100     if (MAI->hasNoDeadStrip())    // No need to emit this at all.
1101       EmitLLVMUsedList(GV->getInitializer());
1102     return true;
1103   }
1104
1105   // Ignore debug and non-emitted data.  This handles llvm.compiler.used.
1106   if (GV->getSection() == "llvm.metadata" ||
1107       GV->hasAvailableExternallyLinkage())
1108     return true;
1109   
1110   if (!GV->hasAppendingLinkage()) return false;
1111
1112   assert(GV->hasInitializer() && "Not a special LLVM global!");
1113   
1114   const TargetData *TD = TM.getTargetData();
1115   unsigned Align = Log2_32(TD->getPointerPrefAlignment());
1116   if (GV->getName() == "llvm.global_ctors") {
1117     OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
1118     EmitAlignment(Align);
1119     EmitXXStructorList(GV->getInitializer());
1120     
1121     if (TM.getRelocationModel() == Reloc::Static &&
1122         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1123       StringRef Sym(".constructors_used");
1124       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1125                                       MCSA_Reference);
1126     }
1127     return true;
1128   } 
1129   
1130   if (GV->getName() == "llvm.global_dtors") {
1131     OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
1132     EmitAlignment(Align);
1133     EmitXXStructorList(GV->getInitializer());
1134
1135     if (TM.getRelocationModel() == Reloc::Static &&
1136         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1137       StringRef Sym(".destructors_used");
1138       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1139                                       MCSA_Reference);
1140     }
1141     return true;
1142   }
1143   
1144   return false;
1145 }
1146
1147 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
1148 /// global in the specified llvm.used list for which emitUsedDirectiveFor
1149 /// is true, as being used with this directive.
1150 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
1151   // Should be an array of 'i8*'.
1152   ConstantArray *InitList = dyn_cast<ConstantArray>(List);
1153   if (InitList == 0) return;
1154   
1155   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1156     const GlobalValue *GV =
1157       dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
1158     if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
1159       OutStreamer.EmitSymbolAttribute(Mang->getSymbol(GV), MCSA_NoDeadStrip);
1160   }
1161 }
1162
1163 /// EmitXXStructorList - Emit the ctor or dtor list.  This just prints out the 
1164 /// function pointers, ignoring the init priority.
1165 void AsmPrinter::EmitXXStructorList(Constant *List) {
1166   // Should be an array of '{ int, void ()* }' structs.  The first value is the
1167   // init priority, which we ignore.
1168   if (!isa<ConstantArray>(List)) return;
1169   ConstantArray *InitList = cast<ConstantArray>(List);
1170   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
1171     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
1172       if (CS->getNumOperands() != 2) return;  // Not array of 2-element structs.
1173
1174       if (CS->getOperand(1)->isNullValue())
1175         return;  // Found a null terminator, exit printing.
1176       // Emit the function pointer.
1177       EmitGlobalConstant(CS->getOperand(1));
1178     }
1179 }
1180
1181 //===--------------------------------------------------------------------===//
1182 // Emission and print routines
1183 //
1184
1185 /// EmitInt8 - Emit a byte directive and value.
1186 ///
1187 void AsmPrinter::EmitInt8(int Value) const {
1188   OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
1189 }
1190
1191 /// EmitInt16 - Emit a short directive and value.
1192 ///
1193 void AsmPrinter::EmitInt16(int Value) const {
1194   OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
1195 }
1196
1197 /// EmitInt32 - Emit a long directive and value.
1198 ///
1199 void AsmPrinter::EmitInt32(int Value) const {
1200   OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
1201 }
1202
1203 /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
1204 /// in bytes of the directive is specified by Size and Hi/Lo specify the
1205 /// labels.  This implicitly uses .set if it is available.
1206 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
1207                                      unsigned Size) const {
1208   // Get the Hi-Lo expression.
1209   const MCExpr *Diff = 
1210     MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(Hi, OutContext),
1211                             MCSymbolRefExpr::Create(Lo, OutContext),
1212                             OutContext);
1213   
1214   if (!MAI->hasSetDirective()) {
1215     OutStreamer.EmitValue(Diff, Size, 0/*AddrSpace*/);
1216     return;
1217   }
1218
1219   // Otherwise, emit with .set (aka assignment).
1220   MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1221   OutStreamer.EmitAssignment(SetLabel, Diff);
1222   OutStreamer.EmitSymbolValue(SetLabel, Size, 0/*AddrSpace*/);
1223 }
1224
1225 /// EmitLabelOffsetDifference - Emit something like ".long Hi+Offset-Lo" 
1226 /// where the size in bytes of the directive is specified by Size and Hi/Lo
1227 /// specify the labels.  This implicitly uses .set if it is available.
1228 void AsmPrinter::EmitLabelOffsetDifference(const MCSymbol *Hi, uint64_t Offset,
1229                                            const MCSymbol *Lo, unsigned Size) 
1230   const {
1231   
1232   // Emit Hi+Offset - Lo
1233   // Get the Hi+Offset expression.
1234   const MCExpr *Plus =
1235     MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(Hi, OutContext), 
1236                             MCConstantExpr::Create(Offset, OutContext),
1237                             OutContext);
1238   
1239   // Get the Hi+Offset-Lo expression.
1240   const MCExpr *Diff = 
1241     MCBinaryExpr::CreateSub(Plus,
1242                             MCSymbolRefExpr::Create(Lo, OutContext),
1243                             OutContext);
1244   
1245   if (!MAI->hasSetDirective()) 
1246     OutStreamer.EmitValue(Diff, 4, 0/*AddrSpace*/);
1247   else {
1248     // Otherwise, emit with .set (aka assignment).
1249     MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1250     OutStreamer.EmitAssignment(SetLabel, Diff);
1251     OutStreamer.EmitSymbolValue(SetLabel, 4, 0/*AddrSpace*/);
1252   }
1253 }
1254
1255 /// EmitLabelPlusOffset - Emit something like ".long Label+Offset" 
1256 /// where the size in bytes of the directive is specified by Size and Label
1257 /// specifies the label.  This implicitly uses .set if it is available.
1258 void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
1259                                       unsigned Size) 
1260   const {
1261   
1262   // Emit Label+Offset
1263   const MCExpr *Plus =
1264     MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(Label, OutContext), 
1265                             MCConstantExpr::Create(Offset, OutContext),
1266                             OutContext);
1267   
1268   OutStreamer.EmitValue(Plus, 4, 0/*AddrSpace*/);
1269 }
1270     
1271
1272 //===----------------------------------------------------------------------===//
1273
1274 // EmitAlignment - Emit an alignment directive to the specified power of
1275 // two boundary.  For example, if you pass in 3 here, you will get an 8
1276 // byte alignment.  If a global value is specified, and if that global has
1277 // an explicit alignment requested, it will override the alignment request
1278 // if required for correctness.
1279 //
1280 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV) const {
1281   if (GV) NumBits = getGVAlignmentLog2(GV, *TM.getTargetData(), NumBits);
1282   
1283   if (NumBits == 0) return;   // 1-byte aligned: no need to emit alignment.
1284   
1285   if (getCurrentSection()->getKind().isText())
1286     OutStreamer.EmitCodeAlignment(1 << NumBits);
1287   else
1288     OutStreamer.EmitValueToAlignment(1 << NumBits, 0, 1, 0);
1289 }
1290
1291 //===----------------------------------------------------------------------===//
1292 // Constant emission.
1293 //===----------------------------------------------------------------------===//
1294
1295 /// LowerConstant - Lower the specified LLVM Constant to an MCExpr.
1296 ///
1297 static const MCExpr *LowerConstant(const Constant *CV, AsmPrinter &AP) {
1298   MCContext &Ctx = AP.OutContext;
1299   
1300   if (CV->isNullValue() || isa<UndefValue>(CV))
1301     return MCConstantExpr::Create(0, Ctx);
1302
1303   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
1304     return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
1305   
1306   if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
1307     return MCSymbolRefExpr::Create(AP.Mang->getSymbol(GV), Ctx);
1308
1309   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
1310     return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
1311   
1312   const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
1313   if (CE == 0) {
1314     llvm_unreachable("Unknown constant value to lower!");
1315     return MCConstantExpr::Create(0, Ctx);
1316   }
1317   
1318   switch (CE->getOpcode()) {
1319   default:
1320     // If the code isn't optimized, there may be outstanding folding
1321     // opportunities. Attempt to fold the expression using TargetData as a
1322     // last resort before giving up.
1323     if (Constant *C =
1324           ConstantFoldConstantExpression(CE, AP.TM.getTargetData()))
1325       if (C != CE)
1326         return LowerConstant(C, AP);
1327
1328     // Otherwise report the problem to the user.
1329     {
1330       std::string S;
1331       raw_string_ostream OS(S);
1332       OS << "Unsupported expression in static initializer: ";
1333       WriteAsOperand(OS, CE, /*PrintType=*/false,
1334                      !AP.MF ? 0 : AP.MF->getFunction()->getParent());
1335       report_fatal_error(OS.str());
1336     }
1337     return MCConstantExpr::Create(0, Ctx);
1338   case Instruction::GetElementPtr: {
1339     const TargetData &TD = *AP.TM.getTargetData();
1340     // Generate a symbolic expression for the byte address
1341     const Constant *PtrVal = CE->getOperand(0);
1342     SmallVector<Value*, 8> IdxVec(CE->op_begin()+1, CE->op_end());
1343     int64_t Offset = TD.getIndexedOffset(PtrVal->getType(), &IdxVec[0],
1344                                          IdxVec.size());
1345     
1346     const MCExpr *Base = LowerConstant(CE->getOperand(0), AP);
1347     if (Offset == 0)
1348       return Base;
1349     
1350     // Truncate/sext the offset to the pointer size.
1351     if (TD.getPointerSizeInBits() != 64) {
1352       int SExtAmount = 64-TD.getPointerSizeInBits();
1353       Offset = (Offset << SExtAmount) >> SExtAmount;
1354     }
1355     
1356     return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
1357                                    Ctx);
1358   }
1359       
1360   case Instruction::Trunc:
1361     // We emit the value and depend on the assembler to truncate the generated
1362     // expression properly.  This is important for differences between
1363     // blockaddress labels.  Since the two labels are in the same function, it
1364     // is reasonable to treat their delta as a 32-bit value.
1365     // FALL THROUGH.
1366   case Instruction::BitCast:
1367     return LowerConstant(CE->getOperand(0), AP);
1368
1369   case Instruction::IntToPtr: {
1370     const TargetData &TD = *AP.TM.getTargetData();
1371     // Handle casts to pointers by changing them into casts to the appropriate
1372     // integer type.  This promotes constant folding and simplifies this code.
1373     Constant *Op = CE->getOperand(0);
1374     Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
1375                                       false/*ZExt*/);
1376     return LowerConstant(Op, AP);
1377   }
1378     
1379   case Instruction::PtrToInt: {
1380     const TargetData &TD = *AP.TM.getTargetData();
1381     // Support only foldable casts to/from pointers that can be eliminated by
1382     // changing the pointer to the appropriately sized integer type.
1383     Constant *Op = CE->getOperand(0);
1384     const Type *Ty = CE->getType();
1385
1386     const MCExpr *OpExpr = LowerConstant(Op, AP);
1387
1388     // We can emit the pointer value into this slot if the slot is an
1389     // integer slot equal to the size of the pointer.
1390     if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
1391       return OpExpr;
1392
1393     // Otherwise the pointer is smaller than the resultant integer, mask off
1394     // the high bits so we are sure to get a proper truncation if the input is
1395     // a constant expr.
1396     unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
1397     const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
1398     return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
1399   }
1400       
1401   // The MC library also has a right-shift operator, but it isn't consistently
1402   // signed or unsigned between different targets.
1403   case Instruction::Add:
1404   case Instruction::Sub:
1405   case Instruction::Mul:
1406   case Instruction::SDiv:
1407   case Instruction::SRem:
1408   case Instruction::Shl:
1409   case Instruction::And:
1410   case Instruction::Or:
1411   case Instruction::Xor: {
1412     const MCExpr *LHS = LowerConstant(CE->getOperand(0), AP);
1413     const MCExpr *RHS = LowerConstant(CE->getOperand(1), AP);
1414     switch (CE->getOpcode()) {
1415     default: llvm_unreachable("Unknown binary operator constant cast expr");
1416     case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
1417     case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
1418     case Instruction::Mul: return MCBinaryExpr::CreateMul(LHS, RHS, Ctx);
1419     case Instruction::SDiv: return MCBinaryExpr::CreateDiv(LHS, RHS, Ctx);
1420     case Instruction::SRem: return MCBinaryExpr::CreateMod(LHS, RHS, Ctx);
1421     case Instruction::Shl: return MCBinaryExpr::CreateShl(LHS, RHS, Ctx);
1422     case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
1423     case Instruction::Or:  return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
1424     case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
1425     }
1426   }
1427   }
1428 }
1429
1430 static void EmitGlobalConstantImpl(const Constant *C, unsigned AddrSpace,
1431                                    AsmPrinter &AP);
1432
1433 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
1434                                     AsmPrinter &AP) {
1435   if (AddrSpace != 0 || !CA->isString()) {
1436     // Not a string.  Print the values in successive locations
1437     for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1438       EmitGlobalConstantImpl(CA->getOperand(i), AddrSpace, AP);
1439     return;
1440   }
1441   
1442   // Otherwise, it can be emitted as .ascii.
1443   SmallVector<char, 128> TmpVec;
1444   TmpVec.reserve(CA->getNumOperands());
1445   for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1446     TmpVec.push_back(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
1447
1448   AP.OutStreamer.EmitBytes(StringRef(TmpVec.data(), TmpVec.size()), AddrSpace);
1449 }
1450
1451 static void EmitGlobalConstantVector(const ConstantVector *CV,
1452                                      unsigned AddrSpace, AsmPrinter &AP) {
1453   for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1454     EmitGlobalConstantImpl(CV->getOperand(i), AddrSpace, AP);
1455 }
1456
1457 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
1458                                      unsigned AddrSpace, AsmPrinter &AP) {
1459   // Print the fields in successive locations. Pad to align if needed!
1460   const TargetData *TD = AP.TM.getTargetData();
1461   unsigned Size = TD->getTypeAllocSize(CS->getType());
1462   const StructLayout *Layout = TD->getStructLayout(CS->getType());
1463   uint64_t SizeSoFar = 0;
1464   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1465     const Constant *Field = CS->getOperand(i);
1466
1467     // Check if padding is needed and insert one or more 0s.
1468     uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
1469     uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1470                         - Layout->getElementOffset(i)) - FieldSize;
1471     SizeSoFar += FieldSize + PadSize;
1472
1473     // Now print the actual field value.
1474     EmitGlobalConstantImpl(Field, AddrSpace, AP);
1475
1476     // Insert padding - this may include padding to increase the size of the
1477     // current field up to the ABI size (if the struct is not packed) as well
1478     // as padding to ensure that the next field starts at the right offset.
1479     AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
1480   }
1481   assert(SizeSoFar == Layout->getSizeInBytes() &&
1482          "Layout of constant struct may be incorrect!");
1483 }
1484
1485 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
1486                                  AsmPrinter &AP) {
1487   // FP Constants are printed as integer constants to avoid losing
1488   // precision.
1489   if (CFP->getType()->isDoubleTy()) {
1490     if (AP.isVerbose()) {
1491       double Val = CFP->getValueAPF().convertToDouble();
1492       AP.OutStreamer.GetCommentOS() << "double " << Val << '\n';
1493     }
1494
1495     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1496     AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1497     return;
1498   }
1499   
1500   if (CFP->getType()->isFloatTy()) {
1501     if (AP.isVerbose()) {
1502       float Val = CFP->getValueAPF().convertToFloat();
1503       AP.OutStreamer.GetCommentOS() << "float " << Val << '\n';
1504     }
1505     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1506     AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
1507     return;
1508   }
1509   
1510   if (CFP->getType()->isX86_FP80Ty()) {
1511     // all long double variants are printed as hex
1512     // API needed to prevent premature destruction
1513     APInt API = CFP->getValueAPF().bitcastToAPInt();
1514     const uint64_t *p = API.getRawData();
1515     if (AP.isVerbose()) {
1516       // Convert to double so we can print the approximate val as a comment.
1517       APFloat DoubleVal = CFP->getValueAPF();
1518       bool ignored;
1519       DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1520                         &ignored);
1521       AP.OutStreamer.GetCommentOS() << "x86_fp80 ~= "
1522         << DoubleVal.convertToDouble() << '\n';
1523     }
1524     
1525     if (AP.TM.getTargetData()->isBigEndian()) {
1526       AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1527       AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1528     } else {
1529       AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1530       AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1531     }
1532     
1533     // Emit the tail padding for the long double.
1534     const TargetData &TD = *AP.TM.getTargetData();
1535     AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
1536                              TD.getTypeStoreSize(CFP->getType()), AddrSpace);
1537     return;
1538   }
1539   
1540   assert(CFP->getType()->isPPC_FP128Ty() &&
1541          "Floating point constant type not handled");
1542   // All long double variants are printed as hex
1543   // API needed to prevent premature destruction.
1544   APInt API = CFP->getValueAPF().bitcastToAPInt();
1545   const uint64_t *p = API.getRawData();
1546   if (AP.TM.getTargetData()->isBigEndian()) {
1547     AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1548     AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1549   } else {
1550     AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1551     AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1552   }
1553 }
1554
1555 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
1556                                        unsigned AddrSpace, AsmPrinter &AP) {
1557   const TargetData *TD = AP.TM.getTargetData();
1558   unsigned BitWidth = CI->getBitWidth();
1559   assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
1560
1561   // We don't expect assemblers to support integer data directives
1562   // for more than 64 bits, so we emit the data in at most 64-bit
1563   // quantities at a time.
1564   const uint64_t *RawData = CI->getValue().getRawData();
1565   for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1566     uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1567     AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1568   }
1569 }
1570
1571 static void EmitGlobalConstantImpl(const Constant *CV, unsigned AddrSpace,
1572                                    AsmPrinter &AP) {
1573   if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
1574     uint64_t Size = AP.TM.getTargetData()->getTypeAllocSize(CV->getType());
1575     return AP.OutStreamer.EmitZeros(Size, AddrSpace);
1576   }
1577
1578   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1579     unsigned Size = AP.TM.getTargetData()->getTypeAllocSize(CV->getType());
1580     switch (Size) {
1581     case 1:
1582     case 2:
1583     case 4:
1584     case 8:
1585       if (AP.isVerbose())
1586         AP.OutStreamer.GetCommentOS() << format("0x%llx\n", CI->getZExtValue());
1587       AP.OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1588       return;
1589     default:
1590       EmitGlobalConstantLargeInt(CI, AddrSpace, AP);
1591       return;
1592     }
1593   }
1594   
1595   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1596     return EmitGlobalConstantArray(CVA, AddrSpace, AP);
1597   
1598   if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1599     return EmitGlobalConstantStruct(CVS, AddrSpace, AP);
1600
1601   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1602     return EmitGlobalConstantFP(CFP, AddrSpace, AP);
1603
1604   if (isa<ConstantPointerNull>(CV)) {
1605     unsigned Size = AP.TM.getTargetData()->getTypeAllocSize(CV->getType());
1606     AP.OutStreamer.EmitIntValue(0, Size, AddrSpace);
1607     return;
1608   }
1609   
1610   if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1611     return EmitGlobalConstantVector(V, AddrSpace, AP);
1612   
1613   // Otherwise, it must be a ConstantExpr.  Lower it to an MCExpr, then emit it
1614   // thread the streamer with EmitValue.
1615   AP.OutStreamer.EmitValue(LowerConstant(CV, AP),
1616                          AP.TM.getTargetData()->getTypeAllocSize(CV->getType()),
1617                            AddrSpace);
1618 }
1619
1620 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1621 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1622   uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1623   if (Size)
1624     EmitGlobalConstantImpl(CV, AddrSpace, *this);
1625   else if (MAI->hasSubsectionsViaSymbols()) {
1626     // If the global has zero size, emit a single byte so that two labels don't
1627     // look like they are at the same location.
1628     OutStreamer.EmitIntValue(0, 1, AddrSpace);
1629   }
1630 }
1631
1632 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1633   // Target doesn't support this yet!
1634   llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1635 }
1636
1637 void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const {
1638   if (Offset > 0)
1639     OS << '+' << Offset;
1640   else if (Offset < 0)
1641     OS << Offset;
1642 }
1643
1644 //===----------------------------------------------------------------------===//
1645 // Symbol Lowering Routines.
1646 //===----------------------------------------------------------------------===//
1647
1648 /// GetTempSymbol - Return the MCSymbol corresponding to the assembler
1649 /// temporary label with the specified stem and unique ID.
1650 MCSymbol *AsmPrinter::GetTempSymbol(StringRef Name, unsigned ID) const {
1651   return OutContext.GetOrCreateSymbol(Twine(MAI->getPrivateGlobalPrefix()) +
1652                                       Name + Twine(ID));
1653 }
1654
1655 /// GetTempSymbol - Return an assembler temporary label with the specified
1656 /// stem.
1657 MCSymbol *AsmPrinter::GetTempSymbol(StringRef Name) const {
1658   return OutContext.GetOrCreateSymbol(Twine(MAI->getPrivateGlobalPrefix())+
1659                                       Name);
1660 }
1661
1662
1663 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
1664   return MMI->getAddrLabelSymbol(BA->getBasicBlock());
1665 }
1666
1667 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const {
1668   return MMI->getAddrLabelSymbol(BB);
1669 }
1670
1671 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1672 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1673   return OutContext.GetOrCreateSymbol
1674     (Twine(MAI->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber())
1675      + "_" + Twine(CPID));
1676 }
1677
1678 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1679 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1680   return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
1681 }
1682
1683 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
1684 /// FIXME: privatize to AsmPrinter.
1685 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
1686   return OutContext.GetOrCreateSymbol
1687   (Twine(MAI->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" +
1688    Twine(UID) + "_set_" + Twine(MBBID));
1689 }
1690
1691 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1692 /// global value name as its base, with the specified suffix, and where the
1693 /// symbol is forced to have private linkage if ForcePrivate is true.
1694 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1695                                                    StringRef Suffix,
1696                                                    bool ForcePrivate) const {
1697   SmallString<60> NameStr;
1698   Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1699   NameStr.append(Suffix.begin(), Suffix.end());
1700   return OutContext.GetOrCreateSymbol(NameStr.str());
1701 }
1702
1703 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1704 /// ExternalSymbol.
1705 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1706   SmallString<60> NameStr;
1707   Mang->getNameWithPrefix(NameStr, Sym);
1708   return OutContext.GetOrCreateSymbol(NameStr.str());
1709 }  
1710
1711
1712
1713 /// PrintParentLoopComment - Print comments about parent loops of this one.
1714 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1715                                    unsigned FunctionNumber) {
1716   if (Loop == 0) return;
1717   PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
1718   OS.indent(Loop->getLoopDepth()*2)
1719     << "Parent Loop BB" << FunctionNumber << "_"
1720     << Loop->getHeader()->getNumber()
1721     << " Depth=" << Loop->getLoopDepth() << '\n';
1722 }
1723
1724
1725 /// PrintChildLoopComment - Print comments about child loops within
1726 /// the loop for this basic block, with nesting.
1727 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1728                                   unsigned FunctionNumber) {
1729   // Add child loop information
1730   for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
1731     OS.indent((*CL)->getLoopDepth()*2)
1732       << "Child Loop BB" << FunctionNumber << "_"
1733       << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
1734       << '\n';
1735     PrintChildLoopComment(OS, *CL, FunctionNumber);
1736   }
1737 }
1738
1739 /// EmitBasicBlockLoopComments - Pretty-print comments for basic blocks.
1740 static void EmitBasicBlockLoopComments(const MachineBasicBlock &MBB,
1741                                        const MachineLoopInfo *LI,
1742                                        const AsmPrinter &AP) {
1743   // Add loop depth information
1744   const MachineLoop *Loop = LI->getLoopFor(&MBB);
1745   if (Loop == 0) return;
1746   
1747   MachineBasicBlock *Header = Loop->getHeader();
1748   assert(Header && "No header for loop");
1749   
1750   // If this block is not a loop header, just print out what is the loop header
1751   // and return.
1752   if (Header != &MBB) {
1753     AP.OutStreamer.AddComment("  in Loop: Header=BB" +
1754                               Twine(AP.getFunctionNumber())+"_" +
1755                               Twine(Loop->getHeader()->getNumber())+
1756                               " Depth="+Twine(Loop->getLoopDepth()));
1757     return;
1758   }
1759   
1760   // Otherwise, it is a loop header.  Print out information about child and
1761   // parent loops.
1762   raw_ostream &OS = AP.OutStreamer.GetCommentOS();
1763   
1764   PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber()); 
1765   
1766   OS << "=>";
1767   OS.indent(Loop->getLoopDepth()*2-2);
1768   
1769   OS << "This ";
1770   if (Loop->empty())
1771     OS << "Inner ";
1772   OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
1773   
1774   PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
1775 }
1776
1777
1778 /// EmitBasicBlockStart - This method prints the label for the specified
1779 /// MachineBasicBlock, an alignment (if present) and a comment describing
1780 /// it if appropriate.
1781 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1782   // Emit an alignment directive for this block, if needed.
1783   if (unsigned Align = MBB->getAlignment())
1784     EmitAlignment(Log2_32(Align));
1785
1786   // If the block has its address taken, emit any labels that were used to
1787   // reference the block.  It is possible that there is more than one label
1788   // here, because multiple LLVM BB's may have been RAUW'd to this block after
1789   // the references were generated.
1790   if (MBB->hasAddressTaken()) {
1791     const BasicBlock *BB = MBB->getBasicBlock();
1792     if (isVerbose())
1793       OutStreamer.AddComment("Block address taken");
1794     
1795     std::vector<MCSymbol*> Syms = MMI->getAddrLabelSymbolToEmit(BB);
1796
1797     for (unsigned i = 0, e = Syms.size(); i != e; ++i)
1798       OutStreamer.EmitLabel(Syms[i]);
1799   }
1800
1801   // Print the main label for the block.
1802   if (MBB->pred_empty() || isBlockOnlyReachableByFallthrough(MBB)) {
1803     if (isVerbose() && OutStreamer.hasRawTextSupport()) {
1804       if (const BasicBlock *BB = MBB->getBasicBlock())
1805         if (BB->hasName())
1806           OutStreamer.AddComment("%" + BB->getName());
1807       
1808       EmitBasicBlockLoopComments(*MBB, LI, *this);
1809       
1810       // NOTE: Want this comment at start of line, don't emit with AddComment.
1811       OutStreamer.EmitRawText(Twine(MAI->getCommentString()) + " BB#" +
1812                               Twine(MBB->getNumber()) + ":");
1813     }
1814   } else {
1815     if (isVerbose()) {
1816       if (const BasicBlock *BB = MBB->getBasicBlock())
1817         if (BB->hasName())
1818           OutStreamer.AddComment("%" + BB->getName());
1819       EmitBasicBlockLoopComments(*MBB, LI, *this);
1820     }
1821
1822     OutStreamer.EmitLabel(MBB->getSymbol());
1823   }
1824 }
1825
1826 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility,
1827                                 bool IsDefinition) const {
1828   MCSymbolAttr Attr = MCSA_Invalid;
1829   
1830   switch (Visibility) {
1831   default: break;
1832   case GlobalValue::HiddenVisibility:
1833     if (IsDefinition)
1834       Attr = MAI->getHiddenVisibilityAttr();
1835     else
1836       Attr = MAI->getHiddenDeclarationVisibilityAttr();
1837     break;
1838   case GlobalValue::ProtectedVisibility:
1839     Attr = MAI->getProtectedVisibilityAttr();
1840     break;
1841   }
1842
1843   if (Attr != MCSA_Invalid)
1844     OutStreamer.EmitSymbolAttribute(Sym, Attr);
1845 }
1846
1847 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
1848 /// exactly one predecessor and the control transfer mechanism between
1849 /// the predecessor and this block is a fall-through.
1850 bool AsmPrinter::
1851 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
1852   // If this is a landing pad, it isn't a fall through.  If it has no preds,
1853   // then nothing falls through to it.
1854   if (MBB->isLandingPad() || MBB->pred_empty())
1855     return false;
1856   
1857   // If there isn't exactly one predecessor, it can't be a fall through.
1858   MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(), PI2 = PI;
1859   ++PI2;
1860   if (PI2 != MBB->pred_end())
1861     return false;
1862   
1863   // The predecessor has to be immediately before this block.
1864   const MachineBasicBlock *Pred = *PI;
1865   
1866   if (!Pred->isLayoutSuccessor(MBB))
1867     return false;
1868   
1869   // If the block is completely empty, then it definitely does fall through.
1870   if (Pred->empty())
1871     return true;
1872   
1873   // Otherwise, check the last instruction.
1874   const MachineInstr &LastInst = Pred->back();
1875   return !LastInst.getDesc().isBarrier();
1876 }
1877
1878
1879
1880 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1881   if (!S->usesMetadata())
1882     return 0;
1883
1884   gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
1885   gcp_map_type::iterator GCPI = GCMap.find(S);
1886   if (GCPI != GCMap.end())
1887     return GCPI->second;
1888   
1889   const char *Name = S->getName().c_str();
1890   
1891   for (GCMetadataPrinterRegistry::iterator
1892          I = GCMetadataPrinterRegistry::begin(),
1893          E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1894     if (strcmp(Name, I->getName()) == 0) {
1895       GCMetadataPrinter *GMP = I->instantiate();
1896       GMP->S = S;
1897       GCMap.insert(std::make_pair(S, GMP));
1898       return GMP;
1899     }
1900   
1901   report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
1902   return 0;
1903 }
1904