lib/CodeGen/AsmPrinter/AsmPrinter.cpp

   1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the AsmPrinter class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "asm-printer"
  15 #include "llvm/CodeGen/AsmPrinter.h"
  16 #include "DwarfDebug.h"
  17 #include "DwarfException.h"
  18 #include "llvm/ADT/SmallString.h"
  19 #include "llvm/ADT/Statistic.h"
  20 #include "llvm/Analysis/ConstantFolding.h"
  21 #include "llvm/CodeGen/GCMetadataPrinter.h"
  22 #include "llvm/CodeGen/MachineConstantPool.h"
  23 #include "llvm/CodeGen/MachineFrameInfo.h"
  24 #include "llvm/CodeGen/MachineFunction.h"
  25 #include "llvm/CodeGen/MachineInstrBundle.h"
  26 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  27 #include "llvm/CodeGen/MachineLoopInfo.h"
  28 #include "llvm/CodeGen/MachineModuleInfo.h"
  29 #include "llvm/DebugInfo.h"
  30 #include "llvm/IR/DataLayout.h"
  31 #include "llvm/IR/Mangler.h"
  32 #include "llvm/IR/Module.h"
  33 #include "llvm/IR/Operator.h"
  34 #include "llvm/MC/MCAsmInfo.h"
  35 #include "llvm/MC/MCContext.h"
  36 #include "llvm/MC/MCExpr.h"
  37 #include "llvm/MC/MCInst.h"
  38 #include "llvm/MC/MCSection.h"
  39 #include "llvm/MC/MCStreamer.h"
  40 #include "llvm/MC/MCSymbol.h"
  41 #include "llvm/Support/ErrorHandling.h"
  42 #include "llvm/Support/Format.h"
  43 #include "llvm/Support/MathExtras.h"
  44 #include "llvm/Support/Timer.h"
  45 #include "llvm/Target/TargetFrameLowering.h"
  46 #include "llvm/Target/TargetInstrInfo.h"
  47 #include "llvm/Target/TargetLowering.h"
  48 #include "llvm/Target/TargetLoweringObjectFile.h"
  49 #include "llvm/Target/TargetOptions.h"
  50 #include "llvm/Target/TargetRegisterInfo.h"
  51 #include "llvm/Target/TargetSubtargetInfo.h"
  52 #include "llvm/Transforms/Utils/GlobalStatus.h"
  53 #include "WinCodeViewLineTables.h"
  54 using namespace llvm;
  55
  56 static const char *const DWARFGroupName = "DWARF Emission";
  57 static const char *const DbgTimerName = "Debug Info Emission";
  58 static const char *const EHTimerName = "DWARF Exception Writer";
  59 static const char *const CodeViewLineTablesGroupName = "CodeView Line Tables";
  60
  61 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  62
  63 char AsmPrinter::ID = 0;
  64
  65 typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
  66 static gcp_map_type &getGCMap(void *&P) {
  67   if (P == 0)
  68     P = new gcp_map_type();
  69   return *(gcp_map_type*)P;
  70 }
  71
  72
  73 /// getGVAlignmentLog2 - Return the alignment to use for the specified global
  74 /// value in log2 form.  This rounds up to the preferred alignment if possible
  75 /// and legal.
  76 static unsigned getGVAlignmentLog2(const GlobalValue *GV, const DataLayout &TD,
  77                                    unsigned InBits = 0) {
  78   unsigned NumBits = 0;
  79   if (const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV))
  80     NumBits = TD.getPreferredAlignmentLog(GVar);
  81
  82   // If InBits is specified, round it to it.
  83   if (InBits > NumBits)
  84     NumBits = InBits;
  85
  86   // If the GV has a specified alignment, take it into account.
  87   if (GV->getAlignment() == 0)
  88     return NumBits;
  89
  90   unsigned GVAlign = Log2_32(GV->getAlignment());
  91
  92   // If the GVAlign is larger than NumBits, or if we are required to obey
  93   // NumBits because the GV has an assigned section, obey it.
  94   if (GVAlign > NumBits || GV->hasSection())
  95     NumBits = GVAlign;
  96   return NumBits;
  97 }
  98
  99 AsmPrinter::AsmPrinter(TargetMachine &tm, MCStreamer &Streamer)
 100   : MachineFunctionPass(ID),
 101     TM(tm), MAI(tm.getMCAsmInfo()), MII(tm.getInstrInfo()),
 102     OutContext(Streamer.getContext()),
 103     OutStreamer(Streamer),
 104     LastMI(0), LastFn(0), Counter(~0U), SetCounter(0) {
 105   DD = 0; MMI = 0; LI = 0; MF = 0;
 106   CurrentFnSym = CurrentFnSymForSize = 0;
 107   GCMetadataPrinters = 0;
 108   VerboseAsm = Streamer.isVerboseAsm();
 109 }
 110
 111 AsmPrinter::~AsmPrinter() {
 112   assert(DD == 0 && Handlers.empty() && "Debug/EH info didn't get finalized");
 113
 114   if (GCMetadataPrinters != 0) {
 115     gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
 116
 117     for (gcp_map_type::iterator I = GCMap.begin(), E = GCMap.end(); I != E; ++I)
 118       delete I->second;
 119     delete &GCMap;
 120     GCMetadataPrinters = 0;
 121   }
 122
 123   delete &OutStreamer;
 124 }
 125
 126 /// getFunctionNumber - Return a unique ID for the current function.
 127 ///
 128 unsigned AsmPrinter::getFunctionNumber() const {
 129   return MF->getFunctionNumber();
 130 }
 131
 132 const TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
 133   return TM.getTargetLowering()->getObjFileLowering();
 134 }
 135
 136 /// getDataLayout - Return information about data layout.
 137 const DataLayout &AsmPrinter::getDataLayout() const {
 138   return *TM.getDataLayout();
 139 }
 140
 141 const MCSubtargetInfo &AsmPrinter::getSubtargetInfo() const {
 142   return TM.getSubtarget<MCSubtargetInfo>();
 143 }
 144
 145 void AsmPrinter::EmitToStreamer(MCStreamer &S, const MCInst &Inst) {
 146   S.EmitInstruction(Inst, getSubtargetInfo());
 147 }
 148
 149 StringRef AsmPrinter::getTargetTriple() const {
 150   return TM.getTargetTriple();
 151 }
 152
 153 /// getCurrentSection() - Return the current section we are emitting to.
 154 const MCSection *AsmPrinter::getCurrentSection() const {
 155   return OutStreamer.getCurrentSection().first;
 156 }
 157
 158
 159
 160 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
 161   AU.setPreservesAll();
 162   MachineFunctionPass::getAnalysisUsage(AU);
 163   AU.addRequired<MachineModuleInfo>();
 164   AU.addRequired<GCModuleInfo>();
 165   if (isVerbose())
 166     AU.addRequired<MachineLoopInfo>();
 167 }
 168
 169 bool AsmPrinter::doInitialization(Module &M) {
 170   MMI = getAnalysisIfAvailable<MachineModuleInfo>();
 171   MMI->AnalyzeModule(M);
 172
 173   // Initialize TargetLoweringObjectFile.
 174   const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
 175     .Initialize(OutContext, TM);
 176
 177   OutStreamer.InitSections(false);
 178
 179   Mang = new Mangler(TM.getDataLayout());
 180
 181   // Allow the target to emit any magic that it wants at the start of the file.
 182   EmitStartOfAsmFile(M);
 183
 184   // Very minimal debug info. It is ignored if we emit actual debug info. If we
 185   // don't, this at least helps the user find where a global came from.
 186   if (MAI->hasSingleParameterDotFile()) {
 187     // .file "foo.c"
 188     OutStreamer.EmitFileDirective(M.getModuleIdentifier());
 189   }
 190
 191   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
 192   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
 193   for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
 194     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
 195       MP->beginAssembly(*this);
 196
 197   // Emit module-level inline asm if it exists.
 198   if (!M.getModuleInlineAsm().empty()) {
 199     OutStreamer.AddComment("Start of file scope inline assembly");
 200     OutStreamer.AddBlankLine();
 201     EmitInlineAsm(M.getModuleInlineAsm()+"\n");
 202     OutStreamer.AddComment("End of file scope inline assembly");
 203     OutStreamer.AddBlankLine();
 204   }
 205
 206   if (MAI->doesSupportDebugInformation()) {
 207     if (Triple(TM.getTargetTriple()).getOS() == Triple::Win32) {
 208       Handlers.push_back(HandlerInfo(new WinCodeViewLineTables(this),
 209                                      DbgTimerName,
 210                                      CodeViewLineTablesGroupName));
 211     } else {
 212       DD = new DwarfDebug(this, &M);
 213       Handlers.push_back(HandlerInfo(DD, DbgTimerName, DWARFGroupName));
 214     }
 215   }
 216
 217   DwarfException *DE = 0;
 218   switch (MAI->getExceptionHandlingType()) {
 219   case ExceptionHandling::None:
 220     break;
 221   case ExceptionHandling::SjLj:
 222   case ExceptionHandling::DwarfCFI:
 223     DE = new DwarfCFIException(this);
 224     break;
 225   case ExceptionHandling::ARM:
 226     DE = new ARMException(this);
 227     break;
 228   case ExceptionHandling::Win64:
 229     DE = new Win64Exception(this);
 230     break;
 231   }
 232   if (DE)
 233     Handlers.push_back(HandlerInfo(DE, EHTimerName, DWARFGroupName));
 234   return false;
 235 }
 236
 237 static bool canBeHidden(const GlobalValue *GV, const MCAsmInfo &MAI) {
 238   GlobalValue::LinkageTypes Linkage = GV->getLinkage();
 239   if (Linkage != GlobalValue::LinkOnceODRLinkage)
 240     return false;
 241
 242   if (!MAI.hasWeakDefCanBeHiddenDirective())
 243     return false;
 244
 245   if (GV->hasUnnamedAddr())
 246     return true;
 247
 248   // This is only used for MachO, so right now it doesn't really matter how
 249   // we handle alias. Revisit this once the MachO linker implements aliases.
 250   if (isa<GlobalAlias>(GV))
 251     return false;
 252
 253   // If it is a non constant variable, it needs to be uniqued across shared
 254   // objects.
 255   if (const GlobalVariable *Var = dyn_cast<GlobalVariable>(GV)) {
 256     if (!Var->isConstant())
 257       return false;
 258   }
 259
 260   GlobalStatus GS;
 261   if (!GlobalStatus::analyzeGlobal(GV, GS) && !GS.IsCompared)
 262     return true;
 263
 264   return false;
 265 }
 266
 267 void AsmPrinter::EmitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const {
 268   GlobalValue::LinkageTypes Linkage = GV->getLinkage();
 269   switch (Linkage) {
 270   case GlobalValue::CommonLinkage:
 271   case GlobalValue::LinkOnceAnyLinkage:
 272   case GlobalValue::LinkOnceODRLinkage:
 273   case GlobalValue::WeakAnyLinkage:
 274   case GlobalValue::WeakODRLinkage:
 275   case GlobalValue::LinkerPrivateWeakLinkage:
 276     if (MAI->hasWeakDefDirective()) {
 277       // .globl _foo
 278       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
 279
 280       if (!canBeHidden(GV, *MAI))
 281         // .weak_definition _foo
 282         OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
 283       else
 284         OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefAutoPrivate);
 285     } else if (MAI->hasLinkOnceDirective()) {
 286       // .globl _foo
 287       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
 288       //NOTE: linkonce is handled by the section the symbol was assigned to.
 289     } else {
 290       // .weak _foo
 291       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
 292     }
 293     return;
 294   case GlobalValue::AppendingLinkage:
 295     // FIXME: appending linkage variables should go into a section of
 296     // their name or something.  For now, just emit them as external.
 297   case GlobalValue::ExternalLinkage:
 298     // If external or appending, declare as a global symbol.
 299     // .globl _foo
 300     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
 301     return;
 302   case GlobalValue::PrivateLinkage:
 303   case GlobalValue::InternalLinkage:
 304   case GlobalValue::LinkerPrivateLinkage:
 305     return;
 306   case GlobalValue::AvailableExternallyLinkage:
 307     llvm_unreachable("Should never emit this");
 308   case GlobalValue::ExternalWeakLinkage:
 309     llvm_unreachable("Don't know how to emit these");
 310   }
 311   llvm_unreachable("Unknown linkage type!");
 312 }
 313
 314 MCSymbol *AsmPrinter::getSymbol(const GlobalValue *GV) const {
 315   return getObjFileLowering().getSymbol(GV, *Mang);
 316 }
 317
 318 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
 319 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
 320   if (GV->hasInitializer()) {
 321     // Check to see if this is a special global used by LLVM, if so, emit it.
 322     if (EmitSpecialLLVMGlobal(GV))
 323       return;
 324
 325     if (isVerbose()) {
 326       GV->printAsOperand(OutStreamer.GetCommentOS(),
 327                      /*PrintType=*/false, GV->getParent());
 328       OutStreamer.GetCommentOS() << '\n';
 329     }
 330   }
 331
 332   MCSymbol *GVSym = getSymbol(GV);
 333   EmitVisibility(GVSym, GV->getVisibility(), !GV->isDeclaration());
 334
 335   if (!GV->hasInitializer())   // External globals require no extra code.
 336     return;
 337
 338   if (MAI->hasDotTypeDotSizeDirective())
 339     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
 340
 341   SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
 342
 343   const DataLayout *DL = TM.getDataLayout();
 344   uint64_t Size = DL->getTypeAllocSize(GV->getType()->getElementType());
 345
 346   // If the alignment is specified, we *must* obey it.  Overaligning a global
 347   // with a specified alignment is a prompt way to break globals emitted to
 348   // sections and expected to be contiguous (e.g. ObjC metadata).
 349   unsigned AlignLog = getGVAlignmentLog2(GV, *DL);
 350
 351   for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
 352     const HandlerInfo &OI = Handlers[I];
 353     NamedRegionTimer T(OI.TimerName, OI.TimerGroupName, TimePassesIsEnabled);
 354     OI.Handler->setSymbolSize(GVSym, Size);
 355   }
 356
 357   // Handle common and BSS local symbols (.lcomm).
 358   if (GVKind.isCommon() || GVKind.isBSSLocal()) {
 359     if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
 360     unsigned Align = 1 << AlignLog;
 361
 362     // Handle common symbols.
 363     if (GVKind.isCommon()) {
 364       if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
 365         Align = 0;
 366
 367       // .comm _foo, 42, 4
 368       OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
 369       return;
 370     }
 371
 372     // Handle local BSS symbols.
 373     if (MAI->hasMachoZeroFillDirective()) {
 374       const MCSection *TheSection =
 375         getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM);
 376       // .zerofill __DATA, __bss, _foo, 400, 5
 377       OutStreamer.EmitZerofill(TheSection, GVSym, Size, Align);
 378       return;
 379     }
 380
 381     // Use .lcomm only if it supports user-specified alignment.
 382     // Otherwise, while it would still be correct to use .lcomm in some
 383     // cases (e.g. when Align == 1), the external assembler might enfore
 384     // some -unknown- default alignment behavior, which could cause
 385     // spurious differences between external and integrated assembler.
 386     // Prefer to simply fall back to .local / .comm in this case.
 387     if (MAI->getLCOMMDirectiveAlignmentType() != LCOMM::NoAlignment) {
 388       // .lcomm _foo, 42
 389       OutStreamer.EmitLocalCommonSymbol(GVSym, Size, Align);
 390       return;
 391     }
 392
 393     if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
 394       Align = 0;
 395
 396     // .local _foo
 397     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
 398     // .comm _foo, 42, 4
 399     OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
 400     return;
 401   }
 402
 403   const MCSection *TheSection =
 404     getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM);
 405
 406   // Handle the zerofill directive on darwin, which is a special form of BSS
 407   // emission.
 408   if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
 409     if (Size == 0) Size = 1;  // zerofill of 0 bytes is undefined.
 410
 411     // .globl _foo
 412     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
 413     // .zerofill __DATA, __common, _foo, 400, 5
 414     OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
 415     return;
 416   }
 417
 418   // Handle thread local data for mach-o which requires us to output an
 419   // additional structure of data and mangle the original symbol so that we
 420   // can reference it later.
 421   //
 422   // TODO: This should become an "emit thread local global" method on TLOF.
 423   // All of this macho specific stuff should be sunk down into TLOFMachO and
 424   // stuff like "TLSExtraDataSection" should no longer be part of the parent
 425   // TLOF class.  This will also make it more obvious that stuff like
 426   // MCStreamer::EmitTBSSSymbol is macho specific and only called from macho
 427   // specific code.
 428   if (GVKind.isThreadLocal() && MAI->hasMachoTBSSDirective()) {
 429     // Emit the .tbss symbol
 430     MCSymbol *MangSym =
 431       OutContext.GetOrCreateSymbol(GVSym->getName() + Twine("$tlv$init"));
 432
 433     if (GVKind.isThreadBSS()) {
 434       TheSection = getObjFileLowering().getTLSBSSSection();
 435       OutStreamer.EmitTBSSSymbol(TheSection, MangSym, Size, 1 << AlignLog);
 436     } else if (GVKind.isThreadData()) {
 437       OutStreamer.SwitchSection(TheSection);
 438
 439       EmitAlignment(AlignLog, GV);
 440       OutStreamer.EmitLabel(MangSym);
 441
 442       EmitGlobalConstant(GV->getInitializer());
 443     }
 444
 445     OutStreamer.AddBlankLine();
 446
 447     // Emit the variable struct for the runtime.
 448     const MCSection *TLVSect
 449       = getObjFileLowering().getTLSExtraDataSection();
 450
 451     OutStreamer.SwitchSection(TLVSect);
 452     // Emit the linkage here.
 453     EmitLinkage(GV, GVSym);
 454     OutStreamer.EmitLabel(GVSym);
 455
 456     // Three pointers in size:
 457     //   - __tlv_bootstrap - used to make sure support exists
 458     //   - spare pointer, used when mapped by the runtime
 459     //   - pointer to mangled symbol above with initializer
 460     unsigned PtrSize = DL->getPointerTypeSize(GV->getType());
 461     OutStreamer.EmitSymbolValue(GetExternalSymbolSymbol("_tlv_bootstrap"),
 462                                 PtrSize);
 463     OutStreamer.EmitIntValue(0, PtrSize);
 464     OutStreamer.EmitSymbolValue(MangSym, PtrSize);
 465
 466     OutStreamer.AddBlankLine();
 467     return;
 468   }
 469
 470   OutStreamer.SwitchSection(TheSection);
 471
 472   EmitLinkage(GV, GVSym);
 473   EmitAlignment(AlignLog, GV);
 474
 475   OutStreamer.EmitLabel(GVSym);
 476
 477   EmitGlobalConstant(GV->getInitializer());
 478
 479   if (MAI->hasDotTypeDotSizeDirective())
 480     // .size foo, 42
 481     OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
 482
 483   OutStreamer.AddBlankLine();
 484 }
 485
 486 /// EmitFunctionHeader - This method emits the header for the current
 487 /// function.
 488 void AsmPrinter::EmitFunctionHeader() {
 489   // Print out constants referenced by the function
 490   EmitConstantPool();
 491
 492   // Print the 'header' of function.
 493   const Function *F = MF->getFunction();
 494
 495   OutStreamer.SwitchSection(
 496       getObjFileLowering().SectionForGlobal(F, *Mang, TM));
 497   EmitVisibility(CurrentFnSym, F->getVisibility());
 498
 499   EmitLinkage(F, CurrentFnSym);
 500   EmitAlignment(MF->getAlignment(), F);
 501
 502   if (MAI->hasDotTypeDotSizeDirective())
 503     OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
 504
 505   if (isVerbose()) {
 506     F->printAsOperand(OutStreamer.GetCommentOS(),
 507                    /*PrintType=*/false, F->getParent());
 508     OutStreamer.GetCommentOS() << '\n';
 509   }
 510
 511   // Emit the CurrentFnSym.  This is a virtual function to allow targets to
 512   // do their wild and crazy things as required.
 513   EmitFunctionEntryLabel();
 514
 515   // If the function had address-taken blocks that got deleted, then we have
 516   // references to the dangling symbols.  Emit them at the start of the function
 517   // so that we don't get references to undefined symbols.
 518   std::vector<MCSymbol*> DeadBlockSyms;
 519   MMI->takeDeletedSymbolsForFunction(F, DeadBlockSyms);
 520   for (unsigned i = 0, e = DeadBlockSyms.size(); i != e; ++i) {
 521     OutStreamer.AddComment("Address taken block that was later removed");
 522     OutStreamer.EmitLabel(DeadBlockSyms[i]);
 523   }
 524
 525   // Emit pre-function debug and/or EH information.
 526   for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
 527     const HandlerInfo &OI = Handlers[I];
 528     NamedRegionTimer T(OI.TimerName, OI.TimerGroupName, TimePassesIsEnabled);
 529     OI.Handler->beginFunction(MF);
 530   }
 531
 532   // Emit the prefix data.
 533   if (F->hasPrefixData())
 534     EmitGlobalConstant(F->getPrefixData());
 535 }
 536
 537 /// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the
 538 /// function.  This can be overridden by targets as required to do custom stuff.
 539 void AsmPrinter::EmitFunctionEntryLabel() {
 540   // The function label could have already been emitted if two symbols end up
 541   // conflicting due to asm renaming.  Detect this and emit an error.
 542   if (CurrentFnSym->isUndefined())
 543     return OutStreamer.EmitLabel(CurrentFnSym);
 544
 545   report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
 546                      "' label emitted multiple times to assembly file");
 547 }
 548
 549 /// emitComments - Pretty-print comments for instructions.
 550 static void emitComments(const MachineInstr &MI, raw_ostream &CommentOS) {
 551   const MachineFunction *MF = MI.getParent()->getParent();
 552   const TargetMachine &TM = MF->getTarget();
 553
 554   // Check for spills and reloads
 555   int FI;
 556
 557   const MachineFrameInfo *FrameInfo = MF->getFrameInfo();
 558
 559   // We assume a single instruction only has a spill or reload, not
 560   // both.
 561   const MachineMemOperand *MMO;
 562   if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
 563     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
 564       MMO = *MI.memoperands_begin();
 565       CommentOS << MMO->getSize() << "-byte Reload\n";
 566     }
 567   } else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
 568     if (FrameInfo->isSpillSlotObjectIndex(FI))
 569       CommentOS << MMO->getSize() << "-byte Folded Reload\n";
 570   } else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
 571     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
 572       MMO = *MI.memoperands_begin();
 573       CommentOS << MMO->getSize() << "-byte Spill\n";
 574     }
 575   } else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
 576     if (FrameInfo->isSpillSlotObjectIndex(FI))
 577       CommentOS << MMO->getSize() << "-byte Folded Spill\n";
 578   }
 579
 580   // Check for spill-induced copies
 581   if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse))
 582     CommentOS << " Reload Reuse\n";
 583 }
 584
 585 /// emitImplicitDef - This method emits the specified machine instruction
 586 /// that is an implicit def.
 587 void AsmPrinter::emitImplicitDef(const MachineInstr *MI) const {
 588   unsigned RegNo = MI->getOperand(0).getReg();
 589   OutStreamer.AddComment(Twine("implicit-def: ") +
 590                          TM.getRegisterInfo()->getName(RegNo));
 591   OutStreamer.AddBlankLine();
 592 }
 593
 594 static void emitKill(const MachineInstr *MI, AsmPrinter &AP) {
 595   std::string Str = "kill:";
 596   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 597     const MachineOperand &Op = MI->getOperand(i);
 598     assert(Op.isReg() && "KILL instruction must have only register operands");
 599     Str += ' ';
 600     Str += AP.TM.getRegisterInfo()->getName(Op.getReg());
 601     Str += (Op.isDef() ? "<def>" : "<kill>");
 602   }
 603   AP.OutStreamer.AddComment(Str);
 604   AP.OutStreamer.AddBlankLine();
 605 }
 606
 607 /// emitDebugValueComment - This method handles the target-independent form
 608 /// of DBG_VALUE, returning true if it was able to do so.  A false return
 609 /// means the target will need to handle MI in EmitInstruction.
 610 static bool emitDebugValueComment(const MachineInstr *MI, AsmPrinter &AP) {
 611   // This code handles only the 3-operand target-independent form.
 612   if (MI->getNumOperands() != 3)
 613     return false;
 614
 615   SmallString<128> Str;
 616   raw_svector_ostream OS(Str);
 617   OS << "DEBUG_VALUE: ";
 618
 619   DIVariable V(MI->getOperand(2).getMetadata());
 620   if (V.getContext().isSubprogram()) {
 621     StringRef Name = DISubprogram(V.getContext()).getDisplayName();
 622     if (!Name.empty())
 623       OS << Name << ":";
 624   }
 625   OS << V.getName() << " <- ";
 626
 627   // The second operand is only an offset if it's an immediate.
 628   bool Deref = MI->getOperand(0).isReg() && MI->getOperand(1).isImm();
 629   int64_t Offset = Deref ? MI->getOperand(1).getImm() : 0;
 630
 631   // Register or immediate value. Register 0 means undef.
 632   if (MI->getOperand(0).isFPImm()) {
 633     APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
 634     if (MI->getOperand(0).getFPImm()->getType()->isFloatTy()) {
 635       OS << (double)APF.convertToFloat();
 636     } else if (MI->getOperand(0).getFPImm()->getType()->isDoubleTy()) {
 637       OS << APF.convertToDouble();
 638     } else {
 639       // There is no good way to print long double.  Convert a copy to
 640       // double.  Ah well, it's only a comment.
 641       bool ignored;
 642       APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
 643                   &ignored);
 644       OS << "(long double) " << APF.convertToDouble();
 645     }
 646   } else if (MI->getOperand(0).isImm()) {
 647     OS << MI->getOperand(0).getImm();
 648   } else if (MI->getOperand(0).isCImm()) {
 649     MI->getOperand(0).getCImm()->getValue().print(OS, false /*isSigned*/);
 650   } else {
 651     unsigned Reg;
 652     if (MI->getOperand(0).isReg()) {
 653       Reg = MI->getOperand(0).getReg();
 654     } else {
 655       assert(MI->getOperand(0).isFI() && "Unknown operand type");
 656       const TargetFrameLowering *TFI = AP.TM.getFrameLowering();
 657       Offset += TFI->getFrameIndexReference(*AP.MF,
 658                                             MI->getOperand(0).getIndex(), Reg);
 659       Deref = true;
 660     }
 661     if (Reg == 0) {
 662       // Suppress offset, it is not meaningful here.
 663       OS << "undef";
 664       // NOTE: Want this comment at start of line, don't emit with AddComment.
 665       AP.OutStreamer.emitRawComment(OS.str());
 666       return true;
 667     }
 668     if (Deref)
 669       OS << '[';
 670     OS << AP.TM.getRegisterInfo()->getName(Reg);
 671   }
 672
 673   if (Deref)
 674     OS << '+' << Offset << ']';
 675
 676   // NOTE: Want this comment at start of line, don't emit with AddComment.
 677   AP.OutStreamer.emitRawComment(OS.str());
 678   return true;
 679 }
 680
 681 AsmPrinter::CFIMoveType AsmPrinter::needsCFIMoves() {
 682   if (MAI->getExceptionHandlingType() == ExceptionHandling::DwarfCFI &&
 683       MF->getFunction()->needsUnwindTableEntry())
 684     return CFI_M_EH;
 685
 686   if (MMI->hasDebugInfo())
 687     return CFI_M_Debug;
 688
 689   return CFI_M_None;
 690 }
 691
 692 bool AsmPrinter::needsSEHMoves() {
 693   return MAI->getExceptionHandlingType() == ExceptionHandling::Win64 &&
 694     MF->getFunction()->needsUnwindTableEntry();
 695 }
 696
 697 void AsmPrinter::emitPrologLabel(const MachineInstr &MI) {
 698   const MCSymbol *Label = MI.getOperand(0).getMCSymbol();
 699
 700   if (MAI->getExceptionHandlingType() != ExceptionHandling::DwarfCFI)
 701     return;
 702
 703   if (needsCFIMoves() == CFI_M_None)
 704     return;
 705
 706   if (MMI->getCompactUnwindEncoding() != 0)
 707     OutStreamer.EmitCompactUnwindEncoding(MMI->getCompactUnwindEncoding());
 708
 709   const MachineModuleInfo &MMI = MF->getMMI();
 710   const std::vector<MCCFIInstruction> &Instrs = MMI.getFrameInstructions();
 711   bool FoundOne = false;
 712   (void)FoundOne;
 713   for (std::vector<MCCFIInstruction>::const_iterator I = Instrs.begin(),
 714          E = Instrs.end(); I != E; ++I) {
 715     if (I->getLabel() == Label) {
 716       emitCFIInstruction(*I);
 717       FoundOne = true;
 718     }
 719   }
 720   assert(FoundOne);
 721 }
 722
 723 /// EmitFunctionBody - This method emits the body and trailer for a
 724 /// function.
 725 void AsmPrinter::EmitFunctionBody() {
 726   // Emit target-specific gunk before the function body.
 727   EmitFunctionBodyStart();
 728
 729   bool ShouldPrintDebugScopes = MMI->hasDebugInfo();
 730
 731   // Print out code for the function.
 732   bool HasAnyRealCode = false;
 733   const MachineInstr *LastMI = 0;
 734   for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
 735        I != E; ++I) {
 736     // Print a label for the basic block.
 737     EmitBasicBlockStart(I);
 738     for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
 739          II != IE; ++II) {
 740       LastMI = II;
 741
 742       // Print the assembly for the instruction.
 743       if (!II->isLabel() && !II->isImplicitDef() && !II->isKill() &&
 744           !II->isDebugValue()) {
 745         HasAnyRealCode = true;
 746         ++EmittedInsts;
 747       }
 748
 749       if (ShouldPrintDebugScopes) {
 750         for (unsigned III = 0, EEE = Handlers.size(); III != EEE; ++III) {
 751           const HandlerInfo &OI = Handlers[III];
 752           NamedRegionTimer T(OI.TimerName, OI.TimerGroupName,
 753                              TimePassesIsEnabled);
 754           OI.Handler->beginInstruction(II);
 755         }
 756       }
 757
 758       if (isVerbose())
 759         emitComments(*II, OutStreamer.GetCommentOS());
 760
 761       switch (II->getOpcode()) {
 762       case TargetOpcode::PROLOG_LABEL:
 763         emitPrologLabel(*II);
 764         break;
 765
 766       case TargetOpcode::EH_LABEL:
 767       case TargetOpcode::GC_LABEL:
 768         OutStreamer.EmitLabel(II->getOperand(0).getMCSymbol());
 769         break;
 770       case TargetOpcode::INLINEASM:
 771         EmitInlineAsm(II);
 772         break;
 773       case TargetOpcode::DBG_VALUE:
 774         if (isVerbose()) {
 775           if (!emitDebugValueComment(II, *this))
 776             EmitInstruction(II);
 777         }
 778         break;
 779       case TargetOpcode::IMPLICIT_DEF:
 780         if (isVerbose()) emitImplicitDef(II);
 781         break;
 782       case TargetOpcode::KILL:
 783         if (isVerbose()) emitKill(II, *this);
 784         break;
 785       default:
 786         EmitInstruction(II);
 787         break;
 788       }
 789
 790       if (ShouldPrintDebugScopes) {
 791         for (unsigned III = 0, EEE = Handlers.size(); III != EEE; ++III) {
 792           const HandlerInfo &OI = Handlers[III];
 793           NamedRegionTimer T(OI.TimerName, OI.TimerGroupName,
 794                              TimePassesIsEnabled);
 795           OI.Handler->endInstruction();
 796         }
 797       }
 798     }
 799   }
 800
 801   // If the last instruction was a prolog label, then we have a situation where
 802   // we emitted a prolog but no function body. This results in the ending prolog
 803   // label equaling the end of function label and an invalid "row" in the
 804   // FDE. We need to emit a noop in this situation so that the FDE's rows are
 805   // valid.
 806   bool RequiresNoop = LastMI && LastMI->isPrologLabel();
 807
 808   // If the function is empty and the object file uses .subsections_via_symbols,
 809   // then we need to emit *something* to the function body to prevent the
 810   // labels from collapsing together.  Just emit a noop.
 811   if ((MAI->hasSubsectionsViaSymbols() && !HasAnyRealCode) || RequiresNoop) {
 812     MCInst Noop;
 813     TM.getInstrInfo()->getNoopForMachoTarget(Noop);
 814     if (Noop.getOpcode()) {
 815       OutStreamer.AddComment("avoids zero-length function");
 816       OutStreamer.EmitInstruction(Noop, getSubtargetInfo());
 817     } else  // Target not mc-ized yet.
 818       OutStreamer.EmitRawText(StringRef("\tnop\n"));
 819   }
 820
 821   const Function *F = MF->getFunction();
 822   for (Function::const_iterator i = F->begin(), e = F->end(); i != e; ++i) {
 823     const BasicBlock *BB = i;
 824     if (!BB->hasAddressTaken())
 825       continue;
 826     MCSymbol *Sym = GetBlockAddressSymbol(BB);
 827     if (Sym->isDefined())
 828       continue;
 829     OutStreamer.AddComment("Address of block that was removed by CodeGen");
 830     OutStreamer.EmitLabel(Sym);
 831   }
 832
 833   // Emit target-specific gunk after the function body.
 834   EmitFunctionBodyEnd();
 835
 836   // If the target wants a .size directive for the size of the function, emit
 837   // it.
 838   if (MAI->hasDotTypeDotSizeDirective()) {
 839     // Create a symbol for the end of function, so we can get the size as
 840     // difference between the function label and the temp label.
 841     MCSymbol *FnEndLabel = OutContext.CreateTempSymbol();
 842     OutStreamer.EmitLabel(FnEndLabel);
 843
 844     const MCExpr *SizeExp =
 845       MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(FnEndLabel, OutContext),
 846                               MCSymbolRefExpr::Create(CurrentFnSymForSize,
 847                                                       OutContext),
 848                               OutContext);
 849     OutStreamer.EmitELFSize(CurrentFnSym, SizeExp);
 850   }
 851
 852   // Emit post-function debug and/or EH information.
 853   for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
 854     const HandlerInfo &OI = Handlers[I];
 855     NamedRegionTimer T(OI.TimerName, OI.TimerGroupName, TimePassesIsEnabled);
 856     OI.Handler->endFunction(MF);
 857   }
 858   MMI->EndFunction();
 859
 860   // Print out jump tables referenced by the function.
 861   EmitJumpTableInfo();
 862
 863   OutStreamer.AddBlankLine();
 864 }
 865
 866 /// EmitDwarfRegOp - Emit dwarf register operation.
 867 void AsmPrinter::EmitDwarfRegOp(const MachineLocation &MLoc,
 868                                 bool Indirect) const {
 869   const TargetRegisterInfo *TRI = TM.getRegisterInfo();
 870   int Reg = TRI->getDwarfRegNum(MLoc.getReg(), false);
 871   bool isSubRegister = Reg < 0;
 872   unsigned Idx = 0;
 873
 874   for (MCSuperRegIterator SR(MLoc.getReg(), TRI); SR.isValid() && Reg < 0;
 875        ++SR) {
 876     Reg = TRI->getDwarfRegNum(*SR, false);
 877     if (Reg >= 0)
 878       Idx = TRI->getSubRegIndex(*SR, MLoc.getReg());
 879   }
 880
 881   // FIXME: Handle cases like a super register being encoded as
 882   // DW_OP_reg 32 DW_OP_piece 4 DW_OP_reg 33
 883
 884   // FIXME: We have no reasonable way of handling errors in here. The
 885   // caller might be in the middle of an dwarf expression. We should
 886   // probably assert that Reg >= 0 once debug info generation is more mature.
 887
 888   if (MLoc.isIndirect() || Indirect) {
 889     if (Reg < 32) {
 890       OutStreamer.AddComment(
 891         dwarf::OperationEncodingString(dwarf::DW_OP_breg0 + Reg));
 892       EmitInt8(dwarf::DW_OP_breg0 + Reg);
 893     } else {
 894       OutStreamer.AddComment("DW_OP_bregx");
 895       EmitInt8(dwarf::DW_OP_bregx);
 896       OutStreamer.AddComment(Twine(Reg));
 897       EmitULEB128(Reg);
 898     }
 899     EmitSLEB128(!MLoc.isIndirect() ? 0 : MLoc.getOffset());
 900     if (MLoc.isIndirect() && Indirect)
 901       EmitInt8(dwarf::DW_OP_deref);
 902   } else {
 903     if (Reg < 32) {
 904       OutStreamer.AddComment(
 905         dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
 906       EmitInt8(dwarf::DW_OP_reg0 + Reg);
 907     } else {
 908       OutStreamer.AddComment("DW_OP_regx");
 909       EmitInt8(dwarf::DW_OP_regx);
 910       OutStreamer.AddComment(Twine(Reg));
 911       EmitULEB128(Reg);
 912     }
 913   }
 914
 915   // Emit Mask
 916   if (isSubRegister) {
 917     unsigned Size = TRI->getSubRegIdxSize(Idx);
 918     unsigned Offset = TRI->getSubRegIdxOffset(Idx);
 919     if (Offset > 0) {
 920       OutStreamer.AddComment("DW_OP_bit_piece");
 921       EmitInt8(dwarf::DW_OP_bit_piece);
 922       OutStreamer.AddComment(Twine(Size));
 923       EmitULEB128(Size);
 924       OutStreamer.AddComment(Twine(Offset));
 925       EmitULEB128(Offset);
 926     } else {
 927       OutStreamer.AddComment("DW_OP_piece");
 928       EmitInt8(dwarf::DW_OP_piece);
 929       OutStreamer.AddComment(Twine(Size));
 930       EmitULEB128(Size);
 931     }
 932   }
 933 }
 934
 935 bool AsmPrinter::doFinalization(Module &M) {
 936   // Emit global variables.
 937   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 938        I != E; ++I)
 939     EmitGlobalVariable(I);
 940
 941   // Emit visibility info for declarations
 942   for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
 943     const Function &F = *I;
 944     if (!F.isDeclaration())
 945       continue;
 946     GlobalValue::VisibilityTypes V = F.getVisibility();
 947     if (V == GlobalValue::DefaultVisibility)
 948       continue;
 949
 950     MCSymbol *Name = getSymbol(&F);
 951     EmitVisibility(Name, V, false);
 952   }
 953
 954   // Emit module flags.
 955   SmallVector<Module::ModuleFlagEntry, 8> ModuleFlags;
 956   M.getModuleFlagsMetadata(ModuleFlags);
 957   if (!ModuleFlags.empty())
 958     getObjFileLowering().emitModuleFlags(OutStreamer, ModuleFlags, *Mang, TM);
 959
 960   // Make sure we wrote out everything we need.
 961   OutStreamer.Flush();
 962
 963   // Finalize debug and EH information.
 964   for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
 965     const HandlerInfo &OI = Handlers[I];
 966     NamedRegionTimer T(OI.TimerName, OI.TimerGroupName,
 967                        TimePassesIsEnabled);
 968     OI.Handler->endModule();
 969     delete OI.Handler;
 970   }
 971   Handlers.clear();
 972   DD = 0;
 973
 974   // If the target wants to know about weak references, print them all.
 975   if (MAI->getWeakRefDirective()) {
 976     // FIXME: This is not lazy, it would be nice to only print weak references
 977     // to stuff that is actually used.  Note that doing so would require targets
 978     // to notice uses in operands (due to constant exprs etc).  This should
 979     // happen with the MC stuff eventually.
 980
 981     // Print out module-level global variables here.
 982     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 983          I != E; ++I) {
 984       if (!I->hasExternalWeakLinkage()) continue;
 985       OutStreamer.EmitSymbolAttribute(getSymbol(I), MCSA_WeakReference);
 986     }
 987
 988     for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
 989       if (!I->hasExternalWeakLinkage()) continue;
 990       OutStreamer.EmitSymbolAttribute(getSymbol(I), MCSA_WeakReference);
 991     }
 992   }
 993
 994   if (MAI->hasSetDirective()) {
 995     OutStreamer.AddBlankLine();
 996     for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
 997          I != E; ++I) {
 998       MCSymbol *Name = getSymbol(I);
 999
1000       const GlobalValue *GV = I->getAliasedGlobal();
1001       if (GV->isDeclaration()) {
1002         report_fatal_error(Name->getName() +
1003                            ": Target doesn't support aliases to declarations");
1004       }
1005
1006       MCSymbol *Target = getSymbol(GV);
1007
1008       if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
1009         OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
1010       else if (I->hasWeakLinkage() || I->hasLinkOnceLinkage())
1011         OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
1012       else
1013         assert(I->hasLocalLinkage() && "Invalid alias linkage");
1014
1015       EmitVisibility(Name, I->getVisibility());
1016
1017       // Emit the directives as assignments aka .set:
1018       OutStreamer.EmitAssignment(Name,
1019                                  MCSymbolRefExpr::Create(Target, OutContext));
1020     }
1021   }
1022
1023   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
1024   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
1025   for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
1026     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
1027       MP->finishAssembly(*this);
1028
1029   // Emit llvm.ident metadata in an '.ident' directive.
1030   EmitModuleIdents(M);
1031
1032   // If we don't have any trampolines, then we don't require stack memory
1033   // to be executable. Some targets have a directive to declare this.
1034   Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
1035   if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
1036     if (const MCSection *S = MAI->getNonexecutableStackSection(OutContext))
1037       OutStreamer.SwitchSection(S);
1038
1039   // Allow the target to emit any magic that it wants at the end of the file,
1040   // after everything else has gone out.
1041   EmitEndOfAsmFile(M);
1042
1043   delete Mang; Mang = 0;
1044   MMI = 0;
1045
1046   OutStreamer.Finish();
1047   OutStreamer.reset();
1048
1049   return false;
1050 }
1051
1052 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
1053   this->MF = &MF;
1054   // Get the function symbol.
1055   CurrentFnSym = getSymbol(MF.getFunction());
1056   CurrentFnSymForSize = CurrentFnSym;
1057
1058   if (isVerbose())
1059     LI = &getAnalysis<MachineLoopInfo>();
1060 }
1061
1062 namespace {
1063   // SectionCPs - Keep track the alignment, constpool entries per Section.
1064   struct SectionCPs {
1065     const MCSection *S;
1066     unsigned Alignment;
1067     SmallVector<unsigned, 4> CPEs;
1068     SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
1069   };
1070 }
1071
1072 /// EmitConstantPool - Print to the current output stream assembly
1073 /// representations of the constants in the constant pool MCP. This is
1074 /// used to print out constants which have been "spilled to memory" by
1075 /// the code generator.
1076 ///
1077 void AsmPrinter::EmitConstantPool() {
1078   const MachineConstantPool *MCP = MF->getConstantPool();
1079   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
1080   if (CP.empty()) return;
1081
1082   // Calculate sections for constant pool entries. We collect entries to go into
1083   // the same section together to reduce amount of section switch statements.
1084   SmallVector<SectionCPs, 4> CPSections;
1085   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
1086     const MachineConstantPoolEntry &CPE = CP[i];
1087     unsigned Align = CPE.getAlignment();
1088
1089     SectionKind Kind;
1090     switch (CPE.getRelocationInfo()) {
1091     default: llvm_unreachable("Unknown section kind");
1092     case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
1093     case 1:
1094       Kind = SectionKind::getReadOnlyWithRelLocal();
1095       break;
1096     case 0:
1097     switch (TM.getDataLayout()->getTypeAllocSize(CPE.getType())) {
1098     case 4:  Kind = SectionKind::getMergeableConst4(); break;
1099     case 8:  Kind = SectionKind::getMergeableConst8(); break;
1100     case 16: Kind = SectionKind::getMergeableConst16();break;
1101     default: Kind = SectionKind::getMergeableConst(); break;
1102     }
1103     }
1104
1105     const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
1106
1107     // The number of sections are small, just do a linear search from the
1108     // last section to the first.
1109     bool Found = false;
1110     unsigned SecIdx = CPSections.size();
1111     while (SecIdx != 0) {
1112       if (CPSections[--SecIdx].S == S) {
1113         Found = true;
1114         break;
1115       }
1116     }
1117     if (!Found) {
1118       SecIdx = CPSections.size();
1119       CPSections.push_back(SectionCPs(S, Align));
1120     }
1121
1122     if (Align > CPSections[SecIdx].Alignment)
1123       CPSections[SecIdx].Alignment = Align;
1124     CPSections[SecIdx].CPEs.push_back(i);
1125   }
1126
1127   // Now print stuff into the calculated sections.
1128   for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
1129     OutStreamer.SwitchSection(CPSections[i].S);
1130     EmitAlignment(Log2_32(CPSections[i].Alignment));
1131
1132     unsigned Offset = 0;
1133     for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
1134       unsigned CPI = CPSections[i].CPEs[j];
1135       MachineConstantPoolEntry CPE = CP[CPI];
1136
1137       // Emit inter-object padding for alignment.
1138       unsigned AlignMask = CPE.getAlignment() - 1;
1139       unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
1140       OutStreamer.EmitZeros(NewOffset - Offset);
1141
1142       Type *Ty = CPE.getType();
1143       Offset = NewOffset + TM.getDataLayout()->getTypeAllocSize(Ty);
1144       OutStreamer.EmitLabel(GetCPISymbol(CPI));
1145
1146       if (CPE.isMachineConstantPoolEntry())
1147         EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
1148       else
1149         EmitGlobalConstant(CPE.Val.ConstVal);
1150     }
1151   }
1152 }
1153
1154 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
1155 /// by the current function to the current output stream.
1156 ///
1157 void AsmPrinter::EmitJumpTableInfo() {
1158   const DataLayout *DL = MF->getTarget().getDataLayout();
1159   const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
1160   if (MJTI == 0) return;
1161   if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
1162   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1163   if (JT.empty()) return;
1164
1165   // Pick the directive to use to print the jump table entries, and switch to
1166   // the appropriate section.
1167   const Function *F = MF->getFunction();
1168   bool JTInDiffSection = false;
1169   if (// In PIC mode, we need to emit the jump table to the same section as the
1170       // function body itself, otherwise the label differences won't make sense.
1171       // FIXME: Need a better predicate for this: what about custom entries?
1172       MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
1173       // We should also do if the section name is NULL or function is declared
1174       // in discardable section
1175       // FIXME: this isn't the right predicate, should be based on the MCSection
1176       // for the function.
1177       F->isWeakForLinker()) {
1178     OutStreamer.SwitchSection(
1179         getObjFileLowering().SectionForGlobal(F, *Mang, TM));
1180   } else {
1181     // Otherwise, drop it in the readonly section.
1182     const MCSection *ReadOnlySection =
1183       getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
1184     OutStreamer.SwitchSection(ReadOnlySection);
1185     JTInDiffSection = true;
1186   }
1187
1188   EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getDataLayout())));
1189
1190   // Jump tables in code sections are marked with a data_region directive
1191   // where that's supported.
1192   if (!JTInDiffSection)
1193     OutStreamer.EmitDataRegion(MCDR_DataRegionJT32);
1194
1195   for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
1196     const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
1197
1198     // If this jump table was deleted, ignore it.
1199     if (JTBBs.empty()) continue;
1200
1201     // For the EK_LabelDifference32 entry, if the target supports .set, emit a
1202     // .set directive for each unique entry.  This reduces the number of
1203     // relocations the assembler will generate for the jump table.
1204     if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
1205         MAI->hasSetDirective()) {
1206       SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
1207       const TargetLowering *TLI = TM.getTargetLowering();
1208       const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
1209       for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
1210         const MachineBasicBlock *MBB = JTBBs[ii];
1211         if (!EmittedSets.insert(MBB)) continue;
1212
1213         // .set LJTSet, LBB32-base
1214         const MCExpr *LHS =
1215           MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1216         OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
1217                                 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
1218       }
1219     }
1220
1221     // On some targets (e.g. Darwin) we want to emit two consecutive labels
1222     // before each jump table.  The first label is never referenced, but tells
1223     // the assembler and linker the extents of the jump table object.  The
1224     // second label is actually referenced by the code.
1225     if (JTInDiffSection && DL->hasLinkerPrivateGlobalPrefix())
1226       // FIXME: This doesn't have to have any specific name, just any randomly
1227       // named and numbered 'l' label would work.  Simplify GetJTISymbol.
1228       OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
1229
1230     OutStreamer.EmitLabel(GetJTISymbol(JTI));
1231
1232     for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
1233       EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
1234   }
1235   if (!JTInDiffSection)
1236     OutStreamer.EmitDataRegion(MCDR_DataRegionEnd);
1237 }
1238
1239 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
1240 /// current stream.
1241 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
1242                                     const MachineBasicBlock *MBB,
1243                                     unsigned UID) const {
1244   assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
1245   const MCExpr *Value = 0;
1246   switch (MJTI->getEntryKind()) {
1247   case MachineJumpTableInfo::EK_Inline:
1248     llvm_unreachable("Cannot emit EK_Inline jump table entry");
1249   case MachineJumpTableInfo::EK_Custom32:
1250     Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, UID,
1251                                                               OutContext);
1252     break;
1253   case MachineJumpTableInfo::EK_BlockAddress:
1254     // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1255     //     .word LBB123
1256     Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1257     break;
1258   case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
1259     // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
1260     // with a relocation as gp-relative, e.g.:
1261     //     .gprel32 LBB123
1262     MCSymbol *MBBSym = MBB->getSymbol();
1263     OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1264     return;
1265   }
1266
1267   case MachineJumpTableInfo::EK_GPRel64BlockAddress: {
1268     // EK_GPRel64BlockAddress - Each entry is an address of block, encoded
1269     // with a relocation as gp-relative, e.g.:
1270     //     .gpdword LBB123
1271     MCSymbol *MBBSym = MBB->getSymbol();
1272     OutStreamer.EmitGPRel64Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1273     return;
1274   }
1275
1276   case MachineJumpTableInfo::EK_LabelDifference32: {
1277     // EK_LabelDifference32 - Each entry is the address of the block minus
1278     // the address of the jump table.  This is used for PIC jump tables where
1279     // gprel32 is not supported.  e.g.:
1280     //      .word LBB123 - LJTI1_2
1281     // If the .set directive is supported, this is emitted as:
1282     //      .set L4_5_set_123, LBB123 - LJTI1_2
1283     //      .word L4_5_set_123
1284
1285     // If we have emitted set directives for the jump table entries, print
1286     // them rather than the entries themselves.  If we're emitting PIC, then
1287     // emit the table entries as differences between two text section labels.
1288     if (MAI->hasSetDirective()) {
1289       // If we used .set, reference the .set's symbol.
1290       Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
1291                                       OutContext);
1292       break;
1293     }
1294     // Otherwise, use the difference as the jump table entry.
1295     Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1296     const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
1297     Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
1298     break;
1299   }
1300   }
1301
1302   assert(Value && "Unknown entry kind!");
1303
1304   unsigned EntrySize = MJTI->getEntrySize(*TM.getDataLayout());
1305   OutStreamer.EmitValue(Value, EntrySize);
1306 }
1307
1308
1309 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
1310 /// special global used by LLVM.  If so, emit it and return true, otherwise
1311 /// do nothing and return false.
1312 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
1313   if (GV->getName() == "llvm.used") {
1314     if (MAI->hasNoDeadStrip())    // No need to emit this at all.
1315       EmitLLVMUsedList(cast<ConstantArray>(GV->getInitializer()));
1316     return true;
1317   }
1318
1319   // Ignore debug and non-emitted data.  This handles llvm.compiler.used.
1320   if (GV->getSection() == "llvm.metadata" ||
1321       GV->hasAvailableExternallyLinkage())
1322     return true;
1323
1324   if (!GV->hasAppendingLinkage()) return false;
1325
1326   assert(GV->hasInitializer() && "Not a special LLVM global!");
1327
1328   if (GV->getName() == "llvm.global_ctors") {
1329     EmitXXStructorList(GV->getInitializer(), /* isCtor */ true);
1330
1331     if (TM.getRelocationModel() == Reloc::Static &&
1332         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1333       StringRef Sym(".constructors_used");
1334       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1335                                       MCSA_Reference);
1336     }
1337     return true;
1338   }
1339
1340   if (GV->getName() == "llvm.global_dtors") {
1341     EmitXXStructorList(GV->getInitializer(), /* isCtor */ false);
1342
1343     if (TM.getRelocationModel() == Reloc::Static &&
1344         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1345       StringRef Sym(".destructors_used");
1346       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1347                                       MCSA_Reference);
1348     }
1349     return true;
1350   }
1351
1352   return false;
1353 }
1354
1355 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
1356 /// global in the specified llvm.used list for which emitUsedDirectiveFor
1357 /// is true, as being used with this directive.
1358 void AsmPrinter::EmitLLVMUsedList(const ConstantArray *InitList) {
1359   // Should be an array of 'i8*'.
1360   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1361     const GlobalValue *GV =
1362       dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
1363     if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, *Mang))
1364       OutStreamer.EmitSymbolAttribute(getSymbol(GV), MCSA_NoDeadStrip);
1365   }
1366 }
1367
1368 /// EmitXXStructorList - Emit the ctor or dtor list taking into account the init
1369 /// priority.
1370 void AsmPrinter::EmitXXStructorList(const Constant *List, bool isCtor) {
1371   // Should be an array of '{ int, void ()* }' structs.  The first value is the
1372   // init priority.
1373   if (!isa<ConstantArray>(List)) return;
1374
1375   // Sanity check the structors list.
1376   const ConstantArray *InitList = dyn_cast<ConstantArray>(List);
1377   if (!InitList) return; // Not an array!
1378   StructType *ETy = dyn_cast<StructType>(InitList->getType()->getElementType());
1379   if (!ETy || ETy->getNumElements() != 2) return; // Not an array of pairs!
1380   if (!isa<IntegerType>(ETy->getTypeAtIndex(0U)) ||
1381       !isa<PointerType>(ETy->getTypeAtIndex(1U))) return; // Not (int, ptr).
1382
1383   // Gather the structors in a form that's convenient for sorting by priority.
1384   typedef std::pair<unsigned, Constant *> Structor;
1385   SmallVector<Structor, 8> Structors;
1386   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1387     ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i));
1388     if (!CS) continue; // Malformed.
1389     if (CS->getOperand(1)->isNullValue())
1390       break;  // Found a null terminator, skip the rest.
1391     ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0));
1392     if (!Priority) continue; // Malformed.
1393     Structors.push_back(std::make_pair(Priority->getLimitedValue(65535),
1394                                        CS->getOperand(1)));
1395   }
1396
1397   // Emit the function pointers in the target-specific order
1398   const DataLayout *DL = TM.getDataLayout();
1399   unsigned Align = Log2_32(DL->getPointerPrefAlignment());
1400   std::stable_sort(Structors.begin(), Structors.end(), less_first());
1401   for (unsigned i = 0, e = Structors.size(); i != e; ++i) {
1402     const MCSection *OutputSection =
1403       (isCtor ?
1404        getObjFileLowering().getStaticCtorSection(Structors[i].first) :
1405        getObjFileLowering().getStaticDtorSection(Structors[i].first));
1406     OutStreamer.SwitchSection(OutputSection);
1407     if (OutStreamer.getCurrentSection() != OutStreamer.getPreviousSection())
1408       EmitAlignment(Align);
1409     EmitXXStructor(Structors[i].second);
1410   }
1411 }
1412
1413 void AsmPrinter::EmitModuleIdents(Module &M) {
1414   if (!MAI->hasIdentDirective())
1415     return;
1416
1417   if (const NamedMDNode *NMD = M.getNamedMetadata("llvm.ident")) {
1418     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1419       const MDNode *N = NMD->getOperand(i);
1420       assert(N->getNumOperands() == 1 &&
1421              "llvm.ident metadata entry can have only one operand");
1422       const MDString *S = cast<MDString>(N->getOperand(0));
1423       OutStreamer.EmitIdent(S->getString());
1424     }
1425   }
1426 }
1427
1428 //===--------------------------------------------------------------------===//
1429 // Emission and print routines
1430 //
1431
1432 /// EmitInt8 - Emit a byte directive and value.
1433 ///
1434 void AsmPrinter::EmitInt8(int Value) const {
1435   OutStreamer.EmitIntValue(Value, 1);
1436 }
1437
1438 /// EmitInt16 - Emit a short directive and value.
1439 ///
1440 void AsmPrinter::EmitInt16(int Value) const {
1441   OutStreamer.EmitIntValue(Value, 2);
1442 }
1443
1444 /// EmitInt32 - Emit a long directive and value.
1445 ///
1446 void AsmPrinter::EmitInt32(int Value) const {
1447   OutStreamer.EmitIntValue(Value, 4);
1448 }
1449
1450 /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
1451 /// in bytes of the directive is specified by Size and Hi/Lo specify the
1452 /// labels.  This implicitly uses .set if it is available.
1453 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
1454                                      unsigned Size) const {
1455   // Get the Hi-Lo expression.
1456   const MCExpr *Diff =
1457     MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(Hi, OutContext),
1458                             MCSymbolRefExpr::Create(Lo, OutContext),
1459                             OutContext);
1460
1461   if (!MAI->hasSetDirective()) {
1462     OutStreamer.EmitValue(Diff, Size);
1463     return;
1464   }
1465
1466   // Otherwise, emit with .set (aka assignment).
1467   MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1468   OutStreamer.EmitAssignment(SetLabel, Diff);
1469   OutStreamer.EmitSymbolValue(SetLabel, Size);
1470 }
1471
1472 /// EmitLabelOffsetDifference - Emit something like ".long Hi+Offset-Lo"
1473 /// where the size in bytes of the directive is specified by Size and Hi/Lo
1474 /// specify the labels.  This implicitly uses .set if it is available.
1475 void AsmPrinter::EmitLabelOffsetDifference(const MCSymbol *Hi, uint64_t Offset,
1476                                            const MCSymbol *Lo,
1477                                            unsigned Size) const {
1478
1479   // Emit Hi+Offset - Lo
1480   // Get the Hi+Offset expression.
1481   const MCExpr *Plus =
1482     MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(Hi, OutContext),
1483                             MCConstantExpr::Create(Offset, OutContext),
1484                             OutContext);
1485
1486   // Get the Hi+Offset-Lo expression.
1487   const MCExpr *Diff =
1488     MCBinaryExpr::CreateSub(Plus,
1489                             MCSymbolRefExpr::Create(Lo, OutContext),
1490                             OutContext);
1491
1492   if (!MAI->hasSetDirective())
1493     OutStreamer.EmitValue(Diff, Size);
1494   else {
1495     // Otherwise, emit with .set (aka assignment).
1496     MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1497     OutStreamer.EmitAssignment(SetLabel, Diff);
1498     OutStreamer.EmitSymbolValue(SetLabel, Size);
1499   }
1500 }
1501
1502 /// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
1503 /// where the size in bytes of the directive is specified by Size and Label
1504 /// specifies the label.  This implicitly uses .set if it is available.
1505 void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
1506                                      unsigned Size,
1507                                      bool IsSectionRelative) const {
1508   if (MAI->needsDwarfSectionOffsetDirective() && IsSectionRelative) {
1509     OutStreamer.EmitCOFFSecRel32(Label);
1510     return;
1511   }
1512
1513   // Emit Label+Offset (or just Label if Offset is zero)
1514   const MCExpr *Expr = MCSymbolRefExpr::Create(Label, OutContext);
1515   if (Offset)
1516     Expr = MCBinaryExpr::CreateAdd(
1517         Expr, MCConstantExpr::Create(Offset, OutContext), OutContext);
1518
1519   OutStreamer.EmitValue(Expr, Size);
1520 }
1521
1522 //===----------------------------------------------------------------------===//
1523
1524 // EmitAlignment - Emit an alignment directive to the specified power of
1525 // two boundary.  For example, if you pass in 3 here, you will get an 8
1526 // byte alignment.  If a global value is specified, and if that global has
1527 // an explicit alignment requested, it will override the alignment request
1528 // if required for correctness.
1529 //
1530 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV) const {
1531   if (GV) NumBits = getGVAlignmentLog2(GV, *TM.getDataLayout(), NumBits);
1532
1533   if (NumBits == 0) return;   // 1-byte aligned: no need to emit alignment.
1534
1535   if (getCurrentSection()->getKind().isText())
1536     OutStreamer.EmitCodeAlignment(1 << NumBits);
1537   else
1538     OutStreamer.EmitValueToAlignment(1 << NumBits);
1539 }
1540
1541 //===----------------------------------------------------------------------===//
1542 // Constant emission.
1543 //===----------------------------------------------------------------------===//
1544
1545 /// lowerConstant - Lower the specified LLVM Constant to an MCExpr.
1546 ///
1547 static const MCExpr *lowerConstant(const Constant *CV, AsmPrinter &AP) {
1548   MCContext &Ctx = AP.OutContext;
1549
1550   if (CV->isNullValue() || isa<UndefValue>(CV))
1551     return MCConstantExpr::Create(0, Ctx);
1552
1553   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
1554     return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
1555
1556   if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
1557     return MCSymbolRefExpr::Create(AP.getSymbol(GV), Ctx);
1558
1559   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
1560     return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
1561
1562   const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
1563   if (CE == 0) {
1564     llvm_unreachable("Unknown constant value to lower!");
1565   }
1566
1567   if (const MCExpr *RelocExpr =
1568           AP.getObjFileLowering().getExecutableRelativeSymbol(CE, *AP.Mang))
1569     return RelocExpr;
1570
1571   switch (CE->getOpcode()) {
1572   default:
1573     // If the code isn't optimized, there may be outstanding folding
1574     // opportunities. Attempt to fold the expression using DataLayout as a
1575     // last resort before giving up.
1576     if (Constant *C =
1577           ConstantFoldConstantExpression(CE, AP.TM.getDataLayout()))
1578       if (C != CE)
1579         return lowerConstant(C, AP);
1580
1581     // Otherwise report the problem to the user.
1582     {
1583       std::string S;
1584       raw_string_ostream OS(S);
1585       OS << "Unsupported expression in static initializer: ";
1586       CE->printAsOperand(OS, /*PrintType=*/false,
1587                      !AP.MF ? 0 : AP.MF->getFunction()->getParent());
1588       report_fatal_error(OS.str());
1589     }
1590   case Instruction::GetElementPtr: {
1591     const DataLayout &DL = *AP.TM.getDataLayout();
1592     // Generate a symbolic expression for the byte address
1593     APInt OffsetAI(DL.getPointerTypeSizeInBits(CE->getType()), 0);
1594     cast<GEPOperator>(CE)->accumulateConstantOffset(DL, OffsetAI);
1595
1596     const MCExpr *Base = lowerConstant(CE->getOperand(0), AP);
1597     if (!OffsetAI)
1598       return Base;
1599
1600     int64_t Offset = OffsetAI.getSExtValue();
1601     return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
1602                                    Ctx);
1603   }
1604
1605   case Instruction::Trunc:
1606     // We emit the value and depend on the assembler to truncate the generated
1607     // expression properly.  This is important for differences between
1608     // blockaddress labels.  Since the two labels are in the same function, it
1609     // is reasonable to treat their delta as a 32-bit value.
1610     // FALL THROUGH.
1611   case Instruction::BitCast:
1612     return lowerConstant(CE->getOperand(0), AP);
1613
1614   case Instruction::IntToPtr: {
1615     const DataLayout &DL = *AP.TM.getDataLayout();
1616     // Handle casts to pointers by changing them into casts to the appropriate
1617     // integer type.  This promotes constant folding and simplifies this code.
1618     Constant *Op = CE->getOperand(0);
1619     Op = ConstantExpr::getIntegerCast(Op, DL.getIntPtrType(CV->getType()),
1620                                       false/*ZExt*/);
1621     return lowerConstant(Op, AP);
1622   }
1623
1624   case Instruction::PtrToInt: {
1625     const DataLayout &DL = *AP.TM.getDataLayout();
1626     // Support only foldable casts to/from pointers that can be eliminated by
1627     // changing the pointer to the appropriately sized integer type.
1628     Constant *Op = CE->getOperand(0);
1629     Type *Ty = CE->getType();
1630
1631     const MCExpr *OpExpr = lowerConstant(Op, AP);
1632
1633     // We can emit the pointer value into this slot if the slot is an
1634     // integer slot equal to the size of the pointer.
1635     if (DL.getTypeAllocSize(Ty) == DL.getTypeAllocSize(Op->getType()))
1636       return OpExpr;
1637
1638     // Otherwise the pointer is smaller than the resultant integer, mask off
1639     // the high bits so we are sure to get a proper truncation if the input is
1640     // a constant expr.
1641     unsigned InBits = DL.getTypeAllocSizeInBits(Op->getType());
1642     const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
1643     return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
1644   }
1645
1646   // The MC library also has a right-shift operator, but it isn't consistently
1647   // signed or unsigned between different targets.
1648   case Instruction::Add:
1649   case Instruction::Sub:
1650   case Instruction::Mul:
1651   case Instruction::SDiv:
1652   case Instruction::SRem:
1653   case Instruction::Shl:
1654   case Instruction::And:
1655   case Instruction::Or:
1656   case Instruction::Xor: {
1657     const MCExpr *LHS = lowerConstant(CE->getOperand(0), AP);
1658     const MCExpr *RHS = lowerConstant(CE->getOperand(1), AP);
1659     switch (CE->getOpcode()) {
1660     default: llvm_unreachable("Unknown binary operator constant cast expr");
1661     case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
1662     case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
1663     case Instruction::Mul: return MCBinaryExpr::CreateMul(LHS, RHS, Ctx);
1664     case Instruction::SDiv: return MCBinaryExpr::CreateDiv(LHS, RHS, Ctx);
1665     case Instruction::SRem: return MCBinaryExpr::CreateMod(LHS, RHS, Ctx);
1666     case Instruction::Shl: return MCBinaryExpr::CreateShl(LHS, RHS, Ctx);
1667     case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
1668     case Instruction::Or:  return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
1669     case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
1670     }
1671   }
1672   }
1673 }
1674
1675 static void emitGlobalConstantImpl(const Constant *C, AsmPrinter &AP);
1676
1677 /// isRepeatedByteSequence - Determine whether the given value is
1678 /// composed of a repeated sequence of identical bytes and return the
1679 /// byte value.  If it is not a repeated sequence, return -1.
1680 static int isRepeatedByteSequence(const ConstantDataSequential *V) {
1681   StringRef Data = V->getRawDataValues();
1682   assert(!Data.empty() && "Empty aggregates should be CAZ node");
1683   char C = Data[0];
1684   for (unsigned i = 1, e = Data.size(); i != e; ++i)
1685     if (Data[i] != C) return -1;
1686   return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1.
1687 }
1688
1689
1690 /// isRepeatedByteSequence - Determine whether the given value is
1691 /// composed of a repeated sequence of identical bytes and return the
1692 /// byte value.  If it is not a repeated sequence, return -1.
1693 static int isRepeatedByteSequence(const Value *V, TargetMachine &TM) {
1694
1695   if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
1696     if (CI->getBitWidth() > 64) return -1;
1697
1698     uint64_t Size = TM.getDataLayout()->getTypeAllocSize(V->getType());
1699     uint64_t Value = CI->getZExtValue();
1700
1701     // Make sure the constant is at least 8 bits long and has a power
1702     // of 2 bit width.  This guarantees the constant bit width is
1703     // always a multiple of 8 bits, avoiding issues with padding out
1704     // to Size and other such corner cases.
1705     if (CI->getBitWidth() < 8 || !isPowerOf2_64(CI->getBitWidth())) return -1;
1706
1707     uint8_t Byte = static_cast<uint8_t>(Value);
1708
1709     for (unsigned i = 1; i < Size; ++i) {
1710       Value >>= 8;
1711       if (static_cast<uint8_t>(Value) != Byte) return -1;
1712     }
1713     return Byte;
1714   }
1715   if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) {
1716     // Make sure all array elements are sequences of the same repeated
1717     // byte.
1718     assert(CA->getNumOperands() != 0 && "Should be a CAZ");
1719     int Byte = isRepeatedByteSequence(CA->getOperand(0), TM);
1720     if (Byte == -1) return -1;
1721
1722     for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1723       int ThisByte = isRepeatedByteSequence(CA->getOperand(i), TM);
1724       if (ThisByte == -1) return -1;
1725       if (Byte != ThisByte) return -1;
1726     }
1727     return Byte;
1728   }
1729
1730   if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V))
1731     return isRepeatedByteSequence(CDS);
1732
1733   return -1;
1734 }
1735
1736 static void emitGlobalConstantDataSequential(const ConstantDataSequential *CDS,
1737                                              AsmPrinter &AP){
1738
1739   // See if we can aggregate this into a .fill, if so, emit it as such.
1740   int Value = isRepeatedByteSequence(CDS, AP.TM);
1741   if (Value != -1) {
1742     uint64_t Bytes = AP.TM.getDataLayout()->getTypeAllocSize(CDS->getType());
1743     // Don't emit a 1-byte object as a .fill.
1744     if (Bytes > 1)
1745       return AP.OutStreamer.EmitFill(Bytes, Value);
1746   }
1747
1748   // If this can be emitted with .ascii/.asciz, emit it as such.
1749   if (CDS->isString())
1750     return AP.OutStreamer.EmitBytes(CDS->getAsString());
1751
1752   // Otherwise, emit the values in successive locations.
1753   unsigned ElementByteSize = CDS->getElementByteSize();
1754   if (isa<IntegerType>(CDS->getElementType())) {
1755     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1756       if (AP.isVerbose())
1757         AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1758                                                 CDS->getElementAsInteger(i));
1759       AP.OutStreamer.EmitIntValue(CDS->getElementAsInteger(i),
1760                                   ElementByteSize);
1761     }
1762   } else if (ElementByteSize == 4) {
1763     // FP Constants are printed as integer constants to avoid losing
1764     // precision.
1765     assert(CDS->getElementType()->isFloatTy());
1766     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1767       union {
1768         float F;
1769         uint32_t I;
1770       };
1771
1772       F = CDS->getElementAsFloat(i);
1773       if (AP.isVerbose())
1774         AP.OutStreamer.GetCommentOS() << "float " << F << '\n';
1775       AP.OutStreamer.EmitIntValue(I, 4);
1776     }
1777   } else {
1778     assert(CDS->getElementType()->isDoubleTy());
1779     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1780       union {
1781         double F;
1782         uint64_t I;
1783       };
1784
1785       F = CDS->getElementAsDouble(i);
1786       if (AP.isVerbose())
1787         AP.OutStreamer.GetCommentOS() << "double " << F << '\n';
1788       AP.OutStreamer.EmitIntValue(I, 8);
1789     }
1790   }
1791
1792   const DataLayout &DL = *AP.TM.getDataLayout();
1793   unsigned Size = DL.getTypeAllocSize(CDS->getType());
1794   unsigned EmittedSize = DL.getTypeAllocSize(CDS->getType()->getElementType()) *
1795                         CDS->getNumElements();
1796   if (unsigned Padding = Size - EmittedSize)
1797     AP.OutStreamer.EmitZeros(Padding);
1798
1799 }
1800
1801 static void emitGlobalConstantArray(const ConstantArray *CA, AsmPrinter &AP) {
1802   // See if we can aggregate some values.  Make sure it can be
1803   // represented as a series of bytes of the constant value.
1804   int Value = isRepeatedByteSequence(CA, AP.TM);
1805
1806   if (Value != -1) {
1807     uint64_t Bytes = AP.TM.getDataLayout()->getTypeAllocSize(CA->getType());
1808     AP.OutStreamer.EmitFill(Bytes, Value);
1809   }
1810   else {
1811     for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1812       emitGlobalConstantImpl(CA->getOperand(i), AP);
1813   }
1814 }
1815
1816 static void emitGlobalConstantVector(const ConstantVector *CV, AsmPrinter &AP) {
1817   for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1818     emitGlobalConstantImpl(CV->getOperand(i), AP);
1819
1820   const DataLayout &DL = *AP.TM.getDataLayout();
1821   unsigned Size = DL.getTypeAllocSize(CV->getType());
1822   unsigned EmittedSize = DL.getTypeAllocSize(CV->getType()->getElementType()) *
1823                          CV->getType()->getNumElements();
1824   if (unsigned Padding = Size - EmittedSize)
1825     AP.OutStreamer.EmitZeros(Padding);
1826 }
1827
1828 static void emitGlobalConstantStruct(const ConstantStruct *CS, AsmPrinter &AP) {
1829   // Print the fields in successive locations. Pad to align if needed!
1830   const DataLayout *DL = AP.TM.getDataLayout();
1831   unsigned Size = DL->getTypeAllocSize(CS->getType());
1832   const StructLayout *Layout = DL->getStructLayout(CS->getType());
1833   uint64_t SizeSoFar = 0;
1834   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1835     const Constant *Field = CS->getOperand(i);
1836
1837     // Check if padding is needed and insert one or more 0s.
1838     uint64_t FieldSize = DL->getTypeAllocSize(Field->getType());
1839     uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1840                         - Layout->getElementOffset(i)) - FieldSize;
1841     SizeSoFar += FieldSize + PadSize;
1842
1843     // Now print the actual field value.
1844     emitGlobalConstantImpl(Field, AP);
1845
1846     // Insert padding - this may include padding to increase the size of the
1847     // current field up to the ABI size (if the struct is not packed) as well
1848     // as padding to ensure that the next field starts at the right offset.
1849     AP.OutStreamer.EmitZeros(PadSize);
1850   }
1851   assert(SizeSoFar == Layout->getSizeInBytes() &&
1852          "Layout of constant struct may be incorrect!");
1853 }
1854
1855 static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) {
1856   APInt API = CFP->getValueAPF().bitcastToAPInt();
1857
1858   // First print a comment with what we think the original floating-point value
1859   // should have been.
1860   if (AP.isVerbose()) {
1861     SmallString<8> StrVal;
1862     CFP->getValueAPF().toString(StrVal);
1863
1864     CFP->getType()->print(AP.OutStreamer.GetCommentOS());
1865     AP.OutStreamer.GetCommentOS() << ' ' << StrVal << '\n';
1866   }
1867
1868   // Now iterate through the APInt chunks, emitting them in endian-correct
1869   // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit
1870   // floats).
1871   unsigned NumBytes = API.getBitWidth() / 8;
1872   unsigned TrailingBytes = NumBytes % sizeof(uint64_t);
1873   const uint64_t *p = API.getRawData();
1874
1875   // PPC's long double has odd notions of endianness compared to how LLVM
1876   // handles it: p[0] goes first for *big* endian on PPC.
1877   if (AP.TM.getDataLayout()->isBigEndian() != CFP->getType()->isPPC_FP128Ty()) {
1878     int Chunk = API.getNumWords() - 1;
1879
1880     if (TrailingBytes)
1881       AP.OutStreamer.EmitIntValue(p[Chunk--], TrailingBytes);
1882
1883     for (; Chunk >= 0; --Chunk)
1884       AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1885   } else {
1886     unsigned Chunk;
1887     for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk)
1888       AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1889
1890     if (TrailingBytes)
1891       AP.OutStreamer.EmitIntValue(p[Chunk], TrailingBytes);
1892   }
1893
1894   // Emit the tail padding for the long double.
1895   const DataLayout &DL = *AP.TM.getDataLayout();
1896   AP.OutStreamer.EmitZeros(DL.getTypeAllocSize(CFP->getType()) -
1897                            DL.getTypeStoreSize(CFP->getType()));
1898 }
1899
1900 static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP) {
1901   const DataLayout *DL = AP.TM.getDataLayout();
1902   unsigned BitWidth = CI->getBitWidth();
1903
1904   // Copy the value as we may massage the layout for constants whose bit width
1905   // is not a multiple of 64-bits.
1906   APInt Realigned(CI->getValue());
1907   uint64_t ExtraBits = 0;
1908   unsigned ExtraBitsSize = BitWidth & 63;
1909
1910   if (ExtraBitsSize) {
1911     // The bit width of the data is not a multiple of 64-bits.
1912     // The extra bits are expected to be at the end of the chunk of the memory.
1913     // Little endian:
1914     // * Nothing to be done, just record the extra bits to emit.
1915     // Big endian:
1916     // * Record the extra bits to emit.
1917     // * Realign the raw data to emit the chunks of 64-bits.
1918     if (DL->isBigEndian()) {
1919       // Basically the structure of the raw data is a chunk of 64-bits cells:
1920       //    0        1         BitWidth / 64
1921       // [chunk1][chunk2] ... [chunkN].
1922       // The most significant chunk is chunkN and it should be emitted first.
1923       // However, due to the alignment issue chunkN contains useless bits.
1924       // Realign the chunks so that they contain only useless information:
1925       // ExtraBits     0       1       (BitWidth / 64) - 1
1926       //       chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN]
1927       ExtraBits = Realigned.getRawData()[0] &
1928         (((uint64_t)-1) >> (64 - ExtraBitsSize));
1929       Realigned = Realigned.lshr(ExtraBitsSize);
1930     } else
1931       ExtraBits = Realigned.getRawData()[BitWidth / 64];
1932   }
1933
1934   // We don't expect assemblers to support integer data directives
1935   // for more than 64 bits, so we emit the data in at most 64-bit
1936   // quantities at a time.
1937   const uint64_t *RawData = Realigned.getRawData();
1938   for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1939     uint64_t Val = DL->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1940     AP.OutStreamer.EmitIntValue(Val, 8);
1941   }
1942
1943   if (ExtraBitsSize) {
1944     // Emit the extra bits after the 64-bits chunks.
1945
1946     // Emit a directive that fills the expected size.
1947     uint64_t Size = AP.TM.getDataLayout()->getTypeAllocSize(CI->getType());
1948     Size -= (BitWidth / 64) * 8;
1949     assert(Size && Size * 8 >= ExtraBitsSize &&
1950            (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize)))
1951            == ExtraBits && "Directive too small for extra bits.");
1952     AP.OutStreamer.EmitIntValue(ExtraBits, Size);
1953   }
1954 }
1955
1956 static void emitGlobalConstantImpl(const Constant *CV, AsmPrinter &AP) {
1957   const DataLayout *DL = AP.TM.getDataLayout();
1958   uint64_t Size = DL->getTypeAllocSize(CV->getType());
1959   if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV))
1960     return AP.OutStreamer.EmitZeros(Size);
1961
1962   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1963     switch (Size) {
1964     case 1:
1965     case 2:
1966     case 4:
1967     case 8:
1968       if (AP.isVerbose())
1969         AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1970                                                 CI->getZExtValue());
1971       AP.OutStreamer.EmitIntValue(CI->getZExtValue(), Size);
1972       return;
1973     default:
1974       emitGlobalConstantLargeInt(CI, AP);
1975       return;
1976     }
1977   }
1978
1979   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1980     return emitGlobalConstantFP(CFP, AP);
1981
1982   if (isa<ConstantPointerNull>(CV)) {
1983     AP.OutStreamer.EmitIntValue(0, Size);
1984     return;
1985   }
1986
1987   if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(CV))
1988     return emitGlobalConstantDataSequential(CDS, AP);
1989
1990   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1991     return emitGlobalConstantArray(CVA, AP);
1992
1993   if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1994     return emitGlobalConstantStruct(CVS, AP);
1995
1996   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1997     // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of
1998     // vectors).
1999     if (CE->getOpcode() == Instruction::BitCast)
2000       return emitGlobalConstantImpl(CE->getOperand(0), AP);
2001
2002     if (Size > 8) {
2003       // If the constant expression's size is greater than 64-bits, then we have
2004       // to emit the value in chunks. Try to constant fold the value and emit it
2005       // that way.
2006       Constant *New = ConstantFoldConstantExpression(CE, DL);
2007       if (New && New != CE)
2008         return emitGlobalConstantImpl(New, AP);
2009     }
2010   }
2011
2012   if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
2013     return emitGlobalConstantVector(V, AP);
2014
2015   // Otherwise, it must be a ConstantExpr.  Lower it to an MCExpr, then emit it
2016   // thread the streamer with EmitValue.
2017   AP.OutStreamer.EmitValue(lowerConstant(CV, AP), Size);
2018 }
2019
2020 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
2021 void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
2022   uint64_t Size = TM.getDataLayout()->getTypeAllocSize(CV->getType());
2023   if (Size)
2024     emitGlobalConstantImpl(CV, *this);
2025   else if (MAI->hasSubsectionsViaSymbols()) {
2026     // If the global has zero size, emit a single byte so that two labels don't
2027     // look like they are at the same location.
2028     OutStreamer.EmitIntValue(0, 1);
2029   }
2030 }
2031
2032 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
2033   // Target doesn't support this yet!
2034   llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
2035 }
2036
2037 void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const {
2038   if (Offset > 0)
2039     OS << '+' << Offset;
2040   else if (Offset < 0)
2041     OS << Offset;
2042 }
2043
2044 //===----------------------------------------------------------------------===//
2045 // Symbol Lowering Routines.
2046 //===----------------------------------------------------------------------===//
2047
2048 /// GetTempSymbol - Return the MCSymbol corresponding to the assembler
2049 /// temporary label with the specified stem and unique ID.
2050 MCSymbol *AsmPrinter::GetTempSymbol(StringRef Name, unsigned ID) const {
2051   const DataLayout *DL = TM.getDataLayout();
2052   return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix()) +
2053                                       Name + Twine(ID));
2054 }
2055
2056 /// GetTempSymbol - Return an assembler temporary label with the specified
2057 /// stem.
2058 MCSymbol *AsmPrinter::GetTempSymbol(StringRef Name) const {
2059   const DataLayout *DL = TM.getDataLayout();
2060   return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix())+
2061                                       Name);
2062 }
2063
2064
2065 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
2066   return MMI->getAddrLabelSymbol(BA->getBasicBlock());
2067 }
2068
2069 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const {
2070   return MMI->getAddrLabelSymbol(BB);
2071 }
2072
2073 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
2074 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
2075   const DataLayout *DL = TM.getDataLayout();
2076   return OutContext.GetOrCreateSymbol
2077     (Twine(DL->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber())
2078      + "_" + Twine(CPID));
2079 }
2080
2081 /// GetJTISymbol - Return the symbol for the specified jump table entry.
2082 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
2083   return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
2084 }
2085
2086 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
2087 /// FIXME: privatize to AsmPrinter.
2088 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
2089   const DataLayout *DL = TM.getDataLayout();
2090   return OutContext.GetOrCreateSymbol
2091   (Twine(DL->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" +
2092    Twine(UID) + "_set_" + Twine(MBBID));
2093 }
2094
2095 MCSymbol *AsmPrinter::getSymbolWithGlobalValueBase(const GlobalValue *GV,
2096                                                    StringRef Suffix) const {
2097   return getObjFileLowering().getSymbolWithGlobalValueBase(GV, Suffix, *Mang);
2098 }
2099
2100 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
2101 /// ExternalSymbol.
2102 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
2103   SmallString<60> NameStr;
2104   Mang->getNameWithPrefix(NameStr, Sym);
2105   return OutContext.GetOrCreateSymbol(NameStr.str());
2106 }
2107
2108
2109
2110 /// PrintParentLoopComment - Print comments about parent loops of this one.
2111 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2112                                    unsigned FunctionNumber) {
2113   if (Loop == 0) return;
2114   PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
2115   OS.indent(Loop->getLoopDepth()*2)
2116     << "Parent Loop BB" << FunctionNumber << "_"
2117     << Loop->getHeader()->getNumber()
2118     << " Depth=" << Loop->getLoopDepth() << '\n';
2119 }
2120
2121
2122 /// PrintChildLoopComment - Print comments about child loops within
2123 /// the loop for this basic block, with nesting.
2124 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2125                                   unsigned FunctionNumber) {
2126   // Add child loop information
2127   for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
2128     OS.indent((*CL)->getLoopDepth()*2)
2129       << "Child Loop BB" << FunctionNumber << "_"
2130       << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
2131       << '\n';
2132     PrintChildLoopComment(OS, *CL, FunctionNumber);
2133   }
2134 }
2135
2136 /// emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
2137 static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB,
2138                                        const MachineLoopInfo *LI,
2139                                        const AsmPrinter &AP) {
2140   // Add loop depth information
2141   const MachineLoop *Loop = LI->getLoopFor(&MBB);
2142   if (Loop == 0) return;
2143
2144   MachineBasicBlock *Header = Loop->getHeader();
2145   assert(Header && "No header for loop");
2146
2147   // If this block is not a loop header, just print out what is the loop header
2148   // and return.
2149   if (Header != &MBB) {
2150     AP.OutStreamer.AddComment("  in Loop: Header=BB" +
2151                               Twine(AP.getFunctionNumber())+"_" +
2152                               Twine(Loop->getHeader()->getNumber())+
2153                               " Depth="+Twine(Loop->getLoopDepth()));
2154     return;
2155   }
2156
2157   // Otherwise, it is a loop header.  Print out information about child and
2158   // parent loops.
2159   raw_ostream &OS = AP.OutStreamer.GetCommentOS();
2160
2161   PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
2162
2163   OS << "=>";
2164   OS.indent(Loop->getLoopDepth()*2-2);
2165
2166   OS << "This ";
2167   if (Loop->empty())
2168     OS << "Inner ";
2169   OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
2170
2171   PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
2172 }
2173
2174
2175 /// EmitBasicBlockStart - This method prints the label for the specified
2176 /// MachineBasicBlock, an alignment (if present) and a comment describing
2177 /// it if appropriate.
2178 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
2179   // Emit an alignment directive for this block, if needed.
2180   if (unsigned Align = MBB->getAlignment())
2181     EmitAlignment(Align);
2182
2183   // If the block has its address taken, emit any labels that were used to
2184   // reference the block.  It is possible that there is more than one label
2185   // here, because multiple LLVM BB's may have been RAUW'd to this block after
2186   // the references were generated.
2187   if (MBB->hasAddressTaken()) {
2188     const BasicBlock *BB = MBB->getBasicBlock();
2189     if (isVerbose())
2190       OutStreamer.AddComment("Block address taken");
2191
2192     std::vector<MCSymbol*> Syms = MMI->getAddrLabelSymbolToEmit(BB);
2193
2194     for (unsigned i = 0, e = Syms.size(); i != e; ++i)
2195       OutStreamer.EmitLabel(Syms[i]);
2196   }
2197
2198   // Print some verbose block comments.
2199   if (isVerbose()) {
2200     if (const BasicBlock *BB = MBB->getBasicBlock())
2201       if (BB->hasName())
2202         OutStreamer.AddComment("%" + BB->getName());
2203     emitBasicBlockLoopComments(*MBB, LI, *this);
2204   }
2205
2206   // Print the main label for the block.
2207   if (MBB->pred_empty() || isBlockOnlyReachableByFallthrough(MBB)) {
2208     if (isVerbose()) {
2209       // NOTE: Want this comment at start of line, don't emit with AddComment.
2210       OutStreamer.emitRawComment(" BB#" + Twine(MBB->getNumber()) + ":", false);
2211     }
2212   } else {
2213     OutStreamer.EmitLabel(MBB->getSymbol());
2214   }
2215 }
2216
2217 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility,
2218                                 bool IsDefinition) const {
2219   MCSymbolAttr Attr = MCSA_Invalid;
2220
2221   switch (Visibility) {
2222   default: break;
2223   case GlobalValue::HiddenVisibility:
2224     if (IsDefinition)
2225       Attr = MAI->getHiddenVisibilityAttr();
2226     else
2227       Attr = MAI->getHiddenDeclarationVisibilityAttr();
2228     break;
2229   case GlobalValue::ProtectedVisibility:
2230     Attr = MAI->getProtectedVisibilityAttr();
2231     break;
2232   }
2233
2234   if (Attr != MCSA_Invalid)
2235     OutStreamer.EmitSymbolAttribute(Sym, Attr);
2236 }
2237
2238 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
2239 /// exactly one predecessor and the control transfer mechanism between
2240 /// the predecessor and this block is a fall-through.
2241 bool AsmPrinter::
2242 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
2243   // If this is a landing pad, it isn't a fall through.  If it has no preds,
2244   // then nothing falls through to it.
2245   if (MBB->isLandingPad() || MBB->pred_empty())
2246     return false;
2247
2248   // If there isn't exactly one predecessor, it can't be a fall through.
2249   MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(), PI2 = PI;
2250   ++PI2;
2251   if (PI2 != MBB->pred_end())
2252     return false;
2253
2254   // The predecessor has to be immediately before this block.
2255   MachineBasicBlock *Pred = *PI;
2256
2257   if (!Pred->isLayoutSuccessor(MBB))
2258     return false;
2259
2260   // If the block is completely empty, then it definitely does fall through.
2261   if (Pred->empty())
2262     return true;
2263
2264   // Check the terminators in the previous blocks
2265   for (MachineBasicBlock::iterator II = Pred->getFirstTerminator(),
2266          IE = Pred->end(); II != IE; ++II) {
2267     MachineInstr &MI = *II;
2268
2269     // If it is not a simple branch, we are in a table somewhere.
2270     if (!MI.isBranch() || MI.isIndirectBranch())
2271       return false;
2272
2273     // If we are the operands of one of the branches, this is not a fall
2274     // through. Note that targets with delay slots will usually bundle
2275     // terminators with the delay slot instruction.
2276     for (ConstMIBundleOperands OP(&MI); OP.isValid(); ++OP) {
2277       if (OP->isJTI())
2278         return false;
2279       if (OP->isMBB() && OP->getMBB() == MBB)
2280         return false;
2281     }
2282   }
2283
2284   return true;
2285 }
2286
2287
2288
2289 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
2290   if (!S->usesMetadata())
2291     return 0;
2292
2293   gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
2294   gcp_map_type::iterator GCPI = GCMap.find(S);
2295   if (GCPI != GCMap.end())
2296     return GCPI->second;
2297
2298   const char *Name = S->getName().c_str();
2299
2300   for (GCMetadataPrinterRegistry::iterator
2301          I = GCMetadataPrinterRegistry::begin(),
2302          E = GCMetadataPrinterRegistry::end(); I != E; ++I)
2303     if (strcmp(Name, I->getName()) == 0) {
2304       GCMetadataPrinter *GMP = I->instantiate();
2305       GMP->S = S;
2306       GCMap.insert(std::make_pair(S, GMP));
2307       return GMP;
2308     }
2309
2310   report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
2311 }
2312
2313 /// Pin vtable to this file.
2314 AsmPrinterHandler::~AsmPrinterHandler() {}