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