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