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