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