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(false);
 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 4-operand target-independent form.
 618   if (MI->getNumOperands() != 4)
 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
 633   DIExpression Expr = MI->getDebugExpression();
 634   if (Expr.isVariablePiece())
 635     OS << " [piece offset=" << Expr.getPieceOffset()
 636        << " size=" << Expr.getPieceSize() << "]";
 637   OS << " <- ";
 638
 639   // The second operand is only an offset if it's an immediate.
 640   bool Deref = MI->getOperand(0).isReg() && MI->getOperand(1).isImm();
 641   int64_t Offset = Deref ? MI->getOperand(1).getImm() : 0;
 642
 643   // Register or immediate value. Register 0 means undef.
 644   if (MI->getOperand(0).isFPImm()) {
 645     APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
 646     if (MI->getOperand(0).getFPImm()->getType()->isFloatTy()) {
 647       OS << (double)APF.convertToFloat();
 648     } else if (MI->getOperand(0).getFPImm()->getType()->isDoubleTy()) {
 649       OS << APF.convertToDouble();
 650     } else {
 651       // There is no good way to print long double.  Convert a copy to
 652       // double.  Ah well, it's only a comment.
 653       bool ignored;
 654       APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
 655                   &ignored);
 656       OS << "(long double) " << APF.convertToDouble();
 657     }
 658   } else if (MI->getOperand(0).isImm()) {
 659     OS << MI->getOperand(0).getImm();
 660   } else if (MI->getOperand(0).isCImm()) {
 661     MI->getOperand(0).getCImm()->getValue().print(OS, false /*isSigned*/);
 662   } else {
 663     unsigned Reg;
 664     if (MI->getOperand(0).isReg()) {
 665       Reg = MI->getOperand(0).getReg();
 666     } else {
 667       assert(MI->getOperand(0).isFI() && "Unknown operand type");
 668       const TargetFrameLowering *TFI =
 669           AP.TM.getSubtargetImpl()->getFrameLowering();
 670       Offset += TFI->getFrameIndexReference(*AP.MF,
 671                                             MI->getOperand(0).getIndex(), Reg);
 672       Deref = true;
 673     }
 674     if (Reg == 0) {
 675       // Suppress offset, it is not meaningful here.
 676       OS << "undef";
 677       // NOTE: Want this comment at start of line, don't emit with AddComment.
 678       AP.OutStreamer.emitRawComment(OS.str());
 679       return true;
 680     }
 681     if (Deref)
 682       OS << '[';
 683     OS << AP.TM.getSubtargetImpl()->getRegisterInfo()->getName(Reg);
 684   }
 685
 686   if (Deref)
 687     OS << '+' << Offset << ']';
 688
 689   // NOTE: Want this comment at start of line, don't emit with AddComment.
 690   AP.OutStreamer.emitRawComment(OS.str());
 691   return true;
 692 }
 693
 694 AsmPrinter::CFIMoveType AsmPrinter::needsCFIMoves() {
 695   if (MAI->getExceptionHandlingType() == ExceptionHandling::DwarfCFI &&
 696       MF->getFunction()->needsUnwindTableEntry())
 697     return CFI_M_EH;
 698
 699   if (MMI->hasDebugInfo())
 700     return CFI_M_Debug;
 701
 702   return CFI_M_None;
 703 }
 704
 705 bool AsmPrinter::needsSEHMoves() {
 706   return MAI->getExceptionHandlingType() == ExceptionHandling::WinEH &&
 707     MF->getFunction()->needsUnwindTableEntry();
 708 }
 709
 710 void AsmPrinter::emitCFIInstruction(const MachineInstr &MI) {
 711   ExceptionHandling ExceptionHandlingType = MAI->getExceptionHandlingType();
 712   if (ExceptionHandlingType != ExceptionHandling::DwarfCFI &&
 713       ExceptionHandlingType != ExceptionHandling::ARM)
 714     return;
 715
 716   if (needsCFIMoves() == CFI_M_None)
 717     return;
 718
 719   const MachineModuleInfo &MMI = MF->getMMI();
 720   const std::vector<MCCFIInstruction> &Instrs = MMI.getFrameInstructions();
 721   unsigned CFIIndex = MI.getOperand(0).getCFIIndex();
 722   const MCCFIInstruction &CFI = Instrs[CFIIndex];
 723   emitCFIInstruction(CFI);
 724 }
 725
 726 /// EmitFunctionBody - This method emits the body and trailer for a
 727 /// function.
 728 void AsmPrinter::EmitFunctionBody() {
 729   // Emit target-specific gunk before the function body.
 730   EmitFunctionBodyStart();
 731
 732   bool ShouldPrintDebugScopes = MMI->hasDebugInfo();
 733
 734   // Print out code for the function.
 735   bool HasAnyRealCode = false;
 736   for (auto &MBB : *MF) {
 737     // Print a label for the basic block.
 738     EmitBasicBlockStart(MBB);
 739     for (auto &MI : MBB) {
 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 function is empty and the object file uses .subsections_via_symbols,
 801   // then we need to emit *something* to the function body to prevent the
 802   // labels from collapsing together.  Just emit a noop.
 803   if ((MAI->hasSubsectionsViaSymbols() && !HasAnyRealCode)) {
 804     MCInst Noop;
 805     TM.getSubtargetImpl()->getInstrInfo()->getNoopForMachoTarget(Noop);
 806     OutStreamer.AddComment("avoids zero-length function");
 807
 808     // Targets can opt-out of emitting the noop here by leaving the opcode
 809     // unspecified.
 810     if (Noop.getOpcode())
 811       OutStreamer.EmitInstruction(Noop, getSubtargetInfo());
 812   }
 813
 814   const Function *F = MF->getFunction();
 815   for (const auto &BB : *F) {
 816     if (!BB.hasAddressTaken())
 817       continue;
 818     MCSymbol *Sym = GetBlockAddressSymbol(&BB);
 819     if (Sym->isDefined())
 820       continue;
 821     OutStreamer.AddComment("Address of block that was removed by CodeGen");
 822     OutStreamer.EmitLabel(Sym);
 823   }
 824
 825   // Emit target-specific gunk after the function body.
 826   EmitFunctionBodyEnd();
 827
 828   // If the target wants a .size directive for the size of the function, emit
 829   // it.
 830   if (MAI->hasDotTypeDotSizeDirective()) {
 831     // Create a symbol for the end of function, so we can get the size as
 832     // difference between the function label and the temp label.
 833     MCSymbol *FnEndLabel = OutContext.CreateTempSymbol();
 834     OutStreamer.EmitLabel(FnEndLabel);
 835
 836     const MCExpr *SizeExp =
 837       MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(FnEndLabel, OutContext),
 838                               MCSymbolRefExpr::Create(CurrentFnSymForSize,
 839                                                       OutContext),
 840                               OutContext);
 841     OutStreamer.EmitELFSize(CurrentFnSym, SizeExp);
 842   }
 843
 844   // Emit post-function debug and/or EH information.
 845   for (const HandlerInfo &HI : Handlers) {
 846     NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, TimePassesIsEnabled);
 847     HI.Handler->endFunction(MF);
 848   }
 849   MMI->EndFunction();
 850
 851   // Print out jump tables referenced by the function.
 852   EmitJumpTableInfo();
 853
 854   OutStreamer.AddBlankLine();
 855 }
 856
 857 static const MCExpr *lowerConstant(const Constant *CV, AsmPrinter &AP);
 858
 859 bool AsmPrinter::doFinalization(Module &M) {
 860   // Emit global variables.
 861   for (const auto &G : M.globals())
 862     EmitGlobalVariable(&G);
 863
 864   // Emit visibility info for declarations
 865   for (const Function &F : M) {
 866     if (!F.isDeclaration())
 867       continue;
 868     GlobalValue::VisibilityTypes V = F.getVisibility();
 869     if (V == GlobalValue::DefaultVisibility)
 870       continue;
 871
 872     MCSymbol *Name = getSymbol(&F);
 873     EmitVisibility(Name, V, false);
 874   }
 875
 876   // Get information about jump-instruction tables to print.
 877   JumpInstrTableInfo *JITI = getAnalysisIfAvailable<JumpInstrTableInfo>();
 878
 879   if (JITI && !JITI->getTables().empty()) {
 880     unsigned Arch = Triple(getTargetTriple()).getArch();
 881     bool IsThumb = (Arch == Triple::thumb || Arch == Triple::thumbeb);
 882     MCInst TrapInst;
 883     TM.getSubtargetImpl()->getInstrInfo()->getTrap(TrapInst);
 884     for (const auto &KV : JITI->getTables()) {
 885       uint64_t Count = 0;
 886       for (const auto &FunPair : KV.second) {
 887         // Emit the function labels to make this be a function entry point.
 888         MCSymbol *FunSym =
 889           OutContext.GetOrCreateSymbol(FunPair.second->getName());
 890         OutStreamer.EmitSymbolAttribute(FunSym, MCSA_Global);
 891         // FIXME: JumpTableInstrInfo should store information about the required
 892         // alignment of table entries and the size of the padding instruction.
 893         EmitAlignment(3);
 894         if (IsThumb)
 895           OutStreamer.EmitThumbFunc(FunSym);
 896         if (MAI->hasDotTypeDotSizeDirective())
 897           OutStreamer.EmitSymbolAttribute(FunSym, MCSA_ELF_TypeFunction);
 898         OutStreamer.EmitLabel(FunSym);
 899
 900         // Emit the jump instruction to transfer control to the original
 901         // function.
 902         MCInst JumpToFun;
 903         MCSymbol *TargetSymbol =
 904           OutContext.GetOrCreateSymbol(FunPair.first->getName());
 905         const MCSymbolRefExpr *TargetSymRef =
 906           MCSymbolRefExpr::Create(TargetSymbol, MCSymbolRefExpr::VK_PLT,
 907                                   OutContext);
 908         TM.getSubtargetImpl()->getInstrInfo()->getUnconditionalBranch(
 909             JumpToFun, TargetSymRef);
 910         OutStreamer.EmitInstruction(JumpToFun, getSubtargetInfo());
 911         ++Count;
 912       }
 913
 914       // Emit enough padding instructions to fill up to the next power of two.
 915       // This assumes that the trap instruction takes 8 bytes or fewer.
 916       uint64_t Remaining = NextPowerOf2(Count) - Count;
 917       for (uint64_t C = 0; C < Remaining; ++C) {
 918         EmitAlignment(3);
 919         OutStreamer.EmitInstruction(TrapInst, getSubtargetInfo());
 920       }
 921
 922     }
 923   }
 924
 925   // Emit module flags.
 926   SmallVector<Module::ModuleFlagEntry, 8> ModuleFlags;
 927   M.getModuleFlagsMetadata(ModuleFlags);
 928   if (!ModuleFlags.empty())
 929     getObjFileLowering().emitModuleFlags(OutStreamer, ModuleFlags, *Mang, TM);
 930
 931   // Make sure we wrote out everything we need.
 932   OutStreamer.Flush();
 933
 934   // Finalize debug and EH information.
 935   for (const HandlerInfo &HI : Handlers) {
 936     NamedRegionTimer T(HI.TimerName, HI.TimerGroupName,
 937                        TimePassesIsEnabled);
 938     HI.Handler->endModule();
 939     delete HI.Handler;
 940   }
 941   Handlers.clear();
 942   DD = nullptr;
 943
 944   // If the target wants to know about weak references, print them all.
 945   if (MAI->getWeakRefDirective()) {
 946     // FIXME: This is not lazy, it would be nice to only print weak references
 947     // to stuff that is actually used.  Note that doing so would require targets
 948     // to notice uses in operands (due to constant exprs etc).  This should
 949     // happen with the MC stuff eventually.
 950
 951     // Print out module-level global variables here.
 952     for (const auto &G : M.globals()) {
 953       if (!G.hasExternalWeakLinkage())
 954         continue;
 955       OutStreamer.EmitSymbolAttribute(getSymbol(&G), MCSA_WeakReference);
 956     }
 957
 958     for (const auto &F : M) {
 959       if (!F.hasExternalWeakLinkage())
 960         continue;
 961       OutStreamer.EmitSymbolAttribute(getSymbol(&F), MCSA_WeakReference);
 962     }
 963   }
 964
 965   OutStreamer.AddBlankLine();
 966   for (const auto &Alias : M.aliases()) {
 967     MCSymbol *Name = getSymbol(&Alias);
 968
 969     if (Alias.hasExternalLinkage() || !MAI->getWeakRefDirective())
 970       OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
 971     else if (Alias.hasWeakLinkage() || Alias.hasLinkOnceLinkage())
 972       OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
 973     else
 974       assert(Alias.hasLocalLinkage() && "Invalid alias linkage");
 975
 976     EmitVisibility(Name, Alias.getVisibility());
 977
 978     // Emit the directives as assignments aka .set:
 979     OutStreamer.EmitAssignment(Name, lowerConstant(Alias.getAliasee(), *this));
 980   }
 981
 982   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
 983   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
 984   for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
 985     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(**--I))
 986       MP->finishAssembly(*this);
 987
 988   // Emit llvm.ident metadata in an '.ident' directive.
 989   EmitModuleIdents(M);
 990
 991   // If we don't have any trampolines, then we don't require stack memory
 992   // to be executable. Some targets have a directive to declare this.
 993   Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
 994   if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
 995     if (const MCSection *S = MAI->getNonexecutableStackSection(OutContext))
 996       OutStreamer.SwitchSection(S);
 997
 998   // Allow the target to emit any magic that it wants at the end of the file,
 999   // after everything else has gone out.
