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