lib/IR/AsmWriter.cpp

   1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
   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 library implements the functionality defined in llvm/IR/Writer.h
  11 //
  12 // Note that these routines must be extremely tolerant of various errors in the
  13 // LLVM code, because it can be used for debugging transformations.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/ADT/DenseMap.h"
  18 #include "llvm/ADT/STLExtras.h"
  19 #include "llvm/ADT/SetVector.h"
  20 #include "llvm/ADT/SmallString.h"
  21 #include "llvm/ADT/StringExtras.h"
  22 #include "llvm/IR/AssemblyAnnotationWriter.h"
  23 #include "llvm/IR/CFG.h"
  24 #include "llvm/IR/CallingConv.h"
  25 #include "llvm/IR/Constants.h"
  26 #include "llvm/IR/DebugInfo.h"
  27 #include "llvm/IR/DerivedTypes.h"
  28 #include "llvm/IR/IRPrintingPasses.h"
  29 #include "llvm/IR/InlineAsm.h"
  30 #include "llvm/IR/IntrinsicInst.h"
  31 #include "llvm/IR/LLVMContext.h"
  32 #include "llvm/IR/Module.h"
  33 #include "llvm/IR/ModuleSlotTracker.h"
  34 #include "llvm/IR/Operator.h"
  35 #include "llvm/IR/Statepoint.h"
  36 #include "llvm/IR/TypeFinder.h"
  37 #include "llvm/IR/UseListOrder.h"
  38 #include "llvm/IR/ValueSymbolTable.h"
  39 #include "llvm/Support/Debug.h"
  40 #include "llvm/Support/Dwarf.h"
  41 #include "llvm/Support/ErrorHandling.h"
  42 #include "llvm/Support/FormattedStream.h"
  43 #include "llvm/Support/MathExtras.h"
  44 #include "llvm/Support/raw_ostream.h"
  45 #include <algorithm>
  46 #include <cctype>
  47 using namespace llvm;
  48
  49 // Make virtual table appear in this compilation unit.
  50 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
  51
  52 //===----------------------------------------------------------------------===//
  53 // Helper Functions
  54 //===----------------------------------------------------------------------===//
  55
  56 namespace {
  57 struct OrderMap {
  58   DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
  59
  60   unsigned size() const { return IDs.size(); }
  61   std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
  62   std::pair<unsigned, bool> lookup(const Value *V) const {
  63     return IDs.lookup(V);
  64   }
  65   void index(const Value *V) {
  66     // Explicitly sequence get-size and insert-value operations to avoid UB.
  67     unsigned ID = IDs.size() + 1;
  68     IDs[V].first = ID;
  69   }
  70 };
  71 }
  72
  73 static void orderValue(const Value *V, OrderMap &OM) {
  74   if (OM.lookup(V).first)
  75     return;
  76
  77   if (const Constant *C = dyn_cast<Constant>(V))
  78     if (C->getNumOperands() && !isa<GlobalValue>(C))
  79       for (const Value *Op : C->operands())
  80         if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
  81           orderValue(Op, OM);
  82
  83   // Note: we cannot cache this lookup above, since inserting into the map
  84   // changes the map's size, and thus affects the other IDs.
  85   OM.index(V);
  86 }
  87
  88 static OrderMap orderModule(const Module *M) {
  89   // This needs to match the order used by ValueEnumerator::ValueEnumerator()
  90   // and ValueEnumerator::incorporateFunction().
  91   OrderMap OM;
  92
  93   for (const GlobalVariable &G : M->globals()) {
  94     if (G.hasInitializer())
  95       if (!isa<GlobalValue>(G.getInitializer()))
  96         orderValue(G.getInitializer(), OM);
  97     orderValue(&G, OM);
  98   }
  99   for (const GlobalAlias &A : M->aliases()) {
 100     if (!isa<GlobalValue>(A.getAliasee()))
 101       orderValue(A.getAliasee(), OM);
 102     orderValue(&A, OM);
 103   }
 104   for (const Function &F : *M) {
 105     if (F.hasPrefixData())
 106       if (!isa<GlobalValue>(F.getPrefixData()))
 107         orderValue(F.getPrefixData(), OM);
 108
 109     if (F.hasPrologueData())
 110       if (!isa<GlobalValue>(F.getPrologueData()))
 111         orderValue(F.getPrologueData(), OM);
 112
 113     if (F.hasPersonalityFn())
 114       if (!isa<GlobalValue>(F.getPersonalityFn()))
 115         orderValue(F.getPersonalityFn(), OM);
 116
 117     orderValue(&F, OM);
 118
 119     if (F.isDeclaration())
 120       continue;
 121
 122     for (const Argument &A : F.args())
 123       orderValue(&A, OM);
 124     for (const BasicBlock &BB : F) {
 125       orderValue(&BB, OM);
 126       for (const Instruction &I : BB) {
 127         for (const Value *Op : I.operands())
 128           if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
 129               isa<InlineAsm>(*Op))
 130             orderValue(Op, OM);
 131         orderValue(&I, OM);
 132       }
 133     }
 134   }
 135   return OM;
 136 }
 137
 138 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
 139                                          unsigned ID, const OrderMap &OM,
 140                                          UseListOrderStack &Stack) {
 141   // Predict use-list order for this one.
 142   typedef std::pair<const Use *, unsigned> Entry;
 143   SmallVector<Entry, 64> List;
 144   for (const Use &U : V->uses())
 145     // Check if this user will be serialized.
 146     if (OM.lookup(U.getUser()).first)
 147       List.push_back(std::make_pair(&U, List.size()));
 148
 149   if (List.size() < 2)
 150     // We may have lost some users.
 151     return;
 152
 153   bool GetsReversed =
 154       !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
 155   if (auto *BA = dyn_cast<BlockAddress>(V))
 156     ID = OM.lookup(BA->getBasicBlock()).first;
 157   std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
 158     const Use *LU = L.first;
 159     const Use *RU = R.first;
 160     if (LU == RU)
 161       return false;
 162
 163     auto LID = OM.lookup(LU->getUser()).first;
 164     auto RID = OM.lookup(RU->getUser()).first;
 165
 166     // If ID is 4, then expect: 7 6 5 1 2 3.
 167     if (LID < RID) {
 168       if (GetsReversed)
 169         if (RID <= ID)
 170           return true;
 171       return false;
 172     }
 173     if (RID < LID) {
 174       if (GetsReversed)
 175         if (LID <= ID)
 176           return false;
 177       return true;
 178     }
 179
 180     // LID and RID are equal, so we have different operands of the same user.
 181     // Assume operands are added in order for all instructions.
 182     if (GetsReversed)
 183       if (LID <= ID)
 184         return LU->getOperandNo() < RU->getOperandNo();
 185     return LU->getOperandNo() > RU->getOperandNo();
 186   });
 187
 188   if (std::is_sorted(
 189           List.begin(), List.end(),
 190           [](const Entry &L, const Entry &R) { return L.second < R.second; }))
 191     // Order is already correct.
 192     return;
 193
 194   // Store the shuffle.
 195   Stack.emplace_back(V, F, List.size());
 196   assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
 197   for (size_t I = 0, E = List.size(); I != E; ++I)
 198     Stack.back().Shuffle[I] = List[I].second;
 199 }
 200
 201 static void predictValueUseListOrder(const Value *V, const Function *F,
 202                                      OrderMap &OM, UseListOrderStack &Stack) {
 203   auto &IDPair = OM[V];
 204   assert(IDPair.first && "Unmapped value");
 205   if (IDPair.second)
 206     // Already predicted.
 207     return;
 208
 209   // Do the actual prediction.
 210   IDPair.second = true;
 211   if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
 212     predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
 213
 214   // Recursive descent into constants.
 215   if (const Constant *C = dyn_cast<Constant>(V))
 216     if (C->getNumOperands()) // Visit GlobalValues.
 217       for (const Value *Op : C->operands())
 218         if (isa<Constant>(Op)) // Visit GlobalValues.
 219           predictValueUseListOrder(Op, F, OM, Stack);
 220 }
 221
 222 static UseListOrderStack predictUseListOrder(const Module *M) {
 223   OrderMap OM = orderModule(M);
 224
 225   // Use-list orders need to be serialized after all the users have been added
 226   // to a value, or else the shuffles will be incomplete.  Store them per
 227   // function in a stack.
 228   //
 229   // Aside from function order, the order of values doesn't matter much here.
 230   UseListOrderStack Stack;
 231
 232   // We want to visit the functions backward now so we can list function-local
 233   // constants in the last Function they're used in.  Module-level constants
 234   // have already been visited above.
 235   for (const Function &F : make_range(M->rbegin(), M->rend())) {
 236     if (F.isDeclaration())
 237       continue;
 238     for (const BasicBlock &BB : F)
 239       predictValueUseListOrder(&BB, &F, OM, Stack);
 240     for (const Argument &A : F.args())
 241       predictValueUseListOrder(&A, &F, OM, Stack);
 242     for (const BasicBlock &BB : F)
 243       for (const Instruction &I : BB)
 244         for (const Value *Op : I.operands())
 245           if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
 246             predictValueUseListOrder(Op, &F, OM, Stack);
 247     for (const BasicBlock &BB : F)
 248       for (const Instruction &I : BB)
 249         predictValueUseListOrder(&I, &F, OM, Stack);
 250   }
 251
 252   // Visit globals last.
 253   for (const GlobalVariable &G : M->globals())
 254     predictValueUseListOrder(&G, nullptr, OM, Stack);
 255   for (const Function &F : *M)
 256     predictValueUseListOrder(&F, nullptr, OM, Stack);
 257   for (const GlobalAlias &A : M->aliases())
 258     predictValueUseListOrder(&A, nullptr, OM, Stack);
 259   for (const GlobalVariable &G : M->globals())
 260     if (G.hasInitializer())
 261       predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
 262   for (const GlobalAlias &A : M->aliases())
 263     predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
 264   for (const Function &F : *M)
 265     if (F.hasPrefixData())
 266       predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
 267
 268   return Stack;
 269 }
 270
 271 static const Module *getModuleFromVal(const Value *V) {
 272   if (const Argument *MA = dyn_cast<Argument>(V))
 273     return MA->getParent() ? MA->getParent()->getParent() : nullptr;
 274
 275   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 276     return BB->getParent() ? BB->getParent()->getParent() : nullptr;
 277
 278   if (const Instruction *I = dyn_cast<Instruction>(V)) {
 279     const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
 280     return M ? M->getParent() : nullptr;
 281   }
 282
 283   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
 284     return GV->getParent();
 285
 286   if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
 287     for (const User *U : MAV->users())
 288       if (isa<Instruction>(U))
 289         if (const Module *M = getModuleFromVal(U))
 290           return M;
 291     return nullptr;
 292   }
 293
 294   return nullptr;
 295 }
 296
 297 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
 298   switch (cc) {
 299   default:                         Out << "cc" << cc; break;
 300   case CallingConv::Fast:          Out << "fastcc"; break;
 301   case CallingConv::Cold:          Out << "coldcc"; break;
 302   case CallingConv::WebKit_JS:     Out << "webkit_jscc"; break;
 303   case CallingConv::AnyReg:        Out << "anyregcc"; break;
 304   case CallingConv::PreserveMost:  Out << "preserve_mostcc"; break;
 305   case CallingConv::PreserveAll:   Out << "preserve_allcc"; break;
 306   case CallingConv::GHC:           Out << "ghccc"; break;
 307   case CallingConv::X86_StdCall:   Out << "x86_stdcallcc"; break;
 308   case CallingConv::X86_FastCall:  Out << "x86_fastcallcc"; break;
 309   case CallingConv::X86_ThisCall:  Out << "x86_thiscallcc"; break;
 310   case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
 311   case CallingConv::Intel_OCL_BI:  Out << "intel_ocl_bicc"; break;
 312   case CallingConv::ARM_APCS:      Out << "arm_apcscc"; break;
 313   case CallingConv::ARM_AAPCS:     Out << "arm_aapcscc"; break;
 314   case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
 315   case CallingConv::MSP430_INTR:   Out << "msp430_intrcc"; break;
 316   case CallingConv::PTX_Kernel:    Out << "ptx_kernel"; break;
 317   case CallingConv::PTX_Device:    Out << "ptx_device"; break;
 318   case CallingConv::X86_64_SysV:   Out << "x86_64_sysvcc"; break;
 319   case CallingConv::X86_64_Win64:  Out << "x86_64_win64cc"; break;
 320   case CallingConv::SPIR_FUNC:     Out << "spir_func"; break;
 321   case CallingConv::SPIR_KERNEL:   Out << "spir_kernel"; break;
 322   }
 323 }
 324
 325 // PrintEscapedString - Print each character of the specified string, escaping
 326 // it if it is not printable or if it is an escape char.
 327 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
 328   for (unsigned i = 0, e = Name.size(); i != e; ++i) {
 329     unsigned char C = Name[i];
 330     if (isprint(C) && C != '\\' && C != '"')
 331       Out << C;
 332     else
 333       Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
 334   }
 335 }
 336
 337 enum PrefixType {
 338   GlobalPrefix,
 339   ComdatPrefix,
 340   LabelPrefix,
 341   LocalPrefix,
 342   NoPrefix
 343 };
 344
 345 void llvm::printLLVMNameWithoutPrefix(raw_ostream &OS, StringRef Name) {
 346   assert(!Name.empty() && "Cannot get empty name!");
 347
 348   // Scan the name to see if it needs quotes first.
 349   bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
 350   if (!NeedsQuotes) {
 351     for (unsigned i = 0, e = Name.size(); i != e; ++i) {
 352       // By making this unsigned, the value passed in to isalnum will always be
 353       // in the range 0-255.  This is important when building with MSVC because
 354       // its implementation will assert.  This situation can arise when dealing
 355       // with UTF-8 multibyte characters.
 356       unsigned char C = Name[i];
 357       if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
 358           C != '_') {
 359         NeedsQuotes = true;
 360         break;
 361       }
 362     }
 363   }
 364
 365   // If we didn't need any quotes, just write out the name in one blast.
 366   if (!NeedsQuotes) {
 367     OS << Name;
 368     return;
 369   }
 370
 371   // Okay, we need quotes.  Output the quotes and escape any scary characters as
 372   // needed.
 373   OS << '"';
 374   PrintEscapedString(Name, OS);
 375   OS << '"';
 376 }
 377
 378 /// Turn the specified name into an 'LLVM name', which is either prefixed with %
 379 /// (if the string only contains simple characters) or is surrounded with ""'s
 380 /// (if it has special chars in it). Print it out.
 381 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
 382   switch (Prefix) {
 383   case NoPrefix:
 384     break;
 385   case GlobalPrefix:
 386     OS << '@';
 387     break;
 388   case ComdatPrefix:
 389     OS << '$';
 390     break;
 391   case LabelPrefix:
 392     break;
 393   case LocalPrefix:
 394     OS << '%';
 395     break;
 396   }
 397   printLLVMNameWithoutPrefix(OS, Name);
 398 }
 399
 400 /// Turn the specified name into an 'LLVM name', which is either prefixed with %
 401 /// (if the string only contains simple characters) or is surrounded with ""'s
 402 /// (if it has special chars in it). Print it out.
 403 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
 404   PrintLLVMName(OS, V->getName(),
 405                 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
 406 }
 407
 408
 409 namespace {
 410 class TypePrinting {
 411   TypePrinting(const TypePrinting &) = delete;
 412   void operator=(const TypePrinting&) = delete;
 413 public:
 414
 415   /// NamedTypes - The named types that are used by the current module.
 416   TypeFinder NamedTypes;
 417
 418   /// NumberedTypes - The numbered types, along with their value.
 419   DenseMap<StructType*, unsigned> NumberedTypes;
 420
 421   TypePrinting() = default;
 422
 423   void incorporateTypes(const Module &M);
 424
 425   void print(Type *Ty, raw_ostream &OS);
 426
 427   void printStructBody(StructType *Ty, raw_ostream &OS);
 428 };
 429 } // namespace
 430
 431 void TypePrinting::incorporateTypes(const Module &M) {
 432   NamedTypes.run(M, false);
 433
 434   // The list of struct types we got back includes all the struct types, split
 435   // the unnamed ones out to a numbering and remove the anonymous structs.
 436   unsigned NextNumber = 0;
 437
 438   std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
 439   for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
 440     StructType *STy = *I;
 441
 442     // Ignore anonymous types.
 443     if (STy->isLiteral())
 444       continue;
 445
 446     if (STy->getName().empty())
 447       NumberedTypes[STy] = NextNumber++;
 448     else
 449       *NextToUse++ = STy;
 450   }
 451
 452   NamedTypes.erase(NextToUse, NamedTypes.end());
 453 }
 454
 455
 456 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
 457 /// use of type names or up references to shorten the type name where possible.
 458 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
 459   switch (Ty->getTypeID()) {
 460   case Type::VoidTyID:      OS << "void"; return;
 461   case Type::HalfTyID:      OS << "half"; return;
 462   case Type::FloatTyID:     OS << "float"; return;
 463   case Type::DoubleTyID:    OS << "double"; return;
 464   case Type::X86_FP80TyID:  OS << "x86_fp80"; return;
 465   case Type::FP128TyID:     OS << "fp128"; return;
 466   case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
 467   case Type::LabelTyID:     OS << "label"; return;
 468   case Type::MetadataTyID:  OS << "metadata"; return;
 469   case Type::X86_MMXTyID:   OS << "x86_mmx"; return;
 470   case Type::TokenTyID:     OS << "token"; return;
 471   case Type::IntegerTyID:
 472     OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
 473     return;
 474
 475   case Type::FunctionTyID: {
 476     FunctionType *FTy = cast<FunctionType>(Ty);
 477     print(FTy->getReturnType(), OS);
 478     OS << " (";
 479     for (FunctionType::param_iterator I = FTy->param_begin(),
 480          E = FTy->param_end(); I != E; ++I) {
 481       if (I != FTy->param_begin())
 482         OS << ", ";
 483       print(*I, OS);
 484     }
 485     if (FTy->isVarArg()) {
 486       if (FTy->getNumParams()) OS << ", ";
 487       OS << "...";
 488     }
 489     OS << ')';
 490     return;
 491   }
 492   case Type::StructTyID: {
 493     StructType *STy = cast<StructType>(Ty);
 494
 495     if (STy->isLiteral())
 496       return printStructBody(STy, OS);
 497
 498     if (!STy->getName().empty())
 499       return PrintLLVMName(OS, STy->getName(), LocalPrefix);
 500
 501     DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
 502     if (I != NumberedTypes.end())
 503       OS << '%' << I->second;
 504     else  // Not enumerated, print the hex address.
 505       OS << "%\"type " << STy << '\"';
 506     return;
 507   }
 508   case Type::PointerTyID: {
 509     PointerType *PTy = cast<PointerType>(Ty);
 510     print(PTy->getElementType(), OS);
 511     if (unsigned AddressSpace = PTy->getAddressSpace())
 512       OS << " addrspace(" << AddressSpace << ')';
 513     OS << '*';
 514     return;
 515   }
 516   case Type::ArrayTyID: {
 517     ArrayType *ATy = cast<ArrayType>(Ty);
 518     OS << '[' << ATy->getNumElements() << " x ";
 519     print(ATy->getElementType(), OS);
 520     OS << ']';
 521     return;
 522   }
 523   case Type::VectorTyID: {
 524     VectorType *PTy = cast<VectorType>(Ty);
 525     OS << "<" << PTy->getNumElements() << " x ";
 526     print(PTy->getElementType(), OS);
 527     OS << '>';
 528     return;
 529   }
 530   }
 531   llvm_unreachable("Invalid TypeID");
 532 }
 533
 534 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
 535   if (STy->isOpaque()) {
 536     OS << "opaque";
 537     return;
 538   }
 539
 540   if (STy->isPacked())
 541     OS << '<';
 542
 543   if (STy->getNumElements() == 0) {
 544     OS << "{}";
 545   } else {
 546     StructType::element_iterator I = STy->element_begin();
 547     OS << "{ ";
 548     print(*I++, OS);
 549     for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
 550       OS << ", ";
 551       print(*I, OS);
 552     }
 553
 554     OS << " }";
 555   }
 556   if (STy->isPacked())
 557     OS << '>';
 558 }
 559
 560 namespace llvm {
 561 //===----------------------------------------------------------------------===//
 562 // SlotTracker Class: Enumerate slot numbers for unnamed values
 563 //===----------------------------------------------------------------------===//
 564 /// This class provides computation of slot numbers for LLVM Assembly writing.
 565 ///
 566 class SlotTracker {
 567 public:
 568   /// ValueMap - A mapping of Values to slot numbers.
 569   typedef DenseMap<const Value*, unsigned> ValueMap;
 570
 571 private:
 572   /// TheModule - The module for which we are holding slot numbers.
 573   const Module* TheModule;
 574
 575   /// TheFunction - The function for which we are holding slot numbers.
 576   const Function* TheFunction;
 577   bool FunctionProcessed;
 578   bool ShouldInitializeAllMetadata;
 579
 580   /// mMap - The slot map for the module level data.
 581   ValueMap mMap;
 582   unsigned mNext;
 583
 584   /// fMap - The slot map for the function level data.
 585   ValueMap fMap;
 586   unsigned fNext;
 587
 588   /// mdnMap - Map for MDNodes.
 589   DenseMap<const MDNode*, unsigned> mdnMap;
 590   unsigned mdnNext;
 591
 592   /// asMap - The slot map for attribute sets.
 593   DenseMap<AttributeSet, unsigned> asMap;
 594   unsigned asNext;
 595 public:
 596   /// Construct from a module.
 597   ///
 598   /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
 599   /// functions, giving correct numbering for metadata referenced only from
 600   /// within a function (even if no functions have been initialized).
 601   explicit SlotTracker(const Module *M,
 602                        bool ShouldInitializeAllMetadata = false);
 603   /// Construct from a function, starting out in incorp state.
 604   ///
 605   /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
 606   /// functions, giving correct numbering for metadata referenced only from
 607   /// within a function (even if no functions have been initialized).
 608   explicit SlotTracker(const Function *F,
 609                        bool ShouldInitializeAllMetadata = false);
 610
 611   /// Return the slot number of the specified value in it's type
 612   /// plane.  If something is not in the SlotTracker, return -1.
 613   int getLocalSlot(const Value *V);
 614   int getGlobalSlot(const GlobalValue *V);
 615   int getMetadataSlot(const MDNode *N);
 616   int getAttributeGroupSlot(AttributeSet AS);
 617
 618   /// If you'd like to deal with a function instead of just a module, use
 619   /// this method to get its data into the SlotTracker.
 620   void incorporateFunction(const Function *F) {
 621     TheFunction = F;
 622     FunctionProcessed = false;
 623   }
 624
 625   const Function *getFunction() const { return TheFunction; }
 626
 627   /// After calling incorporateFunction, use this method to remove the
 628   /// most recently incorporated function from the SlotTracker. This
 629   /// will reset the state of the machine back to just the module contents.
 630   void purgeFunction();
 631
 632   /// MDNode map iterators.
 633   typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
 634   mdn_iterator mdn_begin() { return mdnMap.begin(); }
 635   mdn_iterator mdn_end() { return mdnMap.end(); }
 636   unsigned mdn_size() const { return mdnMap.size(); }
 637   bool mdn_empty() const { return mdnMap.empty(); }
 638
 639   /// AttributeSet map iterators.
 640   typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
 641   as_iterator as_begin()   { return asMap.begin(); }
 642   as_iterator as_end()     { return asMap.end(); }
 643   unsigned as_size() const { return asMap.size(); }
 644   bool as_empty() const    { return asMap.empty(); }
 645
 646   /// This function does the actual initialization.
 647   inline void initialize();
 648
 649   // Implementation Details
 650 private:
 651   /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
 652   void CreateModuleSlot(const GlobalValue *V);
 653
 654   /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
 655   void CreateMetadataSlot(const MDNode *N);
 656
 657   /// CreateFunctionSlot - Insert the specified Value* into the slot table.
 658   void CreateFunctionSlot(const Value *V);
 659
 660   /// \brief Insert the specified AttributeSet into the slot table.
 661   void CreateAttributeSetSlot(AttributeSet AS);
 662
 663   /// Add all of the module level global variables (and their initializers)
 664   /// and function declarations, but not the contents of those functions.
 665   void processModule();
 666
 667   /// Add all of the functions arguments, basic blocks, and instructions.
 668   void processFunction();
 669
 670   /// Add all of the metadata from a function.
 671   void processFunctionMetadata(const Function &F);
 672
 673   /// Add all of the metadata from an instruction.
 674   void processInstructionMetadata(const Instruction &I);
 675
 676   SlotTracker(const SlotTracker &) = delete;
 677   void operator=(const SlotTracker &) = delete;
 678 };
 679 } // namespace llvm
 680
 681 ModuleSlotTracker::ModuleSlotTracker(SlotTracker &Machine, const Module *M,
 682                                      const Function *F)
 683     : M(M), F(F), Machine(&Machine) {}
 684
 685 ModuleSlotTracker::ModuleSlotTracker(const Module *M,
 686                                      bool ShouldInitializeAllMetadata)
 687     : MachineStorage(M ? new SlotTracker(M, ShouldInitializeAllMetadata)
 688                        : nullptr),
 689       M(M), Machine(MachineStorage.get()) {}
 690
 691 ModuleSlotTracker::~ModuleSlotTracker() {}
 692
 693 void ModuleSlotTracker::incorporateFunction(const Function &F) {
 694   if (!Machine)
 695     return;
 696
 697   // Nothing to do if this is the right function already.
 698   if (this->F == &F)
 699     return;
 700   if (this->F)
 701     Machine->purgeFunction();
 702   Machine->incorporateFunction(&F);
 703   this->F = &F;
 704 }
 705
 706 int ModuleSlotTracker::getLocalSlot(const Value *V) {
 707   assert(F && "No function incorporated");
 708   return Machine->getLocalSlot(V);
 709 }
 710
 711 static SlotTracker *createSlotTracker(const Value *V) {
 712   if (const Argument *FA = dyn_cast<Argument>(V))
 713     return new SlotTracker(FA->getParent());
 714
 715   if (const Instruction *I = dyn_cast<Instruction>(V))
 716     if (I->getParent())
 717       return new SlotTracker(I->getParent()->getParent());
 718
 719   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 720     return new SlotTracker(BB->getParent());
 721
 722   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
 723     return new SlotTracker(GV->getParent());
 724
 725   if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
 726     return new SlotTracker(GA->getParent());
 727
 728   if (const Function *Func = dyn_cast<Function>(V))
 729     return new SlotTracker(Func);
 730
 731   return nullptr;
 732 }
 733
 734 #if 0
 735 #define ST_DEBUG(X) dbgs() << X
 736 #else
 737 #define ST_DEBUG(X)
 738 #endif
 739
 740 // Module level constructor. Causes the contents of the Module (sans functions)
 741 // to be added to the slot table.
 742 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
 743     : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
 744       ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
 745       fNext(0), mdnNext(0), asNext(0) {}
 746
 747 // Function level constructor. Causes the contents of the Module and the one
 748 // function provided to be added to the slot table.
 749 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
 750     : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
 751       FunctionProcessed(false),
 752       ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
 753       fNext(0), mdnNext(0), asNext(0) {}
 754
 755 inline void SlotTracker::initialize() {
 756   if (TheModule) {
 757     processModule();
 758     TheModule = nullptr; ///< Prevent re-processing next time we're called.
 759   }
 760
 761   if (TheFunction && !FunctionProcessed)
 762     processFunction();
 763 }
 764
 765 // Iterate through all the global variables, functions, and global
 766 // variable initializers and create slots for them.
 767 void SlotTracker::processModule() {
 768   ST_DEBUG("begin processModule!\n");
 769
 770   // Add all of the unnamed global variables to the value table.
 771   for (const GlobalVariable &Var : TheModule->globals()) {
 772     if (!Var.hasName())
 773       CreateModuleSlot(&Var);
 774   }
 775
 776   for (const GlobalAlias &A : TheModule->aliases()) {
 777     if (!A.hasName())
 778       CreateModuleSlot(&A);
 779   }
 780
 781   // Add metadata used by named metadata.
 782   for (const NamedMDNode &NMD : TheModule->named_metadata()) {
 783     for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i)
 784       CreateMetadataSlot(NMD.getOperand(i));
 785   }
 786
 787   for (const Function &F : *TheModule) {
 788     if (!F.hasName())
 789       // Add all the unnamed functions to the table.
 790       CreateModuleSlot(&F);
 791
 792     if (ShouldInitializeAllMetadata)
 793       processFunctionMetadata(F);
 794
 795     // Add all the function attributes to the table.
 796     // FIXME: Add attributes of other objects?
 797     AttributeSet FnAttrs = F.getAttributes().getFnAttributes();
 798     if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
 799       CreateAttributeSetSlot(FnAttrs);
 800   }
 801
 802   ST_DEBUG("end processModule!\n");
 803 }
 804
 805 // Process the arguments, basic blocks, and instructions  of a function.
 806 void SlotTracker::processFunction() {
 807   ST_DEBUG("begin processFunction!\n");
 808   fNext = 0;
 809
 810   // Process function metadata if it wasn't hit at the module-level.
 811   if (!ShouldInitializeAllMetadata)
 812     processFunctionMetadata(*TheFunction);
 813
 814   // Add all the function arguments with no names.
 815   for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
 816       AE = TheFunction->arg_end(); AI != AE; ++AI)
 817     if (!AI->hasName())
 818       CreateFunctionSlot(AI);
 819
 820   ST_DEBUG("Inserting Instructions:\n");
 821
 822   // Add all of the basic blocks and instructions with no names.
 823   for (auto &BB : *TheFunction) {
 824     if (!BB.hasName())
 825       CreateFunctionSlot(&BB);
 826
 827     for (auto &I : BB) {
 828       if (!I.getType()->isVoidTy() && !I.hasName())
 829         CreateFunctionSlot(&I);
 830
 831       // We allow direct calls to any llvm.foo function here, because the
 832       // target may not be linked into the optimizer.
 833       if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
 834         // Add all the call attributes to the table.
 835         AttributeSet Attrs = CI->getAttributes().getFnAttributes();
 836         if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
 837           CreateAttributeSetSlot(Attrs);
 838       } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
 839         // Add all the call attributes to the table.
 840         AttributeSet Attrs = II->getAttributes().getFnAttributes();
 841         if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
 842           CreateAttributeSetSlot(Attrs);
 843       }
 844     }
 845   }
 846
 847   FunctionProcessed = true;
 848
 849   ST_DEBUG("end processFunction!\n");
 850 }
 851
 852 void SlotTracker::processFunctionMetadata(const Function &F) {
 853   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
 854   F.getAllMetadata(MDs);
 855   for (auto &MD : MDs)
 856     CreateMetadataSlot(MD.second);
 857
 858   for (auto &BB : F) {
 859     for (auto &I : BB)
 860       processInstructionMetadata(I);
 861   }
 862 }
 863
 864 void SlotTracker::processInstructionMetadata(const Instruction &I) {
 865   // Process metadata used directly by intrinsics.
 866   if (const CallInst *CI = dyn_cast<CallInst>(&I))
 867     if (Function *F = CI->getCalledFunction())
 868       if (F->isIntrinsic())
 869         for (auto &Op : I.operands())
 870           if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
 871             if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
 872               CreateMetadataSlot(N);
 873
 874   // Process metadata attached to this instruction.
 875   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
 876   I.getAllMetadata(MDs);
 877   for (auto &MD : MDs)
 878     CreateMetadataSlot(MD.second);
 879 }
 880
 881 /// Clean up after incorporating a function. This is the only way to get out of
 882 /// the function incorporation state that affects get*Slot/Create*Slot. Function
 883 /// incorporation state is indicated by TheFunction != 0.
 884 void SlotTracker::purgeFunction() {
 885   ST_DEBUG("begin purgeFunction!\n");
 886   fMap.clear(); // Simply discard the function level map
 887   TheFunction = nullptr;
 888   FunctionProcessed = false;
 889   ST_DEBUG("end purgeFunction!\n");
 890 }
 891
 892 /// getGlobalSlot - Get the slot number of a global value.
 893 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
 894   // Check for uninitialized state and do lazy initialization.
 895   initialize();
 896
 897   // Find the value in the module map
 898   ValueMap::iterator MI = mMap.find(V);
 899   return MI == mMap.end() ? -1 : (int)MI->second;
 900 }
 901
 902 /// getMetadataSlot - Get the slot number of a MDNode.
 903 int SlotTracker::getMetadataSlot(const MDNode *N) {
 904   // Check for uninitialized state and do lazy initialization.
 905   initialize();
 906
 907   // Find the MDNode in the module map
 908   mdn_iterator MI = mdnMap.find(N);
 909   return MI == mdnMap.end() ? -1 : (int)MI->second;
 910 }
 911
 912
 913 /// getLocalSlot - Get the slot number for a value that is local to a function.
 914 int SlotTracker::getLocalSlot(const Value *V) {
 915   assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
 916
 917   // Check for uninitialized state and do lazy initialization.
 918   initialize();
 919
 920   ValueMap::iterator FI = fMap.find(V);
 921   return FI == fMap.end() ? -1 : (int)FI->second;
 922 }
 923
 924 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
 925   // Check for uninitialized state and do lazy initialization.
 926   initialize();
 927
 928   // Find the AttributeSet in the module map.
 929   as_iterator AI = asMap.find(AS);
 930   return AI == asMap.end() ? -1 : (int)AI->second;
 931 }
 932
 933 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
 934 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
 935   assert(V && "Can't insert a null Value into SlotTracker!");
 936   assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
 937   assert(!V->hasName() && "Doesn't need a slot!");
 938
 939   unsigned DestSlot = mNext++;
 940   mMap[V] = DestSlot;
 941
 942   ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
 943            DestSlot << " [");
 944   // G = Global, F = Function, A = Alias, o = other
 945   ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
 946             (isa<Function>(V) ? 'F' :
 947              (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
 948 }
 949
 950 /// CreateSlot - Create a new slot for the specified value if it has no name.
 951 void SlotTracker::CreateFunctionSlot(const Value *V) {
 952   assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
 953
 954   unsigned DestSlot = fNext++;
 955   fMap[V] = DestSlot;
 956
 957   // G = Global, F = Function, o = other
 958   ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
 959            DestSlot << " [o]\n");
 960 }
 961
 962 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
 963 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
 964   assert(N && "Can't insert a null Value into SlotTracker!");
 965
 966   unsigned DestSlot = mdnNext;
 967   if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
 968     return;
 969   ++mdnNext;
 970
 971   // Recursively add any MDNodes referenced by operands.
 972   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
 973     if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
 974       CreateMetadataSlot(Op);
 975 }
 976
 977 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
 978   assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
 979          "Doesn't need a slot!");
 980
 981   as_iterator I = asMap.find(AS);
 982   if (I != asMap.end())
 983     return;
 984
 985   unsigned DestSlot = asNext++;
 986   asMap[AS] = DestSlot;
 987 }
 988
 989 //===----------------------------------------------------------------------===//
 990 // AsmWriter Implementation
 991 //===----------------------------------------------------------------------===//
 992
 993 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
 994                                    TypePrinting *TypePrinter,
 995                                    SlotTracker *Machine,
 996                                    const Module *Context);
 997
 998 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
 999                                    TypePrinting *TypePrinter,