1000   EmitEndOfAsmFile(M);
1001
1002   delete Mang; Mang = nullptr;
1003   MMI = nullptr;
1004
1005   OutStreamer.Finish();
1006   OutStreamer.reset();
1007
1008   return false;
1009 }
1010
1011 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
1012   this->MF = &MF;
1013   // Get the function symbol.
1014   CurrentFnSym = getSymbol(MF.getFunction());
1015   CurrentFnSymForSize = CurrentFnSym;
1016
1017   if (isVerbose())
1018     LI = &getAnalysis<MachineLoopInfo>();
1019 }
1020
1021 namespace {
1022   // SectionCPs - Keep track the alignment, constpool entries per Section.
1023   struct SectionCPs {
1024     const MCSection *S;
1025     unsigned Alignment;
1026     SmallVector<unsigned, 4> CPEs;
1027     SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
1028   };
1029 }
1030
1031 /// EmitConstantPool - Print to the current output stream assembly
1032 /// representations of the constants in the constant pool MCP. This is
1033 /// used to print out constants which have been "spilled to memory" by
1034 /// the code generator.
1035 ///
1036 void AsmPrinter::EmitConstantPool() {
1037   const MachineConstantPool *MCP = MF->getConstantPool();
1038   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
1039   if (CP.empty()) return;
1040
1041   // Calculate sections for constant pool entries. We collect entries to go into
1042   // the same section together to reduce amount of section switch statements.
1043   SmallVector<SectionCPs, 4> CPSections;
1044   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
1045     const MachineConstantPoolEntry &CPE = CP[i];
1046     unsigned Align = CPE.getAlignment();
1047
1048     SectionKind Kind =
1049         CPE.getSectionKind(TM.getSubtargetImpl()->getDataLayout());
1050
1051     const Constant *C = nullptr;
1052     if (!CPE.isMachineConstantPoolEntry())
1053       C = CPE.Val.ConstVal;
1054
1055     const MCSection *S = getObjFileLowering().getSectionForConstant(Kind, C);
1056
1057     // The number of sections are small, just do a linear search from the
1058     // last section to the first.
1059     bool Found = false;
1060     unsigned SecIdx = CPSections.size();
1061     while (SecIdx != 0) {
1062       if (CPSections[--SecIdx].S == S) {
1063         Found = true;
1064         break;
1065       }
1066     }
1067     if (!Found) {
1068       SecIdx = CPSections.size();
1069       CPSections.push_back(SectionCPs(S, Align));
1070     }
1071
1072     if (Align > CPSections[SecIdx].Alignment)
1073       CPSections[SecIdx].Alignment = Align;
1074     CPSections[SecIdx].CPEs.push_back(i);
1075   }
1076
1077   // Now print stuff into the calculated sections.
1078   const MCSection *CurSection = nullptr;
1079   unsigned Offset = 0;
1080   for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
1081     for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
1082       unsigned CPI = CPSections[i].CPEs[j];
1083       MCSymbol *Sym = GetCPISymbol(CPI);
1084       if (!Sym->isUndefined())
1085         continue;
1086
1087       if (CurSection != CPSections[i].S) {
1088         OutStreamer.SwitchSection(CPSections[i].S);
1089         EmitAlignment(Log2_32(CPSections[i].Alignment));
1090         CurSection = CPSections[i].S;
1091         Offset = 0;
1092       }
1093
1094       MachineConstantPoolEntry CPE = CP[CPI];
1095
1096       // Emit inter-object padding for alignment.
1097       unsigned AlignMask = CPE.getAlignment() - 1;
1098       unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
1099       OutStreamer.EmitZeros(NewOffset - Offset);
1100
1101       Type *Ty = CPE.getType();
1102       Offset = NewOffset +
1103                TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(Ty);
1104
1105       OutStreamer.EmitLabel(Sym);
1106       if (CPE.isMachineConstantPoolEntry())
1107         EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
1108       else
1109         EmitGlobalConstant(CPE.Val.ConstVal);
1110     }
1111   }
1112 }
1113
1114 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
1115 /// by the current function to the current output stream.
1116 ///
1117 void AsmPrinter::EmitJumpTableInfo() {
1118   const DataLayout *DL = MF->getSubtarget().getDataLayout();
1119   const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
1120   if (!MJTI) return;
1121   if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
1122   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1123   if (JT.empty()) return;
1124
1125   // Pick the directive to use to print the jump table entries, and switch to
1126   // the appropriate section.
1127   const Function *F = MF->getFunction();
1128   bool JTInDiffSection = false;
1129   if (// In PIC mode, we need to emit the jump table to the same section as the
1130       // function body itself, otherwise the label differences won't make sense.
1131       // FIXME: Need a better predicate for this: what about custom entries?
1132       MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
1133       // We should also do if the section name is NULL or function is declared
1134       // in discardable section
1135       // FIXME: this isn't the right predicate, should be based on the MCSection
1136       // for the function.
1137       F->isWeakForLinker()) {
1138     OutStreamer.SwitchSection(
1139         getObjFileLowering().SectionForGlobal(F, *Mang, TM));
1140   } else {
1141     // Otherwise, drop it in the readonly section.
1142     const MCSection *ReadOnlySection =
1143         getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly(),
1144                                                    /*C=*/nullptr);
1145     OutStreamer.SwitchSection(ReadOnlySection);
1146     JTInDiffSection = true;
1147   }
1148
1149   EmitAlignment(Log2_32(
1150       MJTI->getEntryAlignment(*TM.getSubtargetImpl()->getDataLayout())));
1151
1152   // Jump tables in code sections are marked with a data_region directive
1153   // where that's supported.
1154   if (!JTInDiffSection)
1155     OutStreamer.EmitDataRegion(MCDR_DataRegionJT32);
1156
1157   for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
1158     const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
1159
1160     // If this jump table was deleted, ignore it.
1161     if (JTBBs.empty()) continue;
1162
1163     // For the EK_LabelDifference32 entry, if using .set avoids a relocation,
1164     /// emit a .set directive for each unique entry.
1165     if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
1166         MAI->doesSetDirectiveSuppressesReloc()) {
1167       SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
1168       const TargetLowering *TLI = TM.getSubtargetImpl()->getTargetLowering();
1169       const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
1170       for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
1171         const MachineBasicBlock *MBB = JTBBs[ii];
1172         if (!EmittedSets.insert(MBB)) continue;
1173
1174         // .set LJTSet, LBB32-base
1175         const MCExpr *LHS =
1176           MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1177         OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
1178                                 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
1179       }
1180     }
1181
1182     // On some targets (e.g. Darwin) we want to emit two consecutive labels
1183     // before each jump table.  The first label is never referenced, but tells
1184     // the assembler and linker the extents of the jump table object.  The
1185     // second label is actually referenced by the code.
1186     if (JTInDiffSection && DL->hasLinkerPrivateGlobalPrefix())
1187       // FIXME: This doesn't have to have any specific name, just any randomly
1188       // named and numbered 'l' label would work.  Simplify GetJTISymbol.
1189       OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
1190
1191     OutStreamer.EmitLabel(GetJTISymbol(JTI));
1192
1193     for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
1194       EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
1195   }
1196   if (!JTInDiffSection)
1197     OutStreamer.EmitDataRegion(MCDR_DataRegionEnd);
1198 }
1199
1200 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
1201 /// current stream.
1202 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
1203                                     const MachineBasicBlock *MBB,
1204                                     unsigned UID) const {
1205   assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
1206   const MCExpr *Value = nullptr;
1207   switch (MJTI->getEntryKind()) {
1208   case MachineJumpTableInfo::EK_Inline:
1209     llvm_unreachable("Cannot emit EK_Inline jump table entry");
1210   case MachineJumpTableInfo::EK_Custom32:
1211     Value =
1212         TM.getSubtargetImpl()->getTargetLowering()->LowerCustomJumpTableEntry(
1213             MJTI, MBB, UID, OutContext);
1214     break;
1215   case MachineJumpTableInfo::EK_BlockAddress:
1216     // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1217     //     .word LBB123
1218     Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1219     break;
1220   case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
1221     // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
1222     // with a relocation as gp-relative, e.g.:
1223     //     .gprel32 LBB123
1224     MCSymbol *MBBSym = MBB->getSymbol();
1225     OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1226     return;
1227   }
1228
1229   case MachineJumpTableInfo::EK_GPRel64BlockAddress: {
1230     // EK_GPRel64BlockAddress - Each entry is an address of block, encoded
1231     // with a relocation as gp-relative, e.g.:
1232     //     .gpdword LBB123
1233     MCSymbol *MBBSym = MBB->getSymbol();
1234     OutStreamer.EmitGPRel64Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1235     return;
1236   }
1237
1238   case MachineJumpTableInfo::EK_LabelDifference32: {
1239     // Each entry is the address of the block minus the address of the jump
1240     // table. This is used for PIC jump tables where gprel32 is not supported.
1241     // e.g.:
1242     //      .word LBB123 - LJTI1_2
1243     // If the .set directive avoids relocations, this is emitted as:
1244     //      .set L4_5_set_123, LBB123 - LJTI1_2
1245     //      .word L4_5_set_123
1246     if (MAI->doesSetDirectiveSuppressesReloc()) {
1247       Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
1248                                       OutContext);
1249       break;
1250     }
1251     Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1252     const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
1253     Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
1254     break;
1255   }
1256   }
1257
1258   assert(Value && "Unknown entry kind!");
1259
1260   unsigned EntrySize =
1261       MJTI->getEntrySize(*TM.getSubtargetImpl()->getDataLayout());
1262   OutStreamer.EmitValue(Value, EntrySize);
1263 }
1264
1265
1266 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
1267 /// special global used by LLVM.  If so, emit it and return true, otherwise
1268 /// do nothing and return false.
1269 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
1270   if (GV->getName() == "llvm.used") {
1271     if (MAI->hasNoDeadStrip())    // No need to emit this at all.
1272       EmitLLVMUsedList(cast<ConstantArray>(GV->getInitializer()));
1273     return true;
1274   }
1275
1276   // Ignore debug and non-emitted data.  This handles llvm.compiler.used.
1277   if (StringRef(GV->getSection()) == "llvm.metadata" ||
1278       GV->hasAvailableExternallyLinkage())
1279     return true;
1280
1281   if (!GV->hasAppendingLinkage()) return false;
1282
1283   assert(GV->hasInitializer() && "Not a special LLVM global!");
1284
1285   if (GV->getName() == "llvm.global_ctors") {
1286     EmitXXStructorList(GV->getInitializer(), /* isCtor */ true);
1287
1288     if (TM.getRelocationModel() == Reloc::Static &&
1289         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1290       StringRef Sym(".constructors_used");
1291       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1292                                       MCSA_Reference);
1293     }
1294     return true;
1295   }
1296
1297   if (GV->getName() == "llvm.global_dtors") {
1298     EmitXXStructorList(GV->getInitializer(), /* isCtor */ false);
1299
1300     if (TM.getRelocationModel() == Reloc::Static &&
1301         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1302       StringRef Sym(".destructors_used");
1303       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1304                                       MCSA_Reference);
1305     }
1306     return true;
1307   }
1308
1309   return false;
1310 }
1311
1312 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
1313 /// global in the specified llvm.used list for which emitUsedDirectiveFor
1314 /// is true, as being used with this directive.
1315 void AsmPrinter::EmitLLVMUsedList(const ConstantArray *InitList) {
1316   // Should be an array of 'i8*'.
1317   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1318     const GlobalValue *GV =
1319       dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
1320     if (GV)
1321       OutStreamer.EmitSymbolAttribute(getSymbol(GV), MCSA_NoDeadStrip);
1322   }
1323 }
1324
1325 namespace {
1326 struct Structor {
1327   Structor() : Priority(0), Func(nullptr), ComdatKey(nullptr) {}
1328   int Priority;
1329   llvm::Constant *Func;
1330   llvm::GlobalValue *ComdatKey;
1331 };
1332 } // end namespace
1333
1334 /// EmitXXStructorList - Emit the ctor or dtor list taking into account the init
1335 /// priority.
1336 void AsmPrinter::EmitXXStructorList(const Constant *List, bool isCtor) {
1337   // Should be an array of '{ int, void ()* }' structs.  The first value is the
1338   // init priority.
1339   if (!isa<ConstantArray>(List)) return;
1340
1341   // Sanity check the structors list.
1342   const ConstantArray *InitList = dyn_cast<ConstantArray>(List);
1343   if (!InitList) return; // Not an array!
1344   StructType *ETy = dyn_cast<StructType>(InitList->getType()->getElementType());
1345   // FIXME: Only allow the 3-field form in LLVM 4.0.
1346   if (!ETy || ETy->getNumElements() < 2 || ETy->getNumElements() > 3)
1347     return; // Not an array of two or three elements!
1348   if (!isa<IntegerType>(ETy->getTypeAtIndex(0U)) ||
1349       !isa<PointerType>(ETy->getTypeAtIndex(1U))) return; // Not (int, ptr).
1350   if (ETy->getNumElements() == 3 && !isa<PointerType>(ETy->getTypeAtIndex(2U)))
1351     return; // Not (int, ptr, ptr).
1352
1353   // Gather the structors in a form that's convenient for sorting by priority.
1354   SmallVector<Structor, 8> Structors;
1355   for (Value *O : InitList->operands()) {
1356     ConstantStruct *CS = dyn_cast<ConstantStruct>(O);
1357     if (!CS) continue; // Malformed.
1358     if (CS->getOperand(1)->isNullValue())
1359       break;  // Found a null terminator, skip the rest.
1360     ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0));
1361     if (!Priority) continue; // Malformed.
1362     Structors.push_back(Structor());
1363     Structor &S = Structors.back();
1364     S.Priority = Priority->getLimitedValue(65535);
1365     S.Func = CS->getOperand(1);
1366     if (ETy->getNumElements() == 3 && !CS->getOperand(2)->isNullValue())
1367       S.ComdatKey = dyn_cast<GlobalValue>(CS->getOperand(2)->stripPointerCasts());
1368   }
1369
1370   // Emit the function pointers in the target-specific order
1371   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
1372   unsigned Align = Log2_32(DL->getPointerPrefAlignment());
1373   std::stable_sort(Structors.begin(), Structors.end(),
1374                    [](const Structor &L,
1375                       const Structor &R) { return L.Priority < R.Priority; });
1376   for (Structor &S : Structors) {
1377     const TargetLoweringObjectFile &Obj = getObjFileLowering();
1378     const MCSymbol *KeySym = nullptr;
1379     if (GlobalValue *GV = S.ComdatKey) {
1380       if (GV->hasAvailableExternallyLinkage())
1381         // If the associated variable is available_externally, some other TU
1382         // will provide its dynamic initializer.
1383         continue;
1384
1385       KeySym = getSymbol(GV);
1386     }
1387     const MCSection *OutputSection =
1388         (isCtor ? Obj.getStaticCtorSection(S.Priority, KeySym)
1389                 : Obj.getStaticDtorSection(S.Priority, KeySym));
1390     OutStreamer.SwitchSection(OutputSection);
1391     if (OutStreamer.getCurrentSection() != OutStreamer.getPreviousSection())
1392       EmitAlignment(Align);
1393     EmitXXStructor(S.Func);
1394   }
1395 }
1396
1397 void AsmPrinter::EmitModuleIdents(Module &M) {
1398   if (!MAI->hasIdentDirective())
1399     return;
1400
1401   if (const NamedMDNode *NMD = M.getNamedMetadata("llvm.ident")) {
1402     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1403       const MDNode *N = NMD->getOperand(i);
1404       assert(N->getNumOperands() == 1 &&
1405              "llvm.ident metadata entry can have only one operand");
1406       const MDString *S = cast<MDString>(N->getOperand(0));
1407       OutStreamer.EmitIdent(S->getString());
1408     }
1409   }
1410 }
1411
1412 //===--------------------------------------------------------------------===//
1413 // Emission and print routines
1414 //
1415
1416 /// EmitInt8 - Emit a byte directive and value.
1417 ///
1418 void AsmPrinter::EmitInt8(int Value) const {
1419   OutStreamer.EmitIntValue(Value, 1);
1420 }
1421
1422 /// EmitInt16 - Emit a short directive and value.
1423 ///
1424 void AsmPrinter::EmitInt16(int Value) const {
1425   OutStreamer.EmitIntValue(Value, 2);
1426 }
1427
1428 /// EmitInt32 - Emit a long directive and value.
1429 ///
1430 void AsmPrinter::EmitInt32(int Value) const {
1431   OutStreamer.EmitIntValue(Value, 4);
1432 }
1433
1434 /// Emit something like ".long Hi-Lo" where the size in bytes of the directive
1435 /// is specified by Size and Hi/Lo specify the labels. This implicitly uses
1436 /// .set if it avoids relocations.
1437 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
1438                                      unsigned Size) const {
1439   // Get the Hi-Lo expression.
1440   const MCExpr *Diff =
1441     MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(Hi, OutContext),
1442                             MCSymbolRefExpr::Create(Lo, OutContext),
1443                             OutContext);
1444
1445   if (!MAI->doesSetDirectiveSuppressesReloc()) {
1446     OutStreamer.EmitValue(Diff, Size);
1447     return;
1448   }
1449
1450   // Otherwise, emit with .set (aka assignment).
1451   MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1452   OutStreamer.EmitAssignment(SetLabel, Diff);
1453   OutStreamer.EmitSymbolValue(SetLabel, Size);
1454 }
1455
1456 /// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
1457 /// where the size in bytes of the directive is specified by Size and Label
1458 /// specifies the label.  This implicitly uses .set if it is available.
1459 void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
1460                                      unsigned Size,
1461                                      bool IsSectionRelative) const {
1462   if (MAI->needsDwarfSectionOffsetDirective() && IsSectionRelative) {
1463     OutStreamer.EmitCOFFSecRel32(Label);
1464     return;
1465   }
1466
1467   // Emit Label+Offset (or just Label if Offset is zero)
1468   const MCExpr *Expr = MCSymbolRefExpr::Create(Label, OutContext);
1469   if (Offset)
1470     Expr = MCBinaryExpr::CreateAdd(
1471         Expr, MCConstantExpr::Create(Offset, OutContext), OutContext);
1472
1473   OutStreamer.EmitValue(Expr, Size);
1474 }
1475
1476 //===----------------------------------------------------------------------===//
1477
1478 // EmitAlignment - Emit an alignment directive to the specified power of
1479 // two boundary.  For example, if you pass in 3 here, you will get an 8
1480 // byte alignment.  If a global value is specified, and if that global has
1481 // an explicit alignment requested, it will override the alignment request
1482 // if required for correctness.
1483 //
1484 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalObject *GV) const {
1485   if (GV)
1486     NumBits = getGVAlignmentLog2(GV, *TM.getSubtargetImpl()->getDataLayout(),
1487                                  NumBits);
1488
1489   if (NumBits == 0) return;   // 1-byte aligned: no need to emit alignment.
1490
1491   if (getCurrentSection()->getKind().isText())
1492     OutStreamer.EmitCodeAlignment(1 << NumBits);
1493   else
1494     OutStreamer.EmitValueToAlignment(1 << NumBits);
1495 }
1496
1497 //===----------------------------------------------------------------------===//
1498 // Constant emission.
1499 //===----------------------------------------------------------------------===//
1500
1501 /// lowerConstant - Lower the specified LLVM Constant to an MCExpr.
1502 ///
1503 static const MCExpr *lowerConstant(const Constant *CV, AsmPrinter &AP) {
1504   MCContext &Ctx = AP.OutContext;
1505
1506   if (CV->isNullValue() || isa<UndefValue>(CV))
1507     return MCConstantExpr::Create(0, Ctx);
1508
1509   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
1510     return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
1511
1512   if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
1513     return MCSymbolRefExpr::Create(AP.getSymbol(GV), Ctx);
1514
1515   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
1516     return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
1517
1518   const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
1519   if (!CE) {
1520     llvm_unreachable("Unknown constant value to lower!");
1521   }
1522
1523   if (const MCExpr *RelocExpr =
1524           AP.getObjFileLowering().getExecutableRelativeSymbol(CE, *AP.Mang,
1525                                                               AP.TM))
1526     return RelocExpr;
1527
1528   switch (CE->getOpcode()) {
1529   default:
1530     // If the code isn't optimized, there may be outstanding folding
1531     // opportunities. Attempt to fold the expression using DataLayout as a
1532     // last resort before giving up.
1533     if (Constant *C = ConstantFoldConstantExpression(
1534             CE, AP.TM.getSubtargetImpl()->getDataLayout()))
1535       if (C != CE)
1536         return lowerConstant(C, AP);
1537
1538     // Otherwise report the problem to the user.
1539     {
1540       std::string S;
1541       raw_string_ostream OS(S);
1542       OS << "Unsupported expression in static initializer: ";
1543       CE->printAsOperand(OS, /*PrintType=*/false,
1544                      !AP.MF ? nullptr : AP.MF->getFunction()->getParent());
1545       report_fatal_error(OS.str());
1546     }
1547   case Instruction::GetElementPtr: {
1548     const DataLayout &DL = *AP.TM.getSubtargetImpl()->getDataLayout();
1549     // Generate a symbolic expression for the byte address
1550     APInt OffsetAI(DL.getPointerTypeSizeInBits(CE->getType()), 0);
1551     cast<GEPOperator>(CE)->accumulateConstantOffset(DL, OffsetAI);
1552
1553     const MCExpr *Base = lowerConstant(CE->getOperand(0), AP);
1554     if (!OffsetAI)
1555       return Base;
1556
1557     int64_t Offset = OffsetAI.getSExtValue();
1558     return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
1559                                    Ctx);
1560   }
1561
1562   case Instruction::Trunc:
1563     // We emit the value and depend on the assembler to truncate the generated
1564     // expression properly.  This is important for differences between
1565     // blockaddress labels.  Since the two labels are in the same function, it
1566     // is reasonable to treat their delta as a 32-bit value.
1567     // FALL THROUGH.
1568   case Instruction::BitCast:
1569     return lowerConstant(CE->getOperand(0), AP);
1570
1571   case Instruction::IntToPtr: {
1572     const DataLayout &DL = *AP.TM.getSubtargetImpl()->getDataLayout();
1573     // Handle casts to pointers by changing them into casts to the appropriate
1574     // integer type.  This promotes constant folding and simplifies this code.
1575     Constant *Op = CE->getOperand(0);
1576     Op = ConstantExpr::getIntegerCast(Op, DL.getIntPtrType(CV->getType()),
1577                                       false/*ZExt*/);
1578     return lowerConstant(Op, AP);
1579   }
1580
1581   case Instruction::PtrToInt: {
1582     const DataLayout &DL = *AP.TM.getSubtargetImpl()->getDataLayout();
1583     // Support only foldable casts to/from pointers that can be eliminated by
1584     // changing the pointer to the appropriately sized integer type.
1585     Constant *Op = CE->getOperand(0);
1586     Type *Ty = CE->getType();
1587
1588     const MCExpr *OpExpr = lowerConstant(Op, AP);
1589
1590     // We can emit the pointer value into this slot if the slot is an
1591     // integer slot equal to the size of the pointer.
1592     if (DL.getTypeAllocSize(Ty) == DL.getTypeAllocSize(Op->getType()))
1593       return OpExpr;
1594
1595     // Otherwise the pointer is smaller than the resultant integer, mask off
1596     // the high bits so we are sure to get a proper truncation if the input is
1597     // a constant expr.
1598     unsigned InBits = DL.getTypeAllocSizeInBits(Op->getType());
1599     const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
1600     return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
1601   }
1602
1603   // The MC library also has a right-shift operator, but it isn't consistently
1604   // signed or unsigned between different targets.
1605   case Instruction::Add:
1606   case Instruction::Sub:
1607   case Instruction::Mul:
1608   case Instruction::SDiv:
1609   case Instruction::SRem:
1610   case Instruction::Shl:
1611   case Instruction::And:
1612   case Instruction::Or:
1613   case Instruction::Xor: {
1614     const MCExpr *LHS = lowerConstant(CE->getOperand(0), AP);
1615     const MCExpr *RHS = lowerConstant(CE->getOperand(1), AP);
1616     switch (CE->getOpcode()) {
1617     default: llvm_unreachable("Unknown binary operator constant cast expr");
1618     case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
1619     case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
1620     case Instruction::Mul: return MCBinaryExpr::CreateMul(LHS, RHS, Ctx);
1621     case Instruction::SDiv: return MCBinaryExpr::CreateDiv(LHS, RHS, Ctx);
1622     case Instruction::SRem: return MCBinaryExpr::CreateMod(LHS, RHS, Ctx);
1623     case Instruction::Shl: return MCBinaryExpr::CreateShl(LHS, RHS, Ctx);
1624     case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
1625     case Instruction::Or:  return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
1626     case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
1627     }
1628   }
1629   }
1630 }
1631
1632 static void emitGlobalConstantImpl(const Constant *C, AsmPrinter &AP);
1633
1634 /// isRepeatedByteSequence - Determine whether the given value is
1635 /// composed of a repeated sequence of identical bytes and return the
1636 /// byte value.  If it is not a repeated sequence, return -1.
1637 static int isRepeatedByteSequence(const ConstantDataSequential *V) {
1638   StringRef Data = V->getRawDataValues();
1639   assert(!Data.empty() && "Empty aggregates should be CAZ node");
1640   char C = Data[0];
1641   for (unsigned i = 1, e = Data.size(); i != e; ++i)
1642     if (Data[i] != C) return -1;
1643   return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1.
1644 }
1645
1646
1647 /// isRepeatedByteSequence - Determine whether the given value is
1648 /// composed of a repeated sequence of identical bytes and return the
1649 /// byte value.  If it is not a repeated sequence, return -1.
1650 static int isRepeatedByteSequence(const Value *V, TargetMachine &TM) {
1651
1652   if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
1653     if (CI->getBitWidth() > 64) return -1;
1654
1655     uint64_t Size =
1656         TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(V->getType());
1657     uint64_t Value = CI->getZExtValue();
1658
1659     // Make sure the constant is at least 8 bits long and has a power
1660     // of 2 bit width.  This guarantees the constant bit width is
1661     // always a multiple of 8 bits, avoiding issues with padding out
1662     // to Size and other such corner cases.
1663     if (CI->getBitWidth() < 8 || !isPowerOf2_64(CI->getBitWidth())) return -1;
1664
1665     uint8_t Byte = static_cast<uint8_t>(Value);
1666
1667     for (unsigned i = 1; i < Size; ++i) {
1668       Value >>= 8;
1669       if (static_cast<uint8_t>(Value) != Byte) return -1;
1670     }
1671     return Byte;
1672   }
1673   if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) {
1674     // Make sure all array elements are sequences of the same repeated
1675     // byte.
1676     assert(CA->getNumOperands() != 0 && "Should be a CAZ");
1677     int Byte = isRepeatedByteSequence(CA->getOperand(0), TM);
1678     if (Byte == -1) return -1;
1679
1680     for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1681       int ThisByte = isRepeatedByteSequence(CA->getOperand(i), TM);
1682       if (ThisByte == -1) return -1;
1683       if (Byte != ThisByte) return -1;
1684     }
1685     return Byte;
1686   }
1687
1688   if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V))
1689     return isRepeatedByteSequence(CDS);
1690
1691   return -1;
1692 }
1693
1694 static void emitGlobalConstantDataSequential(const ConstantDataSequential *CDS,
1695                                              AsmPrinter &AP){
1696
1697   // See if we can aggregate this into a .fill, if so, emit it as such.
1698   int Value = isRepeatedByteSequence(CDS, AP.TM);
1699   if (Value != -1) {
1700     uint64_t Bytes =
1701         AP.TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(
1702             CDS->getType());
1703     // Don't emit a 1-byte object as a .fill.
1704     if (Bytes > 1)
1705       return AP.OutStreamer.EmitFill(Bytes, Value);
1706   }
1707
1708   // If this can be emitted with .ascii/.asciz, emit it as such.
1709   if (CDS->isString())
1710     return AP.OutStreamer.EmitBytes(CDS->getAsString());
1711
1712   // Otherwise, emit the values in successive locations.
1713   unsigned ElementByteSize = CDS->getElementByteSize();
1714   if (isa<IntegerType>(CDS->getElementType())) {
1715     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1716       if (AP.isVerbose())
1717         AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1718                                                 CDS->getElementAsInteger(i));
1719       AP.OutStreamer.EmitIntValue(CDS->getElementAsInteger(i),
1720                                   ElementByteSize);
1721     }
1722   } else if (ElementByteSize == 4) {
1723     // FP Constants are printed as integer constants to avoid losing
1724     // precision.
1725     assert(CDS->getElementType()->isFloatTy());
1726     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1727       union {
1728         float F;
1729         uint32_t I;
1730       };
1731
1732       F = CDS->getElementAsFloat(i);
1733       if (AP.isVerbose())
1734         AP.OutStreamer.GetCommentOS() << "float " << F << '\n';
1735       AP.OutStreamer.EmitIntValue(I, 4);
1736     }
1737   } else {
1738     assert(CDS->getElementType()->isDoubleTy());
1739     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1740       union {
1741         double F;
1742         uint64_t I;
1743       };
1744
1745       F = CDS->getElementAsDouble(i);
1746       if (AP.isVerbose())
1747         AP.OutStreamer.GetCommentOS() << "double " << F << '\n';
1748       AP.OutStreamer.EmitIntValue(I, 8);
1749     }
1750   }
1751
1752   const DataLayout &DL = *AP.TM.getSubtargetImpl()->getDataLayout();
1753   unsigned Size = DL.getTypeAllocSize(CDS->getType());
1754   unsigned EmittedSize = DL.getTypeAllocSize(CDS->getType()->getElementType()) *
1755                         CDS->getNumElements();
1756   if (unsigned Padding = Size - EmittedSize)
1757     AP.OutStreamer.EmitZeros(Padding);
1758
1759 }
1760
1761 static void emitGlobalConstantArray(const ConstantArray *CA, AsmPrinter &AP) {
1762   // See if we can aggregate some values.  Make sure it can be
1763   // represented as a series of bytes of the constant value.
1764   int Value = isRepeatedByteSequence(CA, AP.TM);
1765
1766   if (Value != -1) {
1767     uint64_t Bytes =
1768         AP.TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(
1769             CA->getType());
1770     AP.OutStreamer.EmitFill(Bytes, Value);
1771   }
1772   else {
1773     for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1774       emitGlobalConstantImpl(CA->getOperand(i), AP);
1775   }
1776 }
1777
1778 static void emitGlobalConstantVector(const ConstantVector *CV, AsmPrinter &AP) {
1779   for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1780     emitGlobalConstantImpl(CV->getOperand(i), AP);
1781
1782   const DataLayout &DL = *AP.TM.getSubtargetImpl()->getDataLayout();
1783   unsigned Size = DL.getTypeAllocSize(CV->getType());
1784   unsigned EmittedSize = DL.getTypeAllocSize(CV->getType()->getElementType()) *
1785                          CV->getType()->getNumElements();
1786   if (unsigned Padding = Size - EmittedSize)
1787     AP.OutStreamer.EmitZeros(Padding);
1788 }
1789
1790 static void emitGlobalConstantStruct(const ConstantStruct *CS, AsmPrinter &AP) {
1791   // Print the fields in successive locations. Pad to align if needed!
1792   const DataLayout *DL = AP.TM.getSubtargetImpl()->getDataLayout();
1793   unsigned Size = DL->getTypeAllocSize(CS->getType());
1794   const StructLayout *Layout = DL->getStructLayout(CS->getType());
1795   uint64_t SizeSoFar = 0;
1796   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1797     const Constant *Field = CS->getOperand(i);
1798
1799     // Check if padding is needed and insert one or more 0s.
1800     uint64_t FieldSize = DL->getTypeAllocSize(Field->getType());
1801     uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1802                         - Layout->getElementOffset(i)) - FieldSize;
1803     SizeSoFar += FieldSize + PadSize;
1804
1805     // Now print the actual field value.
1806     emitGlobalConstantImpl(Field, AP);
1807
1808     // Insert padding - this may include padding to increase the size of the
1809     // current field up to the ABI size (if the struct is not packed) as well
1810     // as padding to ensure that the next field starts at the right offset.
1811     AP.OutStreamer.EmitZeros(PadSize);
1812   }
1813   assert(SizeSoFar == Layout->getSizeInBytes() &&
1814          "Layout of constant struct may be incorrect!");
1815 }
1816
1817 static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) {
1818   APInt API = CFP->getValueAPF().bitcastToAPInt();
1819
1820   // First print a comment with what we think the original floating-point value
1821   // should have been.
1822   if (AP.isVerbose()) {
1823     SmallString<8> StrVal;
1824     CFP->getValueAPF().toString(StrVal);
1825
1826     if (CFP->getType())
1827       CFP->getType()->print(AP.OutStreamer.GetCommentOS());
1828     else
1829       AP.OutStreamer.GetCommentOS() << "Printing <null> Type";
1830     AP.OutStreamer.GetCommentOS() << ' ' << StrVal << '\n';
1831   }
1832
1833   // Now iterate through the APInt chunks, emitting them in endian-correct
1834   // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit
1835   // floats).
1836   unsigned NumBytes = API.getBitWidth() / 8;
1837   unsigned TrailingBytes = NumBytes % sizeof(uint64_t);
1838   const uint64_t *p = API.getRawData();
1839
1840   // PPC's long double has odd notions of endianness compared to how LLVM
1841   // handles it: p[0] goes first for *big* endian on PPC.
1842   if (AP.TM.getSubtargetImpl()->getDataLayout()->isBigEndian() &&
1843       !CFP->getType()->isPPC_FP128Ty()) {
1844     int Chunk = API.getNumWords() - 1;
1845
1846     if (TrailingBytes)
1847       AP.OutStreamer.EmitIntValue(p[Chunk--], TrailingBytes);
1848
1849     for (; Chunk >= 0; --Chunk)
1850       AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1851   } else {
1852     unsigned Chunk;
1853     for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk)
1854       AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1855
1856     if (TrailingBytes)
1857       AP.OutStreamer.EmitIntValue(p[Chunk], TrailingBytes);
1858   }
1859
1860   // Emit the tail padding for the long double.
1861   const DataLayout &DL = *AP.TM.getSubtargetImpl()->getDataLayout();
1862   AP.OutStreamer.EmitZeros(DL.getTypeAllocSize(CFP->getType()) -
1863                            DL.getTypeStoreSize(CFP->getType()));
1864 }
1865
1866 static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP) {
1867   const DataLayout *DL = AP.TM.getSubtargetImpl()->getDataLayout();
1868   unsigned BitWidth = CI->getBitWidth();
1869
1870   // Copy the value as we may massage the layout for constants whose bit width
1871   // is not a multiple of 64-bits.
1872   APInt Realigned(CI->getValue());
1873   uint64_t ExtraBits = 0;
1874   unsigned ExtraBitsSize = BitWidth & 63;
1875
1876   if (ExtraBitsSize) {
1877     // The bit width of the data is not a multiple of 64-bits.
1878     // The extra bits are expected to be at the end of the chunk of the memory.
1879     // Little endian:
1880     // * Nothing to be done, just record the extra bits to emit.
1881     // Big endian:
1882     // * Record the extra bits to emit.
1883     // * Realign the raw data to emit the chunks of 64-bits.
1884     if (DL->isBigEndian()) {
1885       // Basically the structure of the raw data is a chunk of 64-bits cells:
1886       //    0        1         BitWidth / 64
1887       // [chunk1][chunk2] ... [chunkN].
1888       // The most significant chunk is chunkN and it should be emitted first.
1889       // However, due to the alignment issue chunkN contains useless bits.
1890       // Realign the chunks so that they contain only useless information:
1891       // ExtraBits     0       1       (BitWidth / 64) - 1
1892       //       chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN]
1893       ExtraBits = Realigned.getRawData()[0] &
1894         (((uint64_t)-1) >> (64 - ExtraBitsSize));
1895       Realigned = Realigned.lshr(ExtraBitsSize);
1896     } else
1897       ExtraBits = Realigned.getRawData()[BitWidth / 64];
1898   }
1899
1900   // We don't expect assemblers to support integer data directives
1901   // for more than 64 bits, so we emit the data in at most 64-bit
1902   // quantities at a time.
1903   const uint64_t *RawData = Realigned.getRawData();
1904   for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1905     uint64_t Val = DL->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1906     AP.OutStreamer.EmitIntValue(Val, 8);
1907   }
1908
1909   if (ExtraBitsSize) {
1910     // Emit the extra bits after the 64-bits chunks.
1911
1912     // Emit a directive that fills the expected size.
1913     uint64_t Size = AP.TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(
1914         CI->getType());
1915     Size -= (BitWidth / 64) * 8;
1916     assert(Size && Size * 8 >= ExtraBitsSize &&
1917            (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize)))
1918            == ExtraBits && "Directive too small for extra bits.");
1919     AP.OutStreamer.EmitIntValue(ExtraBits, Size);
1920   }
1921 }
1922
1923 static void emitGlobalConstantImpl(const Constant *CV, AsmPrinter &AP) {
1924   const DataLayout *DL = AP.TM.getSubtargetImpl()->getDataLayout();
1925   uint64_t Size = DL->getTypeAllocSize(CV->getType());
1926   if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV))
1927     return AP.OutStreamer.EmitZeros(Size);
1928
1929   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1930     switch (Size) {
1931     case 1:
1932     case 2:
1933     case 4:
1934     case 8:
1935       if (AP.isVerbose())
1936         AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1937                                                 CI->getZExtValue());
1938       AP.OutStreamer.EmitIntValue(CI->getZExtValue(), Size);
1939       return;
1940     default:
1941       emitGlobalConstantLargeInt(CI, AP);
1942       return;
1943     }
1944   }
1945
1946   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1947     return emitGlobalConstantFP(CFP, AP);
1948
1949   if (isa<ConstantPointerNull>(CV)) {
1950     AP.OutStreamer.EmitIntValue(0, Size);
1951     return;
1952   }
1953
1954   if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(CV))
1955     return emitGlobalConstantDataSequential(CDS, AP);
1956
1957   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1958     return emitGlobalConstantArray(CVA, AP);
1959
1960   if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1961     return emitGlobalConstantStruct(CVS, AP);
1962
1963   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1964     // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of
1965     // vectors).
1966     if (CE->getOpcode() == Instruction::BitCast)
1967       return emitGlobalConstantImpl(CE->getOperand(0), AP);
1968
1969     if (Size > 8) {
1970       // If the constant expression's size is greater than 64-bits, then we have
1971       // to emit the value in chunks. Try to constant fold the value and emit it
1972       // that way.
1973       Constant *New = ConstantFoldConstantExpression(CE, DL);
1974       if (New && New != CE)
1975         return emitGlobalConstantImpl(New, AP);
1976     }
1977   }
1978
1979   if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1980     return emitGlobalConstantVector(V, AP);
1981
1982   // Otherwise, it must be a ConstantExpr.  Lower it to an MCExpr, then emit it
1983   // thread the streamer with EmitValue.
1984   AP.OutStreamer.EmitValue(lowerConstant(CV, AP), Size);
1985 }
1986
1987 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1988 void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
1989   uint64_t Size =
1990       TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(CV->getType());
1991   if (Size)
1992     emitGlobalConstantImpl(CV, *this);
1993   else if (MAI->hasSubsectionsViaSymbols()) {
1994     // If the global has zero size, emit a single byte so that two labels don't
1995     // look like they are at the same location.
1996     OutStreamer.EmitIntValue(0, 1);
1997   }
1998 }
1999
2000 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
2001   // Target doesn't support this yet!
2002   llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
2003 }
2004
2005 void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const {
2006   if (Offset > 0)
2007     OS << '+' << Offset;
2008   else if (Offset < 0)
2009     OS << Offset;
2010 }
2011
2012 //===----------------------------------------------------------------------===//
2013 // Symbol Lowering Routines.
2014 //===----------------------------------------------------------------------===//
2015
2016 /// GetTempSymbol - Return the MCSymbol corresponding to the assembler
2017 /// temporary label with the specified stem and unique ID.
2018 MCSymbol *AsmPrinter::GetTempSymbol(Twine Name, unsigned ID) const {
2019   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
2020   return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix()) +
2021                                       Name + Twine(ID));
2022 }
2023
2024 /// GetTempSymbol - Return an assembler temporary label with the specified
2025 /// stem.
2026 MCSymbol *AsmPrinter::GetTempSymbol(Twine Name) const {
2027   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
2028   return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix())+
2029                                       Name);
2030 }
2031
2032
2033 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
2034   return MMI->getAddrLabelSymbol(BA->getBasicBlock());
2035 }
2036
2037 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const {
2038   return MMI->getAddrLabelSymbol(BB);
2039 }
2040
2041 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
2042 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
2043   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
2044   return OutContext.GetOrCreateSymbol
2045     (Twine(DL->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber())
2046      + "_" + Twine(CPID));
2047 }
2048
2049 /// GetJTISymbol - Return the symbol for the specified jump table entry.
2050 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
2051   return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
2052 }
2053
2054 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
2055 /// FIXME: privatize to AsmPrinter.
2056 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
2057   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
2058   return OutContext.GetOrCreateSymbol
2059   (Twine(DL->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" +
2060    Twine(UID) + "_set_" + Twine(MBBID));
2061 }
2062
2063 MCSymbol *AsmPrinter::getSymbolWithGlobalValueBase(const GlobalValue *GV,
2064                                                    StringRef Suffix) const {
2065   return getObjFileLowering().getSymbolWithGlobalValueBase(GV, Suffix, *Mang,
2066                                                            TM);
2067 }
2068
2069 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
2070 /// ExternalSymbol.
2071 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
2072   SmallString<60> NameStr;
2073   Mang->getNameWithPrefix(NameStr, Sym);
2074   return OutContext.GetOrCreateSymbol(NameStr.str());
2075 }
2076
2077
2078
2079 /// PrintParentLoopComment - Print comments about parent loops of this one.
2080 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2081                                    unsigned FunctionNumber) {
2082   if (!Loop) return;
2083   PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
2084   OS.indent(Loop->getLoopDepth()*2)
2085     << "Parent Loop BB" << FunctionNumber << "_"
2086     << Loop->getHeader()->getNumber()
2087     << " Depth=" << Loop->getLoopDepth() << '\n';
2088 }
2089
2090
2091 /// PrintChildLoopComment - Print comments about child loops within
2092 /// the loop for this basic block, with nesting.
2093 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2094                                   unsigned FunctionNumber) {
2095   // Add child loop information
2096   for (const MachineLoop *CL : *Loop) {
2097     OS.indent(CL->getLoopDepth()*2)
2098       << "Child Loop BB" << FunctionNumber << "_"
2099       << CL->getHeader()->getNumber() << " Depth " << CL->getLoopDepth()
2100       << '\n';
2101     PrintChildLoopComment(OS, CL, FunctionNumber);
2102   }
2103 }
2104
2105 /// emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
2106 static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB,
2107                                        const MachineLoopInfo *LI,
2108                                        const AsmPrinter &AP) {
2109   // Add loop depth information
2110   const MachineLoop *Loop = LI->getLoopFor(&MBB);
2111   if (!Loop) return;
2112
2113   MachineBasicBlock *Header = Loop->getHeader();
2114   assert(Header && "No header for loop");
2115
2116   // If this block is not a loop header, just print out what is the loop header
2117   // and return.
2118   if (Header != &MBB) {
2119     AP.OutStreamer.AddComment("  in Loop: Header=BB" +
2120                               Twine(AP.getFunctionNumber())+"_" +
2121                               Twine(Loop->getHeader()->getNumber())+
2122                               " Depth="+Twine(Loop->getLoopDepth()));
2123     return;
2124   }
2125
2126   // Otherwise, it is a loop header.  Print out information about child and
2127   // parent loops.
2128   raw_ostream &OS = AP.OutStreamer.GetCommentOS();
2129
2130   PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
2131
2132   OS << "=>";
2133   OS.indent(Loop->getLoopDepth()*2-2);
2134
2135   OS << "This ";
2136   if (Loop->empty())
2137     OS << "Inner ";
2138   OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
2139
2140   PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
2141 }
2142
2143
2144 /// EmitBasicBlockStart - This method prints the label for the specified
2145 /// MachineBasicBlock, an alignment (if present) and a comment describing
2146 /// it if appropriate.
2147 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock &MBB) const {
2148   // Emit an alignment directive for this block, if needed.
2149   if (unsigned Align = MBB.getAlignment())
2150     EmitAlignment(Align);
2151
2152   // If the block has its address taken, emit any labels that were used to
2153   // reference the block.  It is possible that there is more than one label
2154   // here, because multiple LLVM BB's may have been RAUW'd to this block after
2155   // the references were generated.
2156   if (MBB.hasAddressTaken()) {
2157     const BasicBlock *BB = MBB.getBasicBlock();
2158     if (isVerbose())
2159       OutStreamer.AddComment("Block address taken");
2160
2161     std::vector<MCSymbol*> Symbols = MMI->getAddrLabelSymbolToEmit(BB);
2162     for (auto *Sym : Symbols)
2163       OutStreamer.EmitLabel(Sym);
2164   }
2165
2166   // Print some verbose block comments.
2167   if (isVerbose()) {
2168     if (const BasicBlock *BB = MBB.getBasicBlock())
2169       if (BB->hasName())
2170         OutStreamer.AddComment("%" + BB->getName());
2171     emitBasicBlockLoopComments(MBB, LI, *this);
2172   }
2173
2174   // Print the main label for the block.
2175   if (MBB.pred_empty() || isBlockOnlyReachableByFallthrough(&MBB)) {
2176     if (isVerbose()) {
2177       // NOTE: Want this comment at start of line, don't emit with AddComment.
2178       OutStreamer.emitRawComment(" BB#" + Twine(MBB.getNumber()) + ":", false);
2179     }
2180   } else {
2181     OutStreamer.EmitLabel(MBB.getSymbol());
2182   }
2183 }
2184
2185 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility,
2186                                 bool IsDefinition) const {
2187   MCSymbolAttr Attr = MCSA_Invalid;
2188
2189   switch (Visibility) {
2190   default: break;
2191   case GlobalValue::HiddenVisibility:
2192     if (IsDefinition)
2193       Attr = MAI->getHiddenVisibilityAttr();
2194     else
2195       Attr = MAI->getHiddenDeclarationVisibilityAttr();
2196     break;
2197   case GlobalValue::ProtectedVisibility:
2198     Attr = MAI->getProtectedVisibilityAttr();
2199     break;
2200   }
2201
2202   if (Attr != MCSA_Invalid)
2203     OutStreamer.EmitSymbolAttribute(Sym, Attr);
2204 }
2205
2206 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
2207 /// exactly one predecessor and the control transfer mechanism between
2208 /// the predecessor and this block is a fall-through.
2209 bool AsmPrinter::
2210 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
2211   // If this is a landing pad, it isn't a fall through.  If it has no preds,
2212   // then nothing falls through to it.
2213   if (MBB->isLandingPad() || MBB->pred_empty())
2214     return false;
2215
2216   // If there isn't exactly one predecessor, it can't be a fall through.
2217   if (MBB->pred_size() > 1)
2218     return false;
2219
2220   // The predecessor has to be immediately before this block.
2221   MachineBasicBlock *Pred = *MBB->pred_begin();
2222   if (!Pred->isLayoutSuccessor(MBB))
2223     return false;
2224
2225   // If the block is completely empty, then it definitely does fall through.
2226   if (Pred->empty())
2227     return true;
2228
2229   // Check the terminators in the previous blocks
2230   for (const auto &MI : Pred->terminators()) {
2231     // If it is not a simple branch, we are in a table somewhere.
2232     if (!MI.isBranch() || MI.isIndirectBranch())
2233       return false;
2234
2235     // If we are the operands of one of the branches, this is not a fall
2236     // through. Note that targets with delay slots will usually bundle
2237     // terminators with the delay slot instruction.
2238     for (ConstMIBundleOperands OP(&MI); OP.isValid(); ++OP) {
2239       if (OP->isJTI())
2240         return false;
2241       if (OP->isMBB() && OP->getMBB() == MBB)
2242         return false;
2243     }
2244   }
2245
2246   return true;
2247 }
2248
2249
2250
2251 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy &S) {
2252   if (!S.usesMetadata())
2253     return nullptr;
2254
2255   gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
2256   gcp_map_type::iterator GCPI = GCMap.find(&S);
2257   if (GCPI != GCMap.end())
2258     return GCPI->second.get();
2259
2260   const char *Name = S.getName().c_str();
2261
2262   for (GCMetadataPrinterRegistry::iterator
2263          I = GCMetadataPrinterRegistry::begin(),
2264          E = GCMetadataPrinterRegistry::end(); I != E; ++I)
2265     if (strcmp(Name, I->getName()) == 0) {
2266       std::unique_ptr<GCMetadataPrinter> GMP = I->instantiate();
2267       GMP->S = &S;
2268       auto IterBool = GCMap.insert(std::make_pair(&S, std::move(GMP)));
2269       return IterBool.first->second.get();
2270     }
2271
2272   report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
2273 }
2274
2275 /// Pin vtable to this file.
2276 AsmPrinterHandler::~AsmPrinterHandler() {}