lib/CodeGen/AsmPrinter/AsmPrinter.cpp

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