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