lib/CodeGen/AsmPrinter/AsmPrinter.cpp

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