1000                                    SlotTracker *Machine, const Module *Context,
1001                                    bool FromValue = false);
1002
1003 static const char *getPredicateText(unsigned predicate) {
1004   const char * pred = "unknown";
1005   switch (predicate) {
1006   case FCmpInst::FCMP_FALSE: pred = "false"; break;
1007   case FCmpInst::FCMP_OEQ:   pred = "oeq"; break;
1008   case FCmpInst::FCMP_OGT:   pred = "ogt"; break;
1009   case FCmpInst::FCMP_OGE:   pred = "oge"; break;
1010   case FCmpInst::FCMP_OLT:   pred = "olt"; break;
1011   case FCmpInst::FCMP_OLE:   pred = "ole"; break;
1012   case FCmpInst::FCMP_ONE:   pred = "one"; break;
1013   case FCmpInst::FCMP_ORD:   pred = "ord"; break;
1014   case FCmpInst::FCMP_UNO:   pred = "uno"; break;
1015   case FCmpInst::FCMP_UEQ:   pred = "ueq"; break;
1016   case FCmpInst::FCMP_UGT:   pred = "ugt"; break;
1017   case FCmpInst::FCMP_UGE:   pred = "uge"; break;
1018   case FCmpInst::FCMP_ULT:   pred = "ult"; break;
1019   case FCmpInst::FCMP_ULE:   pred = "ule"; break;
1020   case FCmpInst::FCMP_UNE:   pred = "une"; break;
1021   case FCmpInst::FCMP_TRUE:  pred = "true"; break;
1022   case ICmpInst::ICMP_EQ:    pred = "eq"; break;
1023   case ICmpInst::ICMP_NE:    pred = "ne"; break;
1024   case ICmpInst::ICMP_SGT:   pred = "sgt"; break;
1025   case ICmpInst::ICMP_SGE:   pred = "sge"; break;
1026   case ICmpInst::ICMP_SLT:   pred = "slt"; break;
1027   case ICmpInst::ICMP_SLE:   pred = "sle"; break;
1028   case ICmpInst::ICMP_UGT:   pred = "ugt"; break;
1029   case ICmpInst::ICMP_UGE:   pred = "uge"; break;
1030   case ICmpInst::ICMP_ULT:   pred = "ult"; break;
1031   case ICmpInst::ICMP_ULE:   pred = "ule"; break;
1032   }
1033   return pred;
1034 }
1035
1036 static void writeAtomicRMWOperation(raw_ostream &Out,
1037                                     AtomicRMWInst::BinOp Op) {
1038   switch (Op) {
1039   default: Out << " <unknown operation " << Op << ">"; break;
1040   case AtomicRMWInst::Xchg: Out << " xchg"; break;
1041   case AtomicRMWInst::Add:  Out << " add"; break;
1042   case AtomicRMWInst::Sub:  Out << " sub"; break;
1043   case AtomicRMWInst::And:  Out << " and"; break;
1044   case AtomicRMWInst::Nand: Out << " nand"; break;
1045   case AtomicRMWInst::Or:   Out << " or"; break;
1046   case AtomicRMWInst::Xor:  Out << " xor"; break;
1047   case AtomicRMWInst::Max:  Out << " max"; break;
1048   case AtomicRMWInst::Min:  Out << " min"; break;
1049   case AtomicRMWInst::UMax: Out << " umax"; break;
1050   case AtomicRMWInst::UMin: Out << " umin"; break;
1051   }
1052 }
1053
1054 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1055   if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1056     // Unsafe algebra implies all the others, no need to write them all out
1057     if (FPO->hasUnsafeAlgebra())
1058       Out << " fast";
1059     else {
1060       if (FPO->hasNoNaNs())
1061         Out << " nnan";
1062       if (FPO->hasNoInfs())
1063         Out << " ninf";
1064       if (FPO->hasNoSignedZeros())
1065         Out << " nsz";
1066       if (FPO->hasAllowReciprocal())
1067         Out << " arcp";
1068     }
1069   }
1070
1071   if (const OverflowingBinaryOperator *OBO =
1072         dyn_cast<OverflowingBinaryOperator>(U)) {
1073     if (OBO->hasNoUnsignedWrap())
1074       Out << " nuw";
1075     if (OBO->hasNoSignedWrap())
1076       Out << " nsw";
1077   } else if (const PossiblyExactOperator *Div =
1078                dyn_cast<PossiblyExactOperator>(U)) {
1079     if (Div->isExact())
1080       Out << " exact";
1081   } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1082     if (GEP->isInBounds())
1083       Out << " inbounds";
1084   }
1085 }
1086
1087 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1088                                   TypePrinting &TypePrinter,
1089                                   SlotTracker *Machine,
1090                                   const Module *Context) {
1091   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1092     if (CI->getType()->isIntegerTy(1)) {
1093       Out << (CI->getZExtValue() ? "true" : "false");
1094       return;
1095     }
1096     Out << CI->getValue();
1097     return;
1098   }
1099
1100   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1101     if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1102         &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1103       // We would like to output the FP constant value in exponential notation,
1104       // but we cannot do this if doing so will lose precision.  Check here to
1105       // make sure that we only output it in exponential format if we can parse
1106       // the value back and get the same value.
1107       //
1108       bool ignored;
1109       bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1110       bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1111       bool isInf = CFP->getValueAPF().isInfinity();
1112       bool isNaN = CFP->getValueAPF().isNaN();
1113       if (!isHalf && !isInf && !isNaN) {
1114         double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1115                                 CFP->getValueAPF().convertToFloat();
1116         SmallString<128> StrVal;
1117         raw_svector_ostream(StrVal) << Val;
1118
1119         // Check to make sure that the stringized number is not some string like
1120         // "Inf" or NaN, that atof will accept, but the lexer will not.  Check
1121         // that the string matches the "[-+]?[0-9]" regex.
1122         //
1123         if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1124             ((StrVal[0] == '-' || StrVal[0] == '+') &&
1125              (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1126           // Reparse stringized version!
1127           if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1128             Out << StrVal;
1129             return;
1130           }
1131         }
1132       }
1133       // Otherwise we could not reparse it to exactly the same value, so we must
1134       // output the string in hexadecimal format!  Note that loading and storing
1135       // floating point types changes the bits of NaNs on some hosts, notably
1136       // x86, so we must not use these types.
1137       static_assert(sizeof(double) == sizeof(uint64_t),
1138                     "assuming that double is 64 bits!");
1139       char Buffer[40];
1140       APFloat apf = CFP->getValueAPF();
1141       // Halves and floats are represented in ASCII IR as double, convert.
1142       if (!isDouble)
1143         apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1144                           &ignored);
1145       Out << "0x" <<
1146               utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1147                             Buffer+40);
1148       return;
1149     }
1150
1151     // Either half, or some form of long double.
1152     // These appear as a magic letter identifying the type, then a
1153     // fixed number of hex digits.
1154     Out << "0x";
1155     // Bit position, in the current word, of the next nibble to print.
1156     int shiftcount;
1157
1158     if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1159       Out << 'K';
1160       // api needed to prevent premature destruction
1161       APInt api = CFP->getValueAPF().bitcastToAPInt();
1162       const uint64_t* p = api.getRawData();
1163       uint64_t word = p[1];
1164       shiftcount = 12;
1165       int width = api.getBitWidth();
1166       for (int j=0; j<width; j+=4, shiftcount-=4) {
1167         unsigned int nibble = (word>>shiftcount) & 15;
1168         if (nibble < 10)
1169           Out << (unsigned char)(nibble + '0');
1170         else
1171           Out << (unsigned char)(nibble - 10 + 'A');
1172         if (shiftcount == 0 && j+4 < width) {
1173           word = *p;
1174           shiftcount = 64;
1175           if (width-j-4 < 64)
1176             shiftcount = width-j-4;
1177         }
1178       }
1179       return;
1180     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1181       shiftcount = 60;
1182       Out << 'L';
1183     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1184       shiftcount = 60;
1185       Out << 'M';
1186     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1187       shiftcount = 12;
1188       Out << 'H';
1189     } else
1190       llvm_unreachable("Unsupported floating point type");
1191     // api needed to prevent premature destruction
1192     APInt api = CFP->getValueAPF().bitcastToAPInt();
1193     const uint64_t* p = api.getRawData();
1194     uint64_t word = *p;
1195     int width = api.getBitWidth();
1196     for (int j=0; j<width; j+=4, shiftcount-=4) {
1197       unsigned int nibble = (word>>shiftcount) & 15;
1198       if (nibble < 10)
1199         Out << (unsigned char)(nibble + '0');
1200       else
1201         Out << (unsigned char)(nibble - 10 + 'A');
1202       if (shiftcount == 0 && j+4 < width) {
1203         word = *(++p);
1204         shiftcount = 64;
1205         if (width-j-4 < 64)
1206           shiftcount = width-j-4;
1207       }
1208     }
1209     return;
1210   }
1211
1212   if (isa<ConstantAggregateZero>(CV)) {
1213     Out << "zeroinitializer";
1214     return;
1215   }
1216
1217   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1218     Out << "blockaddress(";
1219     WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1220                            Context);
1221     Out << ", ";
1222     WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1223                            Context);
1224     Out << ")";
1225     return;
1226   }
1227
1228   if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1229     Type *ETy = CA->getType()->getElementType();
1230     Out << '[';
1231     TypePrinter.print(ETy, Out);
1232     Out << ' ';
1233     WriteAsOperandInternal(Out, CA->getOperand(0),
1234                            &TypePrinter, Machine,
1235                            Context);
1236     for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1237       Out << ", ";
1238       TypePrinter.print(ETy, Out);
1239       Out << ' ';
1240       WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1241                              Context);
1242     }
1243     Out << ']';
1244     return;
1245   }
1246
1247   if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1248     // As a special case, print the array as a string if it is an array of
1249     // i8 with ConstantInt values.
1250     if (CA->isString()) {
1251       Out << "c\"";
1252       PrintEscapedString(CA->getAsString(), Out);
1253       Out << '"';
1254       return;
1255     }
1256
1257     Type *ETy = CA->getType()->getElementType();
1258     Out << '[';
1259     TypePrinter.print(ETy, Out);
1260     Out << ' ';
1261     WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1262                            &TypePrinter, Machine,
1263                            Context);
1264     for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1265       Out << ", ";
1266       TypePrinter.print(ETy, Out);
1267       Out << ' ';
1268       WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1269                              Machine, Context);
1270     }
1271     Out << ']';
1272     return;
1273   }
1274
1275
1276   if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1277     if (CS->getType()->isPacked())
1278       Out << '<';
1279     Out << '{';
1280     unsigned N = CS->getNumOperands();
1281     if (N) {
1282       Out << ' ';
1283       TypePrinter.print(CS->getOperand(0)->getType(), Out);
1284       Out << ' ';
1285
1286       WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1287                              Context);
1288
1289       for (unsigned i = 1; i < N; i++) {
1290         Out << ", ";
1291         TypePrinter.print(CS->getOperand(i)->getType(), Out);
1292         Out << ' ';
1293
1294         WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1295                                Context);
1296       }
1297       Out << ' ';
1298     }
1299
1300     Out << '}';
1301     if (CS->getType()->isPacked())
1302       Out << '>';
1303     return;
1304   }
1305
1306   if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1307     Type *ETy = CV->getType()->getVectorElementType();
1308     Out << '<';
1309     TypePrinter.print(ETy, Out);
1310     Out << ' ';
1311     WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1312                            Machine, Context);
1313     for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1314       Out << ", ";
1315       TypePrinter.print(ETy, Out);
1316       Out << ' ';
1317       WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1318                              Machine, Context);
1319     }
1320     Out << '>';
1321     return;
1322   }
1323
1324   if (isa<ConstantPointerNull>(CV)) {
1325     Out << "null";
1326     return;
1327   }
1328
1329   if (isa<UndefValue>(CV)) {
1330     Out << "undef";
1331     return;
1332   }
1333
1334   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1335     Out << CE->getOpcodeName();
1336     WriteOptimizationInfo(Out, CE);
1337     if (CE->isCompare())
1338       Out << ' ' << getPredicateText(CE->getPredicate());
1339     Out << " (";
1340
1341     if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1342       TypePrinter.print(GEP->getSourceElementType(), Out);
1343       Out << ", ";
1344     }
1345
1346     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1347       TypePrinter.print((*OI)->getType(), Out);
1348       Out << ' ';
1349       WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1350       if (OI+1 != CE->op_end())
1351         Out << ", ";
1352     }
1353
1354     if (CE->hasIndices()) {
1355       ArrayRef<unsigned> Indices = CE->getIndices();
1356       for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1357         Out << ", " << Indices[i];
1358     }
1359
1360     if (CE->isCast()) {
1361       Out << " to ";
1362       TypePrinter.print(CE->getType(), Out);
1363     }
1364
1365     Out << ')';
1366     return;
1367   }
1368
1369   Out << "<placeholder or erroneous Constant>";
1370 }
1371
1372 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1373                          TypePrinting *TypePrinter, SlotTracker *Machine,
1374                          const Module *Context) {
1375   Out << "!{";
1376   for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1377     const Metadata *MD = Node->getOperand(mi);
1378     if (!MD)
1379       Out << "null";
1380     else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1381       Value *V = MDV->getValue();
1382       TypePrinter->print(V->getType(), Out);
1383       Out << ' ';
1384       WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1385     } else {
1386       WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1387     }
1388     if (mi + 1 != me)
1389       Out << ", ";
1390   }
1391
1392   Out << "}";
1393 }
1394
1395 namespace {
1396 struct FieldSeparator {
1397   bool Skip;
1398   const char *Sep;
1399   FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1400 };
1401 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1402   if (FS.Skip) {
1403     FS.Skip = false;
1404     return OS;
1405   }
1406   return OS << FS.Sep;
1407 }
1408 struct MDFieldPrinter {
1409   raw_ostream &Out;
1410   FieldSeparator FS;
1411   TypePrinting *TypePrinter;
1412   SlotTracker *Machine;
1413   const Module *Context;
1414
1415   explicit MDFieldPrinter(raw_ostream &Out)
1416       : Out(Out), TypePrinter(nullptr), Machine(nullptr), Context(nullptr) {}
1417   MDFieldPrinter(raw_ostream &Out, TypePrinting *TypePrinter,
1418                  SlotTracker *Machine, const Module *Context)
1419       : Out(Out), TypePrinter(TypePrinter), Machine(Machine), Context(Context) {
1420   }
1421   void printTag(const DINode *N);
1422   void printString(StringRef Name, StringRef Value,
1423                    bool ShouldSkipEmpty = true);
1424   void printMetadata(StringRef Name, const Metadata *MD,
1425                      bool ShouldSkipNull = true);
1426   template <class IntTy>
1427   void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1428   void printBool(StringRef Name, bool Value);
1429   void printDIFlags(StringRef Name, unsigned Flags);
1430   template <class IntTy, class Stringifier>
1431   void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1432                       bool ShouldSkipZero = true);
1433 };
1434 } // end namespace
1435
1436 void MDFieldPrinter::printTag(const DINode *N) {
1437   Out << FS << "tag: ";
1438   if (const char *Tag = dwarf::TagString(N->getTag()))
1439     Out << Tag;
1440   else
1441     Out << N->getTag();
1442 }
1443
1444 void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1445                                  bool ShouldSkipEmpty) {
1446   if (ShouldSkipEmpty && Value.empty())
1447     return;
1448
1449   Out << FS << Name << ": \"";
1450   PrintEscapedString(Value, Out);
1451   Out << "\"";
1452 }
1453
1454 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1455                                    TypePrinting *TypePrinter,
1456                                    SlotTracker *Machine,
1457                                    const Module *Context) {
1458   if (!MD) {
1459     Out << "null";
1460     return;
1461   }
1462   WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1463 }
1464
1465 void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1466                                    bool ShouldSkipNull) {
1467   if (ShouldSkipNull && !MD)
1468     return;
1469
1470   Out << FS << Name << ": ";
1471   writeMetadataAsOperand(Out, MD, TypePrinter, Machine, Context);
1472 }
1473
1474 template <class IntTy>
1475 void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1476   if (ShouldSkipZero && !Int)
1477     return;
1478
1479   Out << FS << Name << ": " << Int;
1480 }
1481
1482 void MDFieldPrinter::printBool(StringRef Name, bool Value) {
1483   Out << FS << Name << ": " << (Value ? "true" : "false");
1484 }
1485
1486 void MDFieldPrinter::printDIFlags(StringRef Name, unsigned Flags) {
1487   if (!Flags)
1488     return;
1489
1490   Out << FS << Name << ": ";
1491
1492   SmallVector<unsigned, 8> SplitFlags;
1493   unsigned Extra = DINode::splitFlags(Flags, SplitFlags);
1494
1495   FieldSeparator FlagsFS(" | ");
1496   for (unsigned F : SplitFlags) {
1497     const char *StringF = DINode::getFlagString(F);
1498     assert(StringF && "Expected valid flag");
1499     Out << FlagsFS << StringF;
1500   }
1501   if (Extra || SplitFlags.empty())
1502     Out << FlagsFS << Extra;
1503 }
1504
1505 template <class IntTy, class Stringifier>
1506 void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
1507                                     Stringifier toString, bool ShouldSkipZero) {
1508   if (!Value)
1509     return;
1510
1511   Out << FS << Name << ": ";
1512   if (const char *S = toString(Value))
1513     Out << S;
1514   else
1515     Out << Value;
1516 }
1517
1518 static void writeGenericDINode(raw_ostream &Out, const GenericDINode *N,
1519                                TypePrinting *TypePrinter, SlotTracker *Machine,
1520                                const Module *Context) {
1521   Out << "!GenericDINode(";
1522   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1523   Printer.printTag(N);
1524   Printer.printString("header", N->getHeader());
1525   if (N->getNumDwarfOperands()) {
1526     Out << Printer.FS << "operands: {";
1527     FieldSeparator IFS;
1528     for (auto &I : N->dwarf_operands()) {
1529       Out << IFS;
1530       writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1531     }
1532     Out << "}";
1533   }
1534   Out << ")";
1535 }
1536
1537 static void writeDILocation(raw_ostream &Out, const DILocation *DL,
1538                             TypePrinting *TypePrinter, SlotTracker *Machine,
1539                             const Module *Context) {
1540   Out << "!DILocation(";
1541   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1542   // Always output the line, since 0 is a relevant and important value for it.
1543   Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
1544   Printer.printInt("column", DL->getColumn());
1545   Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
1546   Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
1547   Out << ")";
1548 }
1549
1550 static void writeDISubrange(raw_ostream &Out, const DISubrange *N,
1551                             TypePrinting *, SlotTracker *, const Module *) {
1552   Out << "!DISubrange(";
1553   MDFieldPrinter Printer(Out);
1554   Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1555   Printer.printInt("lowerBound", N->getLowerBound());
1556   Out << ")";
1557 }
1558
1559 static void writeDIEnumerator(raw_ostream &Out, const DIEnumerator *N,
1560                               TypePrinting *, SlotTracker *, const Module *) {
1561   Out << "!DIEnumerator(";
1562   MDFieldPrinter Printer(Out);
1563   Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
1564   Printer.printInt("value", N->getValue(), /* ShouldSkipZero */ false);
1565   Out << ")";
1566 }
1567
1568 static void writeDIBasicType(raw_ostream &Out, const DIBasicType *N,
1569                              TypePrinting *, SlotTracker *, const Module *) {
1570   Out << "!DIBasicType(";
1571   MDFieldPrinter Printer(Out);
1572   if (N->getTag() != dwarf::DW_TAG_base_type)
1573     Printer.printTag(N);
1574   Printer.printString("name", N->getName());
1575   Printer.printInt("size", N->getSizeInBits());
1576   Printer.printInt("align", N->getAlignInBits());
1577   Printer.printDwarfEnum("encoding", N->getEncoding(),
1578                          dwarf::AttributeEncodingString);
1579   Out << ")";
1580 }
1581
1582 static void writeDIDerivedType(raw_ostream &Out, const DIDerivedType *N,
1583                                TypePrinting *TypePrinter, SlotTracker *Machine,
1584                                const Module *Context) {
1585   Out << "!DIDerivedType(";
1586   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1587   Printer.printTag(N);
1588   Printer.printString("name", N->getName());
1589   Printer.printMetadata("scope", N->getRawScope());
1590   Printer.printMetadata("file", N->getRawFile());
1591   Printer.printInt("line", N->getLine());
1592   Printer.printMetadata("baseType", N->getRawBaseType(),
1593                         /* ShouldSkipNull */ false);
1594   Printer.printInt("size", N->getSizeInBits());
1595   Printer.printInt("align", N->getAlignInBits());
1596   Printer.printInt("offset", N->getOffsetInBits());
1597   Printer.printDIFlags("flags", N->getFlags());
1598   Printer.printMetadata("extraData", N->getRawExtraData());
1599   Out << ")";
1600 }
1601
1602 static void writeDICompositeType(raw_ostream &Out, const DICompositeType *N,
1603                                  TypePrinting *TypePrinter,
1604                                  SlotTracker *Machine, const Module *Context) {
1605   Out << "!DICompositeType(";
1606   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1607   Printer.printTag(N);
1608   Printer.printString("name", N->getName());
1609   Printer.printMetadata("scope", N->getRawScope());
1610   Printer.printMetadata("file", N->getRawFile());
1611   Printer.printInt("line", N->getLine());
1612   Printer.printMetadata("baseType", N->getRawBaseType());
1613   Printer.printInt("size", N->getSizeInBits());
1614   Printer.printInt("align", N->getAlignInBits());
1615   Printer.printInt("offset", N->getOffsetInBits());
1616   Printer.printDIFlags("flags", N->getFlags());
1617   Printer.printMetadata("elements", N->getRawElements());
1618   Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
1619                          dwarf::LanguageString);
1620   Printer.printMetadata("vtableHolder", N->getRawVTableHolder());
1621   Printer.printMetadata("templateParams", N->getRawTemplateParams());
1622   Printer.printString("identifier", N->getIdentifier());
1623   Out << ")";
1624 }
1625
1626 static void writeDISubroutineType(raw_ostream &Out, const DISubroutineType *N,
1627                                   TypePrinting *TypePrinter,
1628                                   SlotTracker *Machine, const Module *Context) {
1629   Out << "!DISubroutineType(";
1630   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1631   Printer.printDIFlags("flags", N->getFlags());
1632   Printer.printMetadata("types", N->getRawTypeArray(),
1633                         /* ShouldSkipNull */ false);
1634   Out << ")";
1635 }
1636
1637 static void writeDIFile(raw_ostream &Out, const DIFile *N, TypePrinting *,
1638                         SlotTracker *, const Module *) {
1639   Out << "!DIFile(";
1640   MDFieldPrinter Printer(Out);
1641   Printer.printString("filename", N->getFilename(),
1642                       /* ShouldSkipEmpty */ false);
1643   Printer.printString("directory", N->getDirectory(),
1644                       /* ShouldSkipEmpty */ false);
1645   Out << ")";
1646 }
1647
1648 static void writeDICompileUnit(raw_ostream &Out, const DICompileUnit *N,
1649                                TypePrinting *TypePrinter, SlotTracker *Machine,
1650                                const Module *Context) {
1651   Out << "!DICompileUnit(";
1652   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1653   Printer.printDwarfEnum("language", N->getSourceLanguage(),
1654                          dwarf::LanguageString, /* ShouldSkipZero */ false);
1655   Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
1656   Printer.printString("producer", N->getProducer());
1657   Printer.printBool("isOptimized", N->isOptimized());
1658   Printer.printString("flags", N->getFlags());
1659   Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
1660                    /* ShouldSkipZero */ false);
1661   Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
1662   Printer.printInt("emissionKind", N->getEmissionKind(),
1663                    /* ShouldSkipZero */ false);
1664   Printer.printMetadata("enums", N->getRawEnumTypes());
1665   Printer.printMetadata("retainedTypes", N->getRawRetainedTypes());
1666   Printer.printMetadata("subprograms", N->getRawSubprograms());
1667   Printer.printMetadata("globals", N->getRawGlobalVariables());
1668   Printer.printMetadata("imports", N->getRawImportedEntities());
1669   Printer.printInt("dwoId", N->getDWOId());
1670   Out << ")";
1671 }
1672
1673 static void writeDISubprogram(raw_ostream &Out, const DISubprogram *N,
1674                               TypePrinting *TypePrinter, SlotTracker *Machine,
1675                               const Module *Context) {
1676   Out << "!DISubprogram(";
1677   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1678   Printer.printString("name", N->getName());
1679   Printer.printString("linkageName", N->getLinkageName());
1680   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1681   Printer.printMetadata("file", N->getRawFile());
1682   Printer.printInt("line", N->getLine());
1683   Printer.printMetadata("type", N->getRawType());
1684   Printer.printBool("isLocal", N->isLocalToUnit());
1685   Printer.printBool("isDefinition", N->isDefinition());
1686   Printer.printInt("scopeLine", N->getScopeLine());
1687   Printer.printMetadata("containingType", N->getRawContainingType());
1688   Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1689                          dwarf::VirtualityString);
1690   Printer.printInt("virtualIndex", N->getVirtualIndex());
1691   Printer.printDIFlags("flags", N->getFlags());
1692   Printer.printBool("isOptimized", N->isOptimized());
1693   Printer.printMetadata("function", N->getRawFunction());
1694   Printer.printMetadata("templateParams", N->getRawTemplateParams());
1695   Printer.printMetadata("declaration", N->getRawDeclaration());
1696   Printer.printMetadata("variables", N->getRawVariables());
1697   Out << ")";
1698 }
1699
1700 static void writeDILexicalBlock(raw_ostream &Out, const DILexicalBlock *N,
1701                                 TypePrinting *TypePrinter, SlotTracker *Machine,
1702                                 const Module *Context) {
1703   Out << "!DILexicalBlock(";
1704   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1705   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1706   Printer.printMetadata("file", N->getRawFile());
1707   Printer.printInt("line", N->getLine());
1708   Printer.printInt("column", N->getColumn());
1709   Out << ")";
1710 }
1711
1712 static void writeDILexicalBlockFile(raw_ostream &Out,
1713                                     const DILexicalBlockFile *N,
1714                                     TypePrinting *TypePrinter,
1715                                     SlotTracker *Machine,
1716                                     const Module *Context) {
1717   Out << "!DILexicalBlockFile(";
1718   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1719   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1720   Printer.printMetadata("file", N->getRawFile());
1721   Printer.printInt("discriminator", N->getDiscriminator(),
1722                    /* ShouldSkipZero */ false);
1723   Out << ")";
1724 }
1725
1726 static void writeDINamespace(raw_ostream &Out, const DINamespace *N,
1727                              TypePrinting *TypePrinter, SlotTracker *Machine,
1728                              const Module *Context) {
1729   Out << "!DINamespace(";
1730   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1731   Printer.printString("name", N->getName());
1732   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1733   Printer.printMetadata("file", N->getRawFile());
1734   Printer.printInt("line", N->getLine());
1735   Out << ")";
1736 }
1737
1738 static void writeDIModule(raw_ostream &Out, const DIModule *N,
1739                           TypePrinting *TypePrinter, SlotTracker *Machine,
1740                           const Module *Context) {
1741   Out << "!DIModule(";
1742   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1743   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1744   Printer.printString("name", N->getName());
1745   Printer.printString("configMacros", N->getConfigurationMacros());
1746   Printer.printString("includePath", N->getIncludePath());
1747   Printer.printString("isysroot", N->getISysRoot());
1748   Out << ")";
1749 }
1750
1751
1752 static void writeDITemplateTypeParameter(raw_ostream &Out,
1753                                          const DITemplateTypeParameter *N,
1754                                          TypePrinting *TypePrinter,
1755                                          SlotTracker *Machine,
1756                                          const Module *Context) {
1757   Out << "!DITemplateTypeParameter(";
1758   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1759   Printer.printString("name", N->getName());
1760   Printer.printMetadata("type", N->getRawType(), /* ShouldSkipNull */ false);
1761   Out << ")";
1762 }
1763
1764 static void writeDITemplateValueParameter(raw_ostream &Out,
1765                                           const DITemplateValueParameter *N,
1766                                           TypePrinting *TypePrinter,
1767                                           SlotTracker *Machine,
1768                                           const Module *Context) {
1769   Out << "!DITemplateValueParameter(";
1770   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1771   if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1772     Printer.printTag(N);
1773   Printer.printString("name", N->getName());
1774   Printer.printMetadata("type", N->getRawType());
1775   Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1776   Out << ")";
1777 }
1778
1779 static void writeDIGlobalVariable(raw_ostream &Out, const DIGlobalVariable *N,
1780                                   TypePrinting *TypePrinter,
1781                                   SlotTracker *Machine, const Module *Context) {
1782   Out << "!DIGlobalVariable(";
1783   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1784   Printer.printString("name", N->getName());
1785   Printer.printString("linkageName", N->getLinkageName());
1786   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1787   Printer.printMetadata("file", N->getRawFile());
1788   Printer.printInt("line", N->getLine());
1789   Printer.printMetadata("type", N->getRawType());
1790   Printer.printBool("isLocal", N->isLocalToUnit());
1791   Printer.printBool("isDefinition", N->isDefinition());
1792   Printer.printMetadata("variable", N->getRawVariable());
1793   Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
1794   Out << ")";
1795 }
1796
1797 static void writeDILocalVariable(raw_ostream &Out, const DILocalVariable *N,
1798                                  TypePrinting *TypePrinter,
1799                                  SlotTracker *Machine, const Module *Context) {
1800   Out << "!DILocalVariable(";
1801   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1802   Printer.printString("name", N->getName());
1803   Printer.printInt("arg", N->getArg());
1804   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1805   Printer.printMetadata("file", N->getRawFile());
1806   Printer.printInt("line", N->getLine());
1807   Printer.printMetadata("type", N->getRawType());
1808   Printer.printDIFlags("flags", N->getFlags());
1809   Out << ")";
1810 }
1811
1812 static void writeDIExpression(raw_ostream &Out, const DIExpression *N,
1813                               TypePrinting *TypePrinter, SlotTracker *Machine,
1814                               const Module *Context) {
1815   Out << "!DIExpression(";
1816   FieldSeparator FS;
1817   if (N->isValid()) {
1818     for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1819       const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1820       assert(OpStr && "Expected valid opcode");
1821
1822       Out << FS << OpStr;
1823       for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1824         Out << FS << I->getArg(A);
1825     }
1826   } else {
1827     for (const auto &I : N->getElements())
1828       Out << FS << I;
1829   }
1830   Out << ")";
1831 }
1832
1833 static void writeDIObjCProperty(raw_ostream &Out, const DIObjCProperty *N,
1834                                 TypePrinting *TypePrinter, SlotTracker *Machine,
1835                                 const Module *Context) {
1836   Out << "!DIObjCProperty(";
1837   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1838   Printer.printString("name", N->getName());
1839   Printer.printMetadata("file", N->getRawFile());
1840   Printer.printInt("line", N->getLine());
1841   Printer.printString("setter", N->getSetterName());
1842   Printer.printString("getter", N->getGetterName());
1843   Printer.printInt("attributes", N->getAttributes());
1844   Printer.printMetadata("type", N->getRawType());
1845   Out << ")";
1846 }
1847
1848 static void writeDIImportedEntity(raw_ostream &Out, const DIImportedEntity *N,
1849                                   TypePrinting *TypePrinter,
1850                                   SlotTracker *Machine, const Module *Context) {
1851   Out << "!DIImportedEntity(";
1852   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1853   Printer.printTag(N);
1854   Printer.printString("name", N->getName());
1855   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1856   Printer.printMetadata("entity", N->getRawEntity());
1857   Printer.printInt("line", N->getLine());
1858   Out << ")";
1859 }
1860
1861
1862 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1863                                     TypePrinting *TypePrinter,
1864                                     SlotTracker *Machine,
1865                                     const Module *Context) {
1866   if (Node->isDistinct())
1867     Out << "distinct ";
1868   else if (Node->isTemporary())
1869     Out << "<temporary!> "; // Handle broken code.
1870
1871   switch (Node->getMetadataID()) {
1872   default:
1873     llvm_unreachable("Expected uniquable MDNode");
1874 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
1875   case Metadata::CLASS##Kind:                                                  \
1876     write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context);       \
1877     break;
1878 #include "llvm/IR/Metadata.def"
1879   }
1880 }
1881
1882 // Full implementation of printing a Value as an operand with support for
1883 // TypePrinting, etc.
1884 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1885                                    TypePrinting *TypePrinter,
1886                                    SlotTracker *Machine,
1887                                    const Module *Context) {
1888   if (V->hasName()) {
1889     PrintLLVMName(Out, V);
1890     return;
1891   }
1892
1893   const Constant *CV = dyn_cast<Constant>(V);
1894   if (CV && !isa<GlobalValue>(CV)) {
1895     assert(TypePrinter && "Constants require TypePrinting!");
1896     WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1897     return;
1898   }
1899
1900   if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1901     Out << "asm ";
1902     if (IA->hasSideEffects())
1903       Out << "sideeffect ";
1904     if (IA->isAlignStack())
1905       Out << "alignstack ";
1906     // We don't emit the AD_ATT dialect as it's the assumed default.
1907     if (IA->getDialect() == InlineAsm::AD_Intel)
1908       Out << "inteldialect ";
1909     Out << '"';
1910     PrintEscapedString(IA->getAsmString(), Out);
1911     Out << "\", \"";
1912     PrintEscapedString(IA->getConstraintString(), Out);
1913     Out << '"';
1914     return;
1915   }
1916
1917   if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1918     WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1919                            Context, /* FromValue */ true);
1920     return;
1921   }
1922
1923   char Prefix = '%';
1924   int Slot;
1925   // If we have a SlotTracker, use it.
1926   if (Machine) {
1927     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1928       Slot = Machine->getGlobalSlot(GV);
1929       Prefix = '@';
1930     } else {
1931       Slot = Machine->getLocalSlot(V);
1932
1933       // If the local value didn't succeed, then we may be referring to a value
1934       // from a different function.  Translate it, as this can happen when using
1935       // address of blocks.
1936       if (Slot == -1)
1937         if ((Machine = createSlotTracker(V))) {
1938           Slot = Machine->getLocalSlot(V);
1939           delete Machine;
1940         }
1941     }
1942   } else if ((Machine = createSlotTracker(V))) {
1943     // Otherwise, create one to get the # and then destroy it.
1944     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1945       Slot = Machine->getGlobalSlot(GV);
1946       Prefix = '@';
1947     } else {
1948       Slot = Machine->getLocalSlot(V);
1949     }
1950     delete Machine;
1951     Machine = nullptr;
1952   } else {
1953     Slot = -1;
1954   }
1955
1956   if (Slot != -1)
1957     Out << Prefix << Slot;
1958   else
1959     Out << "<badref>";
1960 }
1961
1962 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1963                                    TypePrinting *TypePrinter,
1964                                    SlotTracker *Machine, const Module *Context,
1965                                    bool FromValue) {
1966   if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1967     std::unique_ptr<SlotTracker> MachineStorage;
1968     if (!Machine) {
1969       MachineStorage = make_unique<SlotTracker>(Context);
1970       Machine = MachineStorage.get();
1971     }
1972     int Slot = Machine->getMetadataSlot(N);
1973     if (Slot == -1)
1974       // Give the pointer value instead of "badref", since this comes up all
1975       // the time when debugging.
1976       Out << "<" << N << ">";
1977     else
1978       Out << '!' << Slot;
1979     return;
1980   }
1981
1982   if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1983     Out << "!\"";
1984     PrintEscapedString(MDS->getString(), Out);
1985     Out << '"';
1986     return;
1987   }
1988
1989   auto *V = cast<ValueAsMetadata>(MD);
1990   assert(TypePrinter && "TypePrinter required for metadata values");
1991   assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1992          "Unexpected function-local metadata outside of value argument");
1993
1994   TypePrinter->print(V->getValue()->getType(), Out);
1995   Out << ' ';
1996   WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1997 }
1998
1999 namespace {
2000 class AssemblyWriter {
2001   formatted_raw_ostream &Out;
2002   const Module *TheModule;
2003   std::unique_ptr<SlotTracker> SlotTrackerStorage;
2004   SlotTracker &Machine;
2005   TypePrinting TypePrinter;
2006   AssemblyAnnotationWriter *AnnotationWriter;
2007   SetVector<const Comdat *> Comdats;
2008   bool ShouldPreserveUseListOrder;
2009   UseListOrderStack UseListOrders;
2010   SmallVector<StringRef, 8> MDNames;
2011
2012 public:
2013   /// Construct an AssemblyWriter with an external SlotTracker
2014   AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
2015                  AssemblyAnnotationWriter *AAW,
2016                  bool ShouldPreserveUseListOrder = false);
2017
2018   void printMDNodeBody(const MDNode *MD);
2019   void printNamedMDNode(const NamedMDNode *NMD);
2020
2021   void printModule(const Module *M);
2022
2023   void writeOperand(const Value *Op, bool PrintType);
2024   void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
2025   void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
2026   void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2027                           AtomicOrdering FailureOrdering,
2028                           SynchronizationScope SynchScope);
2029
2030   void writeAllMDNodes();
2031   void writeMDNode(unsigned Slot, const MDNode *Node);
2032   void writeAllAttributeGroups();
2033
2034   void printTypeIdentities();
2035   void printGlobal(const GlobalVariable *GV);
2036   void printAlias(const GlobalAlias *GV);
2037   void printComdat(const Comdat *C);
2038   void printFunction(const Function *F);
2039   void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
2040   void printBasicBlock(const BasicBlock *BB);
2041   void printInstructionLine(const Instruction &I);
2042   void printInstruction(const Instruction &I);
2043
2044   void printUseListOrder(const UseListOrder &Order);
2045   void printUseLists(const Function *F);
2046
2047 private:
2048   /// \brief Print out metadata attachments.
2049   void printMetadataAttachments(
2050       const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2051       StringRef Separator);
2052
2053   // printInfoComment - Print a little comment after the instruction indicating
2054   // which slot it occupies.
2055   void printInfoComment(const Value &V);
2056
2057   // printGCRelocateComment - print comment after call to the gc.relocate
2058   // intrinsic indicating base and derived pointer names.
2059   void printGCRelocateComment(const Value &V);
2060 };
2061 } // namespace
2062
2063 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2064                                const Module *M, AssemblyAnnotationWriter *AAW,
2065                                bool ShouldPreserveUseListOrder)
2066     : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW),
2067       ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2068   if (!TheModule)
2069     return;
2070   TypePrinter.incorporateTypes(*TheModule);
2071   for (const Function &F : *TheModule)
2072     if (const Comdat *C = F.getComdat())
2073       Comdats.insert(C);
2074   for (const GlobalVariable &GV : TheModule->globals())
2075     if (const Comdat *C = GV.getComdat())
2076       Comdats.insert(C);
2077 }
2078
2079 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2080   if (!Operand) {
2081     Out << "<null operand!>";
2082     return;
2083   }
2084   if (PrintType) {
2085     TypePrinter.print(Operand->getType(), Out);
2086     Out << ' ';
2087   }
2088   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2089 }
2090
2091 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2092                                  SynchronizationScope SynchScope) {
2093   if (Ordering == NotAtomic)
2094     return;
2095
2096   switch (SynchScope) {
2097   case SingleThread: Out << " singlethread"; break;
2098   case CrossThread: break;
2099   }
2100
2101   switch (Ordering) {
2102   default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2103   case Unordered: Out << " unordered"; break;
2104   case Monotonic: Out << " monotonic"; break;
2105   case Acquire: Out << " acquire"; break;
2106   case Release: Out << " release"; break;
2107   case AcquireRelease: Out << " acq_rel"; break;
2108   case SequentiallyConsistent: Out << " seq_cst"; break;
2109   }
2110 }
2111
2112 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2113                                         AtomicOrdering FailureOrdering,
2114                                         SynchronizationScope SynchScope) {
2115   assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2116
2117   switch (SynchScope) {
2118   case SingleThread: Out << " singlethread"; break;
2119   case CrossThread: break;
2120   }
2121
2122   switch (SuccessOrdering) {
2123   default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2124   case Unordered: Out << " unordered"; break;
2125   case Monotonic: Out << " monotonic"; break;
2126   case Acquire: Out << " acquire"; break;
2127   case Release: Out << " release"; break;
2128   case AcquireRelease: Out << " acq_rel"; break;
2129   case SequentiallyConsistent: Out << " seq_cst"; break;
2130   }
2131
2132   switch (FailureOrdering) {
2133   default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2134   case Unordered: Out << " unordered"; break;
2135   case Monotonic: Out << " monotonic"; break;
2136   case Acquire: Out << " acquire"; break;
2137   case Release: Out << " release"; break;
2138   case AcquireRelease: Out << " acq_rel"; break;
2139   case SequentiallyConsistent: Out << " seq_cst"; break;
2140   }
2141 }
2142
2143 void AssemblyWriter::writeParamOperand(const Value *Operand,
2144                                        AttributeSet Attrs, unsigned Idx) {
2145   if (!Operand) {
2146     Out << "<null operand!>";
2147     return;
2148   }
2149
2150   // Print the type
2151   TypePrinter.print(Operand->getType(), Out);
2152   // Print parameter attributes list
2153   if (Attrs.hasAttributes(Idx))
2154     Out << ' ' << Attrs.getAsString(Idx);
2155   Out << ' ';
2156   // Print the operand
2157   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2158 }
2159
2160 void AssemblyWriter::printModule(const Module *M) {
2161   Machine.initialize();
2162
2163   if (ShouldPreserveUseListOrder)
2164     UseListOrders = predictUseListOrder(M);
2165
2166   if (!M->getModuleIdentifier().empty() &&
2167       // Don't print the ID if it will start a new line (which would
2168       // require a comment char before it).
2169       M->getModuleIdentifier().find('\n') == std::string::npos)
2170     Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2171
2172   const std::string &DL = M->getDataLayoutStr();
2173   if (!DL.empty())
2174     Out << "target datalayout = \"" << DL << "\"\n";
2175   if (!M->getTargetTriple().empty())
2176     Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2177
2178   if (!M->getModuleInlineAsm().empty()) {
2179     Out << '\n';
2180
2181     // Split the string into lines, to make it easier to read the .ll file.
2182     StringRef Asm = M->getModuleInlineAsm();
2183     do {
2184       StringRef Front;
2185       std::tie(Front, Asm) = Asm.split('\n');
2186
2187       // We found a newline, print the portion of the asm string from the
2188       // last newline up to this newline.
2189       Out << "module asm \"";
2190       PrintEscapedString(Front, Out);
2191       Out << "\"\n";
2192     } while (!Asm.empty());
2193   }
2194
2195   printTypeIdentities();
2196
2197   // Output all comdats.
2198   if (!Comdats.empty())
2199     Out << '\n';
2200   for (const Comdat *C : Comdats) {
2201     printComdat(C);
2202     if (C != Comdats.back())
2203       Out << '\n';
2204   }
2205
2206   // Output all globals.
2207   if (!M->global_empty()) Out << '\n';
2208   for (const GlobalVariable &GV : M->globals()) {
2209     printGlobal(&GV); Out << '\n';
2210   }
2211
2212   // Output all aliases.
2213   if (!M->alias_empty()) Out << "\n";
2214   for (const GlobalAlias &GA : M->aliases())
2215     printAlias(&GA);
2216
2217   // Output global use-lists.
2218   printUseLists(nullptr);
2219
2220   // Output all of the functions.
2221   for (const Function &F : *M)
2222     printFunction(&F);
2223   assert(UseListOrders.empty() && "All use-lists should have been consumed");
2224
2225   // Output all attribute groups.
2226   if (!Machine.as_empty()) {
2227     Out << '\n';
2228     writeAllAttributeGroups();
2229   }
2230
2231   // Output named metadata.
2232   if (!M->named_metadata_empty()) Out << '\n';
2233
2234   for (const NamedMDNode &Node : M->named_metadata())
2235     printNamedMDNode(&Node);
2236
2237   // Output metadata.
2238   if (!Machine.mdn_empty()) {
2239     Out << '\n';
2240     writeAllMDNodes();
2241   }
2242 }
2243
2244 static void printMetadataIdentifier(StringRef Name,
2245                                     formatted_raw_ostream &Out) {
2246   if (Name.empty()) {
2247     Out << "<empty name> ";
2248   } else {
2249     if (isalpha(static_cast<unsigned char>(Name[0])) || Name[0] == '-' ||
2250         Name[0] == '$' || Name[0] == '.' || Name[0] == '_')
2251       Out << Name[0];
2252     else
2253       Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2254     for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2255       unsigned char C = Name[i];
2256       if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2257           C == '.' || C == '_')
2258         Out << C;
2259       else
2260         Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2261     }
2262   }
2263 }
2264
2265 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2266   Out << '!';
2267   printMetadataIdentifier(NMD->getName(), Out);
2268   Out << " = !{";
2269   for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2270     if (i)
2271       Out << ", ";
2272     int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2273     if (Slot == -1)
2274       Out << "<badref>";
2275     else
2276       Out << '!' << Slot;
2277   }
2278   Out << "}\n";
2279 }
2280
2281 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2282                          formatted_raw_ostream &Out) {
2283   switch (LT) {
2284   case GlobalValue::ExternalLinkage: break;
2285   case GlobalValue::PrivateLinkage:       Out << "private ";        break;
2286   case GlobalValue::InternalLinkage:      Out << "internal ";       break;
2287   case GlobalValue::LinkOnceAnyLinkage:   Out << "linkonce ";       break;
2288   case GlobalValue::LinkOnceODRLinkage:   Out << "linkonce_odr ";   break;
2289   case GlobalValue::WeakAnyLinkage:       Out << "weak ";           break;
2290   case GlobalValue::WeakODRLinkage:       Out << "weak_odr ";       break;
2291   case GlobalValue::CommonLinkage:        Out << "common ";         break;
2292   case GlobalValue::AppendingLinkage:     Out << "appending ";      break;
2293   case GlobalValue::ExternalWeakLinkage:  Out << "extern_weak ";    break;
2294   case GlobalValue::AvailableExternallyLinkage:
2295     Out << "available_externally ";
2296     break;
2297   }
2298 }
2299
2300 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2301                             formatted_raw_ostream &Out) {
2302   switch (Vis) {
2303   case GlobalValue::DefaultVisibility: break;
2304   case GlobalValue::HiddenVisibility:    Out << "hidden "; break;
2305   case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2306   }
2307 }
2308
2309 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2310                                  formatted_raw_ostream &Out) {
2311   switch (SCT) {
2312   case GlobalValue::DefaultStorageClass: break;
2313   case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2314   case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2315   }
2316 }
2317
2318 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2319                                   formatted_raw_ostream &Out) {
2320   switch (TLM) {
2321     case GlobalVariable::NotThreadLocal:
2322       break;
2323     case GlobalVariable::GeneralDynamicTLSModel:
2324       Out << "thread_local ";
2325       break;
2326     case GlobalVariable::LocalDynamicTLSModel:
2327       Out << "thread_local(localdynamic) ";
2328       break;
2329     case GlobalVariable::InitialExecTLSModel:
2330       Out << "thread_local(initialexec) ";
2331       break;
2332     case GlobalVariable::LocalExecTLSModel:
2333       Out << "thread_local(localexec) ";
2334       break;
2335   }
2336 }
2337
2338 static void maybePrintComdat(formatted_raw_ostream &Out,
2339                              const GlobalObject &GO) {
2340   const Comdat *C = GO.getComdat();
2341   if (!C)
2342     return;
2343
2344   if (isa<GlobalVariable>(GO))
2345     Out << ',';
2346   Out << " comdat";
2347
2348   if (GO.getName() == C->getName())
2349     return;
2350
2351   Out << '(';
2352   PrintLLVMName(Out, C->getName(), ComdatPrefix);
2353   Out << ')';
2354 }
2355
2356 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2357   if (GV->isMaterializable())
2358     Out << "; Materializable\n";
2359
2360   WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2361   Out << " = ";
2362
2363   if (!GV->hasInitializer() && GV->hasExternalLinkage())
2364     Out << "external ";
2365
2366   PrintLinkage(GV->getLinkage(), Out);
2367   PrintVisibility(GV->getVisibility(), Out);
2368   PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2369   PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2370   if (GV->hasUnnamedAddr())
2371     Out << "unnamed_addr ";
2372
2373   if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2374     Out << "addrspace(" << AddressSpace << ") ";
2375   if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2376   Out << (GV->isConstant() ? "constant " : "global ");
2377   TypePrinter.print(GV->getType()->getElementType(), Out);
2378
2379   if (GV->hasInitializer()) {
2380     Out << ' ';
2381     writeOperand(GV->getInitializer(), false);
2382   }
2383
2384   if (GV->hasSection()) {
2385     Out << ", section \"";
2386     PrintEscapedString(GV->getSection(), Out);
2387     Out << '"';
2388   }
2389   maybePrintComdat(Out, *GV);
2390   if (GV->getAlignment())
2391     Out << ", align " << GV->getAlignment();
2392
2393   printInfoComment(*GV);
2394 }
2395
2396 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2397   if (GA->isMaterializable())
2398     Out << "; Materializable\n";
2399
2400   WriteAsOperandInternal(Out, GA, &TypePrinter, &Machine, GA->getParent());
2401   Out << " = ";
2402
2403   PrintLinkage(GA->getLinkage(), Out);
2404   PrintVisibility(GA->getVisibility(), Out);
2405   PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2406   PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2407   if (GA->hasUnnamedAddr())
2408     Out << "unnamed_addr ";
2409
2410   Out << "alias ";
2411
2412   TypePrinter.print(GA->getValueType(), Out);
2413
2414   Out << ", ";
2415
2416   const Constant *Aliasee = GA->getAliasee();
2417
2418   if (!Aliasee) {
2419     TypePrinter.print(GA->getType(), Out);
2420     Out << " <<NULL ALIASEE>>";
2421   } else {
2422     writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2423   }
2424
2425   printInfoComment(*GA);
2426   Out << '\n';
2427 }
2428
2429 void AssemblyWriter::printComdat(const Comdat *C) {
2430   C->print(Out);
2431 }
2432
2433 void AssemblyWriter::printTypeIdentities() {
2434   if (TypePrinter.NumberedTypes.empty() &&
2435       TypePrinter.NamedTypes.empty())
2436     return;
2437
2438   Out << '\n';
2439
2440   // We know all the numbers that each type is used and we know that it is a
2441   // dense assignment.  Convert the map to an index table.
2442   std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2443   for (DenseMap<StructType*, unsigned>::iterator I =
2444        TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2445        I != E; ++I) {
2446     assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2447     NumberedTypes[I->second] = I->first;
2448   }
2449
2450   // Emit all numbered types.
2451   for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2452     Out << '%' << i << " = type ";
2453
2454     // Make sure we print out at least one level of the type structure, so
2455     // that we do not get %2 = type %2
2456     TypePrinter.printStructBody(NumberedTypes[i], Out);
2457     Out << '\n';
2458   }
2459
2460   for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2461     PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2462     Out << " = type ";
2463
2464     // Make sure we print out at least one level of the type structure, so
2465     // that we do not get %FILE = type %FILE
2466     TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2467     Out << '\n';
2468   }
2469 }
2470
2471 /// printFunction - Print all aspects of a function.
2472 ///
2473 void AssemblyWriter::printFunction(const Function *F) {
2474   // Print out the return type and name.
2475   Out << '\n';
2476
2477   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2478
2479   if (F->isMaterializable())
2480     Out << "; Materializable\n";
2481
2482   const AttributeSet &Attrs = F->getAttributes();
2483   if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2484     AttributeSet AS = Attrs.getFnAttributes();
2485     std::string AttrStr;
2486
2487     unsigned Idx = 0;
2488     for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2489       if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2490         break;
2491
2492     for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2493          I != E; ++I) {
2494       Attribute Attr = *I;
2495       if (!Attr.isStringAttribute()) {
2496         if (!AttrStr.empty()) AttrStr += ' ';
2497         AttrStr += Attr.getAsString();
2498       }
2499     }
2500
2501     if (!AttrStr.empty())
2502       Out << "; Function Attrs: " << AttrStr << '\n';
2503   }
2504
2505   if (F->isDeclaration())
2506     Out << "declare ";
2507   else
2508     Out << "define ";
2509
2510   PrintLinkage(F->getLinkage(), Out);
2511   PrintVisibility(F->getVisibility(), Out);
2512   PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2513
2514   // Print the calling convention.
2515   if (F->getCallingConv() != CallingConv::C) {
2516     PrintCallingConv(F->getCallingConv(), Out);
2517     Out << " ";
2518   }
2519
2520   FunctionType *FT = F->getFunctionType();
2521   if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2522     Out <<  Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2523   TypePrinter.print(F->getReturnType(), Out);
2524   Out << ' ';
2525   WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2526   Out << '(';
2527   Machine.incorporateFunction(F);
2528
2529   // Loop over the arguments, printing them...
2530   if (F->isDeclaration()) {
2531     // We're only interested in the type here - don't print argument names.
2532     for (unsigned I = 0, E = FT->getNumParams(); I != E; ++I) {
2533       // Insert commas as we go... the first arg doesn't get a comma
2534       if (I)
2535         Out << ", ";
2536       // Output type...
2537       TypePrinter.print(FT->getParamType(I), Out);
2538
2539       if (Attrs.hasAttributes(I + 1))
2540         Out << ' ' << Attrs.getAsString(I + 1);
2541     }
2542   } else {
2543     // The arguments are meaningful here, print them in detail.
2544     unsigned Idx = 1;
2545     for (const Argument &Arg : F->args()) {
2546       // Insert commas as we go... the first arg doesn't get a comma
2547       if (Idx != 1)
2548         Out << ", ";
2549       printArgument(&Arg, Attrs, Idx++);
2550     }
2551   }
2552
2553   // Finish printing arguments...
2554   if (FT->isVarArg()) {
2555     if (FT->getNumParams()) Out << ", ";
2556     Out << "...";  // Output varargs portion of signature!
2557   }
2558   Out << ')';
2559   if (F->hasUnnamedAddr())
2560     Out << " unnamed_addr";
2561   if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2562     Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2563   if (F->hasSection()) {
2564     Out << " section \"";
2565     PrintEscapedString(F->getSection(), Out);
2566     Out << '"';
2567   }
2568   maybePrintComdat(Out, *F);
2569   if (F->getAlignment())
2570     Out << " align " << F->getAlignment();
2571   if (F->hasGC())
2572     Out << " gc \"" << F->getGC() << '"';
2573   if (F->hasPrefixData()) {
2574     Out << " prefix ";
2575     writeOperand(F->getPrefixData(), true);
2576   }
2577   if (F->hasPrologueData()) {
2578     Out << " prologue ";
2579     writeOperand(F->getPrologueData(), true);
2580   }
2581   if (F->hasPersonalityFn()) {
2582     Out << " personality ";
2583     writeOperand(F->getPersonalityFn(), /*PrintType=*/true);
2584   }
2585
2586   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2587   F->getAllMetadata(MDs);
2588   printMetadataAttachments(MDs, " ");
2589
2590   if (F->isDeclaration()) {
2591     Out << '\n';
2592   } else {
2593     Out << " {";
2594     // Output all of the function's basic blocks.
2595     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2596       printBasicBlock(I);
2597
2598     // Output the function's use-lists.
2599     printUseLists(F);
2600
2601     Out << "}\n";
2602   }
2603
2604   Machine.purgeFunction();
2605 }
2606
2607 /// printArgument - This member is called for every argument that is passed into
2608 /// the function.  Simply print it out
2609 ///
2610 void AssemblyWriter::printArgument(const Argument *Arg,
2611                                    AttributeSet Attrs, unsigned Idx) {
2612   // Output type...
2613   TypePrinter.print(Arg->getType(), Out);
2614
2615   // Output parameter attributes list
2616   if (Attrs.hasAttributes(Idx))
2617     Out << ' ' << Attrs.getAsString(Idx);
2618
2619   // Output name, if available...
2620   if (Arg->hasName()) {
2621     Out << ' ';
2622     PrintLLVMName(Out, Arg);
2623   }
2624 }
2625
2626 /// printBasicBlock - This member is called for each basic block in a method.
2627 ///
2628 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2629   if (BB->hasName()) {              // Print out the label if it exists...
2630     Out << "\n";
2631     PrintLLVMName(Out, BB->getName(), LabelPrefix);
2632     Out << ':';
2633   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
2634     Out << "\n; <label>:";
2635     int Slot = Machine.getLocalSlot(BB);
2636     if (Slot != -1)
2637       Out << Slot;
2638     else
2639       Out << "<badref>";
2640   }
2641
2642   if (!BB->getParent()) {
2643     Out.PadToColumn(50);
2644     Out << "; Error: Block without parent!";
2645   } else if (BB != &BB->getParent()->getEntryBlock()) {  // Not the entry block?
2646     // Output predecessors for the block.
2647     Out.PadToColumn(50);
2648     Out << ";";
2649     const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2650
2651     if (PI == PE) {
2652       Out << " No predecessors!";
2653     } else {
2654       Out << " preds = ";
2655       writeOperand(*PI, false);
2656       for (++PI; PI != PE; ++PI) {
2657         Out << ", ";
2658         writeOperand(*PI, false);
2659       }
2660     }
2661   }
2662
2663   Out << "\n";
2664
2665   if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2666
2667   // Output all of the instructions in the basic block...
2668   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2669     printInstructionLine(*I);
2670   }
2671
2672   if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2673 }
2674
2675 /// printInstructionLine - Print an instruction and a newline character.
2676 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2677   printInstruction(I);
2678   Out << '\n';
2679 }
2680
2681 /// printGCRelocateComment - print comment after call to the gc.relocate
2682 /// intrinsic indicating base and derived pointer names.
2683 void AssemblyWriter::printGCRelocateComment(const Value &V) {
2684   assert(isGCRelocate(&V));
2685   GCRelocateOperands GCOps(cast<Instruction>(&V));
2686
2687   Out << " ; (";
2688   writeOperand(GCOps.getBasePtr(), false);
2689   Out << ", ";
2690   writeOperand(GCOps.getDerivedPtr(), false);
2691   Out << ")";
2692 }
2693
2694 /// printInfoComment - Print a little comment after the instruction indicating
2695 /// which slot it occupies.
2696 ///
2697 void AssemblyWriter::printInfoComment(const Value &V) {
2698   if (isGCRelocate(&V))
2699     printGCRelocateComment(V);
2700
2701   if (AnnotationWriter)
2702     AnnotationWriter->printInfoComment(V, Out);
2703 }
2704
2705 // This member is called for each Instruction in a function..
2706 void AssemblyWriter::printInstruction(const Instruction &I) {
2707   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2708
2709   // Print out indentation for an instruction.
2710   Out << "  ";
2711
2712   // Print out name if it exists...
2713   if (I.hasName()) {
2714     PrintLLVMName(Out, &I);
2715     Out << " = ";
2716   } else if (!I.getType()->isVoidTy()) {
2717     // Print out the def slot taken.
2718     int SlotNum = Machine.getLocalSlot(&I);
2719     if (SlotNum == -1)
2720       Out << "<badref> = ";
2721     else
2722       Out << '%' << SlotNum << " = ";
2723   }
2724
2725   if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2726     if (CI->isMustTailCall())
2727       Out << "musttail ";
2728     else if (CI->isTailCall())
2729       Out << "tail ";
2730   }
2731
2732   // Print out the opcode...
2733   Out << I.getOpcodeName();
2734
2735   // If this is an atomic load or store, print out the atomic marker.
2736   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isAtomic()) ||
2737       (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2738     Out << " atomic";
2739
2740   if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2741     Out << " weak";
2742
2743   // If this is a volatile operation, print out the volatile marker.
2744   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
2745       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2746       (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2747       (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2748     Out << " volatile";
2749
2750   // Print out optimization information.
2751   WriteOptimizationInfo(Out, &I);
2752
2753   // Print out the compare instruction predicates
2754   if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2755     Out << ' ' << getPredicateText(CI->getPredicate());
2756
2757   // Print out the atomicrmw operation
2758   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2759     writeAtomicRMWOperation(Out, RMWI->getOperation());
2760
2761   // Print out the type of the operands...
2762   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2763
2764   // Special case conditional branches to swizzle the condition out to the front
2765   if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2766     const BranchInst &BI(cast<BranchInst>(I));
2767     Out << ' ';
2768     writeOperand(BI.getCondition(), true);
2769     Out << ", ";
2770     writeOperand(BI.getSuccessor(0), true);
2771     Out << ", ";
2772     writeOperand(BI.getSuccessor(1), true);
2773
2774   } else if (isa<SwitchInst>(I)) {
2775     const SwitchInst& SI(cast<SwitchInst>(I));
2776     // Special case switch instruction to get formatting nice and correct.
2777     Out << ' ';
2778     writeOperand(SI.getCondition(), true);
2779     Out << ", ";
2780     writeOperand(SI.getDefaultDest(), true);
2781     Out << " [";
2782     for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2783          i != e; ++i) {
2784       Out << "\n    ";
2785       writeOperand(i.getCaseValue(), true);
2786       Out << ", ";
2787       writeOperand(i.getCaseSuccessor(), true);
2788     }
2789     Out << "\n  ]";
2790   } else if (isa<IndirectBrInst>(I)) {
2791     // Special case indirectbr instruction to get formatting nice and correct.
2792     Out << ' ';
2793     writeOperand(Operand, true);
2794     Out << ", [";
2795
2796     for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2797       if (i != 1)
2798         Out << ", ";
2799       writeOperand(I.getOperand(i), true);
2800     }
2801     Out << ']';
2802   } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2803     Out << ' ';
2804     TypePrinter.print(I.getType(), Out);
2805     Out << ' ';
2806
2807     for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2808       if (op) Out << ", ";
2809       Out << "[ ";
2810       writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2811       writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2812     }
2813   } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2814     Out << ' ';
2815     writeOperand(I.getOperand(0), true);
2816     for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2817       Out << ", " << *i;
2818   } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2819     Out << ' ';
2820     writeOperand(I.getOperand(0), true); Out << ", ";
2821     writeOperand(I.getOperand(1), true);
2822     for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2823       Out << ", " << *i;
2824   } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2825     Out << ' ';
2826     TypePrinter.print(I.getType(), Out);
2827     if (LPI->isCleanup() || LPI->getNumClauses() != 0)
2828       Out << '\n';
2829
2830     if (LPI->isCleanup())
2831       Out << "          cleanup";
2832
2833     for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2834       if (i != 0 || LPI->isCleanup()) Out << "\n";
2835       if (LPI->isCatch(i))
2836         Out << "          catch ";
2837       else
2838         Out << "          filter ";
2839
2840       writeOperand(LPI->getClause(i), true);
2841     }
2842   } else if (const auto *CPI = dyn_cast<CatchPadInst>(&I)) {
2843     Out << " [";
2844     for (unsigned Op = 0, NumOps = CPI->getNumArgOperands(); Op < NumOps;
2845          ++Op) {
2846       if (Op > 0)
2847         Out << ", ";
2848       writeOperand(CPI->getArgOperand(Op), /*PrintType=*/true);
2849     }
2850     Out << "]\n          to ";
2851     writeOperand(CPI->getNormalDest(), /*PrintType=*/true);
2852     Out << " unwind ";
2853     writeOperand(CPI->getUnwindDest(), /*PrintType=*/true);
2854   } else if (const auto *TPI = dyn_cast<TerminatePadInst>(&I)) {
2855     Out << " [";
2856     for (unsigned Op = 0, NumOps = TPI->getNumArgOperands(); Op < NumOps;
2857          ++Op) {
2858       if (Op > 0)
2859         Out << ", ";
2860       writeOperand(TPI->getArgOperand(Op), /*PrintType=*/true);
2861     }
2862     Out << "] unwind ";
2863     if (TPI->hasUnwindDest())
2864       writeOperand(TPI->getUnwindDest(), /*PrintType=*/true);
2865     else
2866       Out << "to caller";
2867   } else if (const auto *CPI = dyn_cast<CleanupPadInst>(&I)) {
2868     Out << " [";
2869     for (unsigned Op = 0, NumOps = CPI->getNumOperands(); Op < NumOps; ++Op) {
2870       if (Op > 0)
2871         Out << ", ";
2872       writeOperand(CPI->getOperand(Op), /*PrintType=*/true);
2873     }
2874     Out << "]";
2875   } else if (isa<ReturnInst>(I) && !Operand) {
2876     Out << " void";
2877   } else if (const auto *CRI = dyn_cast<CatchReturnInst>(&I)) {
2878     Out << ' ';
2879     writeOperand(CRI->getCatchPad(), /*PrintType=*/false);
2880
2881     Out << " to ";
2882     writeOperand(CRI->getSuccessor(), /*PrintType=*/true);
2883   } else if (const auto *CRI = dyn_cast<CleanupReturnInst>(&I)) {
2884     Out << ' ';
2885     writeOperand(CRI->getCleanupPad(), /*PrintType=*/false);
2886
2887     Out << " unwind ";
2888     if (CRI->hasUnwindDest())
2889       writeOperand(CRI->getUnwindDest(), /*PrintType=*/true);
2890     else
2891       Out << "to caller";
2892   } else if (const auto *CEPI = dyn_cast<CatchEndPadInst>(&I)) {
2893     Out << " unwind ";
2894     if (CEPI->hasUnwindDest())
2895       writeOperand(CEPI->getUnwindDest(), /*PrintType=*/true);
2896     else
2897       Out << "to caller";
2898   } else if (const auto *CEPI = dyn_cast<CleanupEndPadInst>(&I)) {
2899     Out << ' ';
2900     writeOperand(CEPI->getCleanupPad(), /*PrintType=*/false);
2901
2902     Out << " unwind ";
2903     if (CEPI->hasUnwindDest())
2904       writeOperand(CEPI->getUnwindDest(), /*PrintType=*/true);
2905     else
2906       Out << "to caller";
2907   } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2908     // Print the calling convention being used.
2909     if (CI->getCallingConv() != CallingConv::C) {
2910       Out << " ";
2911       PrintCallingConv(CI->getCallingConv(), Out);
2912     }
2913
2914     Operand = CI->getCalledValue();
2915     FunctionType *FTy = cast<FunctionType>(CI->getFunctionType());
2916     Type *RetTy = FTy->getReturnType();
2917     const AttributeSet &PAL = CI->getAttributes();
2918
2919     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2920       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2921
2922     // If possible, print out the short form of the call instruction.  We can
2923     // only do this if the first argument is a pointer to a nonvararg function,
2924     // and if the return type is not a pointer to a function.
2925     //
2926     Out << ' ';
2927     TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2928     Out << ' ';
2929     writeOperand(Operand, false);
2930     Out << '(';
2931     for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2932       if (op > 0)
2933         Out << ", ";
2934       writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2935     }
2936
2937     // Emit an ellipsis if this is a musttail call in a vararg function.  This
2938     // is only to aid readability, musttail calls forward varargs by default.
2939     if (CI->isMustTailCall() && CI->getParent() &&
2940         CI->getParent()->getParent() &&
2941         CI->getParent()->getParent()->isVarArg())
2942       Out << ", ...";
2943
2944     Out << ')';
2945     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2946       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2947   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2948     Operand = II->getCalledValue();
2949     FunctionType *FTy = cast<FunctionType>(II->getFunctionType());
2950     Type *RetTy = FTy->getReturnType();
2951     const AttributeSet &PAL = II->getAttributes();
2952
2953     // Print the calling convention being used.
2954     if (II->getCallingConv() != CallingConv::C) {
2955       Out << " ";
2956       PrintCallingConv(II->getCallingConv(), Out);
2957     }
2958
2959     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2960       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2961
2962     // If possible, print out the short form of the invoke instruction. We can
2963     // only do this if the first argument is a pointer to a nonvararg function,
2964     // and if the return type is not a pointer to a function.
2965     //
2966     Out << ' ';
2967     TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2968     Out << ' ';
2969     writeOperand(Operand, false);
2970     Out << '(';
2971     for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2972       if (op)
2973         Out << ", ";
2974       writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2975     }
2976
2977     Out << ')';
2978     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2979       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2980
2981     Out << "\n          to ";
2982     writeOperand(II->getNormalDest(), true);
2983     Out << " unwind ";
2984     writeOperand(II->getUnwindDest(), true);
2985
2986   } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2987     Out << ' ';
2988     if (AI->isUsedWithInAlloca())
2989       Out << "inalloca ";
2990     TypePrinter.print(AI->getAllocatedType(), Out);
2991
2992     // Explicitly write the array size if the code is broken, if it's an array
2993     // allocation, or if the type is not canonical for scalar allocations.  The
2994     // latter case prevents the type from mutating when round-tripping through
2995     // assembly.
2996     if (!AI->getArraySize() || AI->isArrayAllocation() ||
2997         !AI->getArraySize()->getType()->isIntegerTy(32)) {
2998       Out << ", ";
2999       writeOperand(AI->getArraySize(), true);
3000     }
3001     if (AI->getAlignment()) {
3002       Out << ", align " << AI->getAlignment();
3003     }
3004   } else if (isa<CastInst>(I)) {
3005     if (Operand) {
3006       Out << ' ';
3007       writeOperand(Operand, true);   // Work with broken code
3008     }
3009     Out << " to ";
3010     TypePrinter.print(I.getType(), Out);
3011   } else if (isa<VAArgInst>(I)) {
3012     if (Operand) {
3013       Out << ' ';
3014       writeOperand(Operand, true);   // Work with broken code
3015     }
3016     Out << ", ";
3017     TypePrinter.print(I.getType(), Out);
3018   } else if (Operand) {   // Print the normal way.
3019     if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
3020       Out << ' ';
3021       TypePrinter.print(GEP->getSourceElementType(), Out);
3022       Out << ',';
3023     } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
3024       Out << ' ';
3025       TypePrinter.print(LI->getType(), Out);
3026       Out << ',';
3027     }
3028
3029     // PrintAllTypes - Instructions who have operands of all the same type
3030     // omit the type from all but the first operand.  If the instruction has
3031     // different type operands (for example br), then they are all printed.
3032     bool PrintAllTypes = false;
3033     Type *TheType = Operand->getType();
3034
3035     // Select, Store and ShuffleVector always print all types.
3036     if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
3037         || isa<ReturnInst>(I)) {
3038       PrintAllTypes = true;
3039     } else {
3040       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
3041         Operand = I.getOperand(i);
3042         // note that Operand shouldn't be null, but the test helps make dump()
3043         // more tolerant of malformed IR
3044         if (Operand && Operand->getType() != TheType) {
3045           PrintAllTypes = true;    // We have differing types!  Print them all!
3046           break;
3047         }
3048       }
3049     }
3050
3051     if (!PrintAllTypes) {
3052       Out << ' ';
3053       TypePrinter.print(TheType, Out);
3054     }
3055
3056     Out << ' ';
3057     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
3058       if (i) Out << ", ";
3059       writeOperand(I.getOperand(i), PrintAllTypes);
3060     }
3061   }
3062
3063   // Print atomic ordering/alignment for memory operations
3064   if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
3065     if (LI->isAtomic())
3066       writeAtomic(LI->getOrdering(), LI->getSynchScope());
3067     if (LI->getAlignment())
3068       Out << ", align " << LI->getAlignment();
3069   } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
3070     if (SI->isAtomic())
3071       writeAtomic(SI->getOrdering(), SI->getSynchScope());
3072     if (SI->getAlignment())
3073       Out << ", align " << SI->getAlignment();
3074   } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
3075     writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
3076                        CXI->getSynchScope());
3077   } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
3078     writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
3079   } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
3080     writeAtomic(FI->getOrdering(), FI->getSynchScope());
3081   }
3082
3083   // Print Metadata info.
3084   SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
3085   I.getAllMetadata(InstMD);
3086   printMetadataAttachments(InstMD, ", ");
3087
3088   // Print a nice comment.
3089   printInfoComment(I);
3090 }
3091
3092 void AssemblyWriter::printMetadataAttachments(
3093     const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
3094     StringRef Separator) {
3095   if (MDs.empty())
3096     return;
3097
3098   if (MDNames.empty())
3099     TheModule->getMDKindNames(MDNames);
3100
3101   for (const auto &I : MDs) {
3102     unsigned Kind = I.first;
3103     Out << Separator;
3104     if (Kind < MDNames.size()) {
3105       Out << "!";
3106       printMetadataIdentifier(MDNames[Kind], Out);
3107     } else
3108       Out << "!<unknown kind #" << Kind << ">";
3109     Out << ' ';
3110     WriteAsOperandInternal(Out, I.second, &TypePrinter, &Machine, TheModule);
3111   }
3112 }
3113
3114 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
3115   Out << '!' << Slot << " = ";
3116   printMDNodeBody(Node);
3117   Out << "\n";
3118 }
3119
3120 void AssemblyWriter::writeAllMDNodes() {
3121   SmallVector<const MDNode *, 16> Nodes;
3122   Nodes.resize(Machine.mdn_size());
3123   for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3124        I != E; ++I)
3125     Nodes[I->second] = cast<MDNode>(I->first);
3126
3127   for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3128     writeMDNode(i, Nodes[i]);
3129   }
3130 }
3131
3132 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3133   WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3134 }
3135
3136 void AssemblyWriter::writeAllAttributeGroups() {
3137   std::vector<std::pair<AttributeSet, unsigned> > asVec;
3138   asVec.resize(Machine.as_size());
3139
3140   for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3141        I != E; ++I)
3142     asVec[I->second] = *I;
3143
3144   for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3145          I = asVec.begin(), E = asVec.end(); I != E; ++I)
3146     Out << "attributes #" << I->second << " = { "
3147         << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3148 }
3149
3150 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3151   bool IsInFunction = Machine.getFunction();
3152   if (IsInFunction)
3153     Out << "  ";
3154
3155   Out << "uselistorder";
3156   if (const BasicBlock *BB =
3157           IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3158     Out << "_bb ";
3159     writeOperand(BB->getParent(), false);
3160     Out << ", ";
3161     writeOperand(BB, false);
3162   } else {
3163     Out << " ";
3164     writeOperand(Order.V, true);
3165   }
3166   Out << ", { ";
3167
3168   assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3169   Out << Order.Shuffle[0];
3170   for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3171     Out << ", " << Order.Shuffle[I];
3172   Out << " }\n";
3173 }
3174
3175 void AssemblyWriter::printUseLists(const Function *F) {
3176   auto hasMore =
3177       [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3178   if (!hasMore())
3179     // Nothing to do.
3180     return;
3181
3182   Out << "\n; uselistorder directives\n";
3183   while (hasMore()) {
3184     printUseListOrder(UseListOrders.back());
3185     UseListOrders.pop_back();
3186   }
3187 }
3188
3189 //===----------------------------------------------------------------------===//
3190 //                       External Interface declarations
3191 //===----------------------------------------------------------------------===//
3192
3193 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
3194                    bool ShouldPreserveUseListOrder) const {
3195   SlotTracker SlotTable(this);
3196   formatted_raw_ostream OS(ROS);
3197   AssemblyWriter W(OS, SlotTable, this, AAW, ShouldPreserveUseListOrder);
3198   W.printModule(this);
3199 }
3200
3201 void NamedMDNode::print(raw_ostream &ROS) const {
3202   SlotTracker SlotTable(getParent());
3203   formatted_raw_ostream OS(ROS);
3204   AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3205   W.printNamedMDNode(this);
3206 }
3207
3208 void Comdat::print(raw_ostream &ROS) const {
3209   PrintLLVMName(ROS, getName(), ComdatPrefix);
3210   ROS << " = comdat ";
3211
3212   switch (getSelectionKind()) {
3213   case Comdat::Any:
3214     ROS << "any";
3215     break;
3216   case Comdat::ExactMatch:
3217     ROS << "exactmatch";
3218     break;
3219   case Comdat::Largest:
3220     ROS << "largest";
3221     break;
3222   case Comdat::NoDuplicates:
3223     ROS << "noduplicates";
3224     break;
3225   case Comdat::SameSize:
3226     ROS << "samesize";
3227     break;
3228   }
3229
3230   ROS << '\n';
3231 }
3232
3233 void Type::print(raw_ostream &OS) const {
3234   TypePrinting TP;
3235   TP.print(const_cast<Type*>(this), OS);
3236
3237   // If the type is a named struct type, print the body as well.
3238   if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3239     if (!STy->isLiteral()) {
3240       OS << " = type ";
3241       TP.printStructBody(STy, OS);
3242     }
3243 }
3244
3245 static bool isReferencingMDNode(const Instruction &I) {
3246   if (const auto *CI = dyn_cast<CallInst>(&I))
3247     if (Function *F = CI->getCalledFunction())
3248       if (F->isIntrinsic())
3249         for (auto &Op : I.operands())
3250           if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3251             if (isa<MDNode>(V->getMetadata()))
3252               return true;
3253   return false;
3254 }
3255
3256 void Value::print(raw_ostream &ROS) const {
3257   bool ShouldInitializeAllMetadata = false;
3258   if (auto *I = dyn_cast<Instruction>(this))
3259     ShouldInitializeAllMetadata = isReferencingMDNode(*I);
3260   else if (isa<Function>(this) || isa<MetadataAsValue>(this))
3261     ShouldInitializeAllMetadata = true;
3262
3263   ModuleSlotTracker MST(getModuleFromVal(this), ShouldInitializeAllMetadata);
3264   print(ROS, MST);
3265 }
3266
3267 void Value::print(raw_ostream &ROS, ModuleSlotTracker &MST) const {
3268   formatted_raw_ostream OS(ROS);
3269   SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
3270   SlotTracker &SlotTable =
3271       MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
3272   auto incorporateFunction = [&](const Function *F) {
3273     if (F)
3274       MST.incorporateFunction(*F);
3275   };
3276
3277   if (const Instruction *I = dyn_cast<Instruction>(this)) {
3278     incorporateFunction(I->getParent() ? I->getParent()->getParent() : nullptr);
3279     AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3280     W.printInstruction(*I);
3281   } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3282     incorporateFunction(BB->getParent());
3283     AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3284     W.printBasicBlock(BB);
3285   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3286     AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3287     if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3288       W.printGlobal(V);
3289     else if (const Function *F = dyn_cast<Function>(GV))
3290       W.printFunction(F);
3291     else
3292       W.printAlias(cast<GlobalAlias>(GV));
3293   } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3294     V->getMetadata()->print(ROS, MST, getModuleFromVal(V));
3295   } else if (const Constant *C = dyn_cast<Constant>(this)) {
3296     TypePrinting TypePrinter;
3297     TypePrinter.print(C->getType(), OS);
3298     OS << ' ';
3299     WriteConstantInternal(OS, C, TypePrinter, MST.getMachine(), nullptr);
3300   } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3301     this->printAsOperand(OS, /* PrintType */ true, MST);
3302   } else {
3303     llvm_unreachable("Unknown value to print out!");
3304   }
3305 }
3306
3307 /// Print without a type, skipping the TypePrinting object.
3308 ///
3309 /// \return \c true iff printing was successful.
3310 static bool printWithoutType(const Value &V, raw_ostream &O,
3311                              SlotTracker *Machine, const Module *M) {
3312   if (V.hasName() || isa<GlobalValue>(V) ||
3313       (!isa<Constant>(V) && !isa<MetadataAsValue>(V))) {
3314     WriteAsOperandInternal(O, &V, nullptr, Machine, M);
3315     return true;
3316   }
3317   return false;
3318 }
3319
3320 static void printAsOperandImpl(const Value &V, raw_ostream &O, bool PrintType,
3321                                ModuleSlotTracker &MST) {
3322   TypePrinting TypePrinter;
3323   if (const Module *M = MST.getModule())
3324     TypePrinter.incorporateTypes(*M);
3325   if (PrintType) {
3326     TypePrinter.print(V.getType(), O);
3327     O << ' ';
3328   }
3329
3330   WriteAsOperandInternal(O, &V, &TypePrinter, MST.getMachine(),
3331                          MST.getModule());
3332 }
3333
3334 void Value::printAsOperand(raw_ostream &O, bool PrintType,
3335                            const Module *M) const {
3336   if (!M)
3337     M = getModuleFromVal(this);
3338
3339   if (!PrintType)
3340     if (printWithoutType(*this, O, nullptr, M))
3341       return;
3342
3343   SlotTracker Machine(
3344       M, /* ShouldInitializeAllMetadata */ isa<MetadataAsValue>(this));
3345   ModuleSlotTracker MST(Machine, M);
3346   printAsOperandImpl(*this, O, PrintType, MST);
3347 }
3348
3349 void Value::printAsOperand(raw_ostream &O, bool PrintType,
3350                            ModuleSlotTracker &MST) const {
3351   if (!PrintType)
3352     if (printWithoutType(*this, O, MST.getMachine(), MST.getModule()))
3353       return;
3354
3355   printAsOperandImpl(*this, O, PrintType, MST);
3356 }
3357
3358 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3359                               ModuleSlotTracker &MST, const Module *M,
3360                               bool OnlyAsOperand) {
3361   formatted_raw_ostream OS(ROS);
3362
3363   TypePrinting TypePrinter;
3364   if (M)
3365     TypePrinter.incorporateTypes(*M);
3366
3367   WriteAsOperandInternal(OS, &MD, &TypePrinter, MST.getMachine(), M,
3368                          /* FromValue */ true);
3369
3370   auto *N = dyn_cast<MDNode>(&MD);
3371   if (OnlyAsOperand || !N)
3372     return;
3373
3374   OS << " = ";
3375   WriteMDNodeBodyInternal(OS, N, &TypePrinter, MST.getMachine(), M);
3376 }
3377
3378 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3379   ModuleSlotTracker MST(M, isa<MDNode>(this));
3380   printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ true);
3381 }
3382
3383 void Metadata::printAsOperand(raw_ostream &OS, ModuleSlotTracker &MST,
3384                               const Module *M) const {
3385   printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ true);
3386 }
3387
3388 void Metadata::print(raw_ostream &OS, const Module *M) const {
3389   ModuleSlotTracker MST(M, isa<MDNode>(this));
3390   printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false);
3391 }
3392
3393 void Metadata::print(raw_ostream &OS, ModuleSlotTracker &MST,
3394                      const Module *M) const {
3395   printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false);
3396 }
3397
3398 // Value::dump - allow easy printing of Values from the debugger.
3399 LLVM_DUMP_METHOD
3400 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3401
3402 // Type::dump - allow easy printing of Types from the debugger.
3403 LLVM_DUMP_METHOD
3404 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3405
3406 // Module::dump() - Allow printing of Modules from the debugger.
3407 LLVM_DUMP_METHOD
3408 void Module::dump() const { print(dbgs(), nullptr); }
3409
3410 // \brief Allow printing of Comdats from the debugger.
3411 LLVM_DUMP_METHOD
3412 void Comdat::dump() const { print(dbgs()); }
3413
3414 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3415 LLVM_DUMP_METHOD
3416 void NamedMDNode::dump() const { print(dbgs()); }
3417
3418 LLVM_DUMP_METHOD
3419 void Metadata::dump() const { dump(nullptr); }
3420
3421 LLVM_DUMP_METHOD
3422 void Metadata::dump(const Module *M) const {
3423   print(dbgs(), M);
3424   dbgs() << '\n';
3425 }