lib/CodeGen/AsmPrinter/AsmPrinter.cpp

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