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