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