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/TypeFinder.h"
  35 #include "llvm/IR/UseListOrder.h"
  36 #include "llvm/IR/ValueSymbolTable.h"
  37 #include "llvm/Support/Debug.h"
  38 #include "llvm/Support/Dwarf.h"
  39 #include "llvm/Support/ErrorHandling.h"
  40 #include "llvm/Support/FormattedStream.h"
  41 #include "llvm/Support/MathExtras.h"
  42 #include "llvm/Support/raw_ostream.h"
  43 #include <algorithm>
  44 #include <cctype>
  45 using namespace llvm;
  46
  47 // Make virtual table appear in this compilation unit.
  48 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
  49
  50 //===----------------------------------------------------------------------===//
  51 // Helper Functions
  52 //===----------------------------------------------------------------------===//
  53
  54 namespace {
  55 struct OrderMap {
  56   DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
  57
  58   unsigned size() const { return IDs.size(); }
  59   std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
  60   std::pair<unsigned, bool> lookup(const Value *V) const {
  61     return IDs.lookup(V);
  62   }
  63   void index(const Value *V) {
  64     // Explicitly sequence get-size and insert-value operations to avoid UB.
  65     unsigned ID = IDs.size() + 1;
  66     IDs[V].first = ID;
  67   }
  68 };
  69 }
  70
  71 static void orderValue(const Value *V, OrderMap &OM) {
  72   if (OM.lookup(V).first)
  73     return;
  74
  75   if (const Constant *C = dyn_cast<Constant>(V))
  76     if (C->getNumOperands() && !isa<GlobalValue>(C))
  77       for (const Value *Op : C->operands())
  78         if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
  79           orderValue(Op, OM);
  80
  81   // Note: we cannot cache this lookup above, since inserting into the map
  82   // changes the map's size, and thus affects the other IDs.
  83   OM.index(V);
  84 }
  85
  86 static OrderMap orderModule(const Module *M) {
  87   // This needs to match the order used by ValueEnumerator::ValueEnumerator()
  88   // and ValueEnumerator::incorporateFunction().
  89   OrderMap OM;
  90
  91   for (const GlobalVariable &G : M->globals()) {
  92     if (G.hasInitializer())
  93       if (!isa<GlobalValue>(G.getInitializer()))
  94         orderValue(G.getInitializer(), OM);
  95     orderValue(&G, OM);
  96   }
  97   for (const GlobalAlias &A : M->aliases()) {
  98     if (!isa<GlobalValue>(A.getAliasee()))
  99       orderValue(A.getAliasee(), OM);
 100     orderValue(&A, OM);
 101   }
 102   for (const Function &F : *M) {
 103     if (F.hasPrefixData())
 104       if (!isa<GlobalValue>(F.getPrefixData()))
 105         orderValue(F.getPrefixData(), OM);
 106
 107     if (F.hasPrologueData())
 108       if (!isa<GlobalValue>(F.getPrologueData()))
 109         orderValue(F.getPrologueData(), OM);
 110
 111     orderValue(&F, OM);
 112
 113     if (F.isDeclaration())
 114       continue;
 115
 116     for (const Argument &A : F.args())
 117       orderValue(&A, OM);
 118     for (const BasicBlock &BB : F) {
 119       orderValue(&BB, OM);
 120       for (const Instruction &I : BB) {
 121         for (const Value *Op : I.operands())
 122           if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
 123               isa<InlineAsm>(*Op))
 124             orderValue(Op, OM);
 125         orderValue(&I, OM);
 126       }
 127     }
 128   }
 129   return OM;
 130 }
 131
 132 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
 133                                          unsigned ID, const OrderMap &OM,
 134                                          UseListOrderStack &Stack) {
 135   // Predict use-list order for this one.
 136   typedef std::pair<const Use *, unsigned> Entry;
 137   SmallVector<Entry, 64> List;
 138   for (const Use &U : V->uses())
 139     // Check if this user will be serialized.
 140     if (OM.lookup(U.getUser()).first)
 141       List.push_back(std::make_pair(&U, List.size()));
 142
 143   if (List.size() < 2)
 144     // We may have lost some users.
 145     return;
 146
 147   bool GetsReversed =
 148       !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
 149   if (auto *BA = dyn_cast<BlockAddress>(V))
 150     ID = OM.lookup(BA->getBasicBlock()).first;
 151   std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
 152     const Use *LU = L.first;
 153     const Use *RU = R.first;
 154     if (LU == RU)
 155       return false;
 156
 157     auto LID = OM.lookup(LU->getUser()).first;
 158     auto RID = OM.lookup(RU->getUser()).first;
 159
 160     // If ID is 4, then expect: 7 6 5 1 2 3.
 161     if (LID < RID) {
 162       if (GetsReversed)
 163         if (RID <= ID)
 164           return true;
 165       return false;
 166     }
 167     if (RID < LID) {
 168       if (GetsReversed)
 169         if (LID <= ID)
 170           return false;
 171       return true;
 172     }
 173
 174     // LID and RID are equal, so we have different operands of the same user.
 175     // Assume operands are added in order for all instructions.
 176     if (GetsReversed)
 177       if (LID <= ID)
 178         return LU->getOperandNo() < RU->getOperandNo();
 179     return LU->getOperandNo() > RU->getOperandNo();
 180   });
 181
 182   if (std::is_sorted(
 183           List.begin(), List.end(),
 184           [](const Entry &L, const Entry &R) { return L.second < R.second; }))
 185     // Order is already correct.
 186     return;
 187
 188   // Store the shuffle.
 189   Stack.emplace_back(V, F, List.size());
 190   assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
 191   for (size_t I = 0, E = List.size(); I != E; ++I)
 192     Stack.back().Shuffle[I] = List[I].second;
 193 }
 194
 195 static void predictValueUseListOrder(const Value *V, const Function *F,
 196                                      OrderMap &OM, UseListOrderStack &Stack) {
 197   auto &IDPair = OM[V];
 198   assert(IDPair.first && "Unmapped value");
 199   if (IDPair.second)
 200     // Already predicted.
 201     return;
 202
 203   // Do the actual prediction.
 204   IDPair.second = true;
 205   if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
 206     predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
 207
 208   // Recursive descent into constants.
 209   if (const Constant *C = dyn_cast<Constant>(V))
 210     if (C->getNumOperands()) // Visit GlobalValues.
 211       for (const Value *Op : C->operands())
 212         if (isa<Constant>(Op)) // Visit GlobalValues.
 213           predictValueUseListOrder(Op, F, OM, Stack);
 214 }
 215
 216 static UseListOrderStack predictUseListOrder(const Module *M) {
 217   OrderMap OM = orderModule(M);
 218
 219   // Use-list orders need to be serialized after all the users have been added
 220   // to a value, or else the shuffles will be incomplete.  Store them per
 221   // function in a stack.
 222   //
 223   // Aside from function order, the order of values doesn't matter much here.
 224   UseListOrderStack Stack;
 225
 226   // We want to visit the functions backward now so we can list function-local
 227   // constants in the last Function they're used in.  Module-level constants
 228   // have already been visited above.
 229   for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
 230     const Function &F = *I;
 231     if (F.isDeclaration())
 232       continue;
 233     for (const BasicBlock &BB : F)
 234       predictValueUseListOrder(&BB, &F, OM, Stack);
 235     for (const Argument &A : F.args())
 236       predictValueUseListOrder(&A, &F, OM, Stack);
 237     for (const BasicBlock &BB : F)
 238       for (const Instruction &I : BB)
 239         for (const Value *Op : I.operands())
 240           if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
 241             predictValueUseListOrder(Op, &F, OM, Stack);
 242     for (const BasicBlock &BB : F)
 243       for (const Instruction &I : BB)
 244         predictValueUseListOrder(&I, &F, OM, Stack);
 245   }
 246
 247   // Visit globals last.
 248   for (const GlobalVariable &G : M->globals())
 249     predictValueUseListOrder(&G, nullptr, OM, Stack);
 250   for (const Function &F : *M)
 251     predictValueUseListOrder(&F, nullptr, OM, Stack);
 252   for (const GlobalAlias &A : M->aliases())
 253     predictValueUseListOrder(&A, nullptr, OM, Stack);
 254   for (const GlobalVariable &G : M->globals())
 255     if (G.hasInitializer())
 256       predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
 257   for (const GlobalAlias &A : M->aliases())
 258     predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
 259   for (const Function &F : *M)
 260     if (F.hasPrefixData())
 261       predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
 262
 263   return Stack;
 264 }
 265
 266 static const Module *getModuleFromVal(const Value *V) {
 267   if (const Argument *MA = dyn_cast<Argument>(V))
 268     return MA->getParent() ? MA->getParent()->getParent() : nullptr;
 269
 270   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 271     return BB->getParent() ? BB->getParent()->getParent() : nullptr;
 272
 273   if (const Instruction *I = dyn_cast<Instruction>(V)) {
 274     const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
 275     return M ? M->getParent() : nullptr;
 276   }
 277
 278   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
 279     return GV->getParent();
 280
 281   if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
 282     for (const User *U : MAV->users())
 283       if (isa<Instruction>(U))
 284         if (const Module *M = getModuleFromVal(U))
 285           return M;
 286     return nullptr;
 287   }
 288
 289   return nullptr;
 290 }
 291
 292 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
 293   switch (cc) {
 294   default:                         Out << "cc" << cc; break;
 295   case CallingConv::Fast:          Out << "fastcc"; break;
 296   case CallingConv::Cold:          Out << "coldcc"; break;
 297   case CallingConv::WebKit_JS:     Out << "webkit_jscc"; break;
 298   case CallingConv::AnyReg:        Out << "anyregcc"; break;
 299   case CallingConv::PreserveMost:  Out << "preserve_mostcc"; break;
 300   case CallingConv::PreserveAll:   Out << "preserve_allcc"; break;
 301   case CallingConv::GHC:           Out << "ghccc"; break;
 302   case CallingConv::X86_StdCall:   Out << "x86_stdcallcc"; break;
 303   case CallingConv::X86_FastCall:  Out << "x86_fastcallcc"; break;
 304   case CallingConv::X86_ThisCall:  Out << "x86_thiscallcc"; break;
 305   case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
 306   case CallingConv::Intel_OCL_BI:  Out << "intel_ocl_bicc"; break;
 307   case CallingConv::ARM_APCS:      Out << "arm_apcscc"; break;
 308   case CallingConv::ARM_AAPCS:     Out << "arm_aapcscc"; break;
 309   case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
 310   case CallingConv::MSP430_INTR:   Out << "msp430_intrcc"; break;
 311   case CallingConv::PTX_Kernel:    Out << "ptx_kernel"; break;
 312   case CallingConv::PTX_Device:    Out << "ptx_device"; break;
 313   case CallingConv::X86_64_SysV:   Out << "x86_64_sysvcc"; break;
 314   case CallingConv::X86_64_Win64:  Out << "x86_64_win64cc"; break;
 315   case CallingConv::SPIR_FUNC:     Out << "spir_func"; break;
 316   case CallingConv::SPIR_KERNEL:   Out << "spir_kernel"; break;
 317   }
 318 }
 319
 320 // PrintEscapedString - Print each character of the specified string, escaping
 321 // it if it is not printable or if it is an escape char.
 322 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
 323   for (unsigned i = 0, e = Name.size(); i != e; ++i) {
 324     unsigned char C = Name[i];
 325     if (isprint(C) && C != '\\' && C != '"')
 326       Out << C;
 327     else
 328       Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
 329   }
 330 }
 331
 332 enum PrefixType {
 333   GlobalPrefix,
 334   ComdatPrefix,
 335   LabelPrefix,
 336   LocalPrefix,
 337   NoPrefix
 338 };
 339
 340 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
 341 /// prefixed with % (if the string only contains simple characters) or is
 342 /// surrounded with ""'s (if it has special chars in it).  Print it out.
 343 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
 344   assert(!Name.empty() && "Cannot get empty name!");
 345   switch (Prefix) {
 346   case NoPrefix: break;
 347   case GlobalPrefix: OS << '@'; break;
 348   case ComdatPrefix: OS << '$'; break;
 349   case LabelPrefix:  break;
 350   case LocalPrefix:  OS << '%'; break;
 351   }
 352
 353   // Scan the name to see if it needs quotes first.
 354   bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
 355   if (!NeedsQuotes) {
 356     for (unsigned i = 0, e = Name.size(); i != e; ++i) {
 357       // By making this unsigned, the value passed in to isalnum will always be
 358       // in the range 0-255.  This is important when building with MSVC because
 359       // its implementation will assert.  This situation can arise when dealing
 360       // with UTF-8 multibyte characters.
 361       unsigned char C = Name[i];
 362       if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
 363           C != '_') {
 364         NeedsQuotes = true;
 365         break;
 366       }
 367     }
 368   }
 369
 370   // If we didn't need any quotes, just write out the name in one blast.
 371   if (!NeedsQuotes) {
 372     OS << Name;
 373     return;
 374   }
 375
 376   // Okay, we need quotes.  Output the quotes and escape any scary characters as
 377   // needed.
 378   OS << '"';
 379   PrintEscapedString(Name, OS);
 380   OS << '"';
 381 }
 382
 383 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
 384 /// prefixed with % (if the string only contains simple characters) or is
 385 /// surrounded with ""'s (if it has special chars in it).  Print it out.
 386 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
 387   PrintLLVMName(OS, V->getName(),
 388                 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
 389 }
 390
 391
 392 namespace {
 393 class TypePrinting {
 394   TypePrinting(const TypePrinting &) = delete;
 395   void operator=(const TypePrinting&) = delete;
 396 public:
 397
 398   /// NamedTypes - The named types that are used by the current module.
 399   TypeFinder NamedTypes;
 400
 401   /// NumberedTypes - The numbered types, along with their value.
 402   DenseMap<StructType*, unsigned> NumberedTypes;
 403
 404
 405   TypePrinting() {}
 406   ~TypePrinting() {}
 407
 408   void incorporateTypes(const Module &M);
 409
 410   void print(Type *Ty, raw_ostream &OS);
 411
 412   void printStructBody(StructType *Ty, raw_ostream &OS);
 413 };
 414 } // namespace
 415
 416 void TypePrinting::incorporateTypes(const Module &M) {
 417   NamedTypes.run(M, false);
 418
 419   // The list of struct types we got back includes all the struct types, split
 420   // the unnamed ones out to a numbering and remove the anonymous structs.
 421   unsigned NextNumber = 0;
 422
 423   std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
 424   for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
 425     StructType *STy = *I;
 426
 427     // Ignore anonymous types.
 428     if (STy->isLiteral())
 429       continue;
 430
 431     if (STy->getName().empty())
 432       NumberedTypes[STy] = NextNumber++;
 433     else
 434       *NextToUse++ = STy;
 435   }
 436
 437   NamedTypes.erase(NextToUse, NamedTypes.end());
 438 }
 439
 440
 441 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
 442 /// use of type names or up references to shorten the type name where possible.
 443 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
 444   switch (Ty->getTypeID()) {
 445   case Type::VoidTyID:      OS << "void"; return;
 446   case Type::HalfTyID:      OS << "half"; return;
 447   case Type::FloatTyID:     OS << "float"; return;
 448   case Type::DoubleTyID:    OS << "double"; return;
 449   case Type::X86_FP80TyID:  OS << "x86_fp80"; return;
 450   case Type::FP128TyID:     OS << "fp128"; return;
 451   case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
 452   case Type::LabelTyID:     OS << "label"; return;
 453   case Type::MetadataTyID:  OS << "metadata"; return;
 454   case Type::X86_MMXTyID:   OS << "x86_mmx"; return;
 455   case Type::IntegerTyID:
 456     OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
 457     return;
 458
 459   case Type::FunctionTyID: {
 460     FunctionType *FTy = cast<FunctionType>(Ty);
 461     print(FTy->getReturnType(), OS);
 462     OS << " (";
 463     for (FunctionType::param_iterator I = FTy->param_begin(),
 464          E = FTy->param_end(); I != E; ++I) {
 465       if (I != FTy->param_begin())
 466         OS << ", ";
 467       print(*I, OS);
 468     }
 469     if (FTy->isVarArg()) {
 470       if (FTy->getNumParams()) OS << ", ";
 471       OS << "...";
 472     }
 473     OS << ')';
 474     return;
 475   }
 476   case Type::StructTyID: {
 477     StructType *STy = cast<StructType>(Ty);
 478
 479     if (STy->isLiteral())
 480       return printStructBody(STy, OS);
 481
 482     if (!STy->getName().empty())
 483       return PrintLLVMName(OS, STy->getName(), LocalPrefix);
 484
 485     DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
 486     if (I != NumberedTypes.end())
 487       OS << '%' << I->second;
 488     else  // Not enumerated, print the hex address.
 489       OS << "%\"type " << STy << '\"';
 490     return;
 491   }
 492   case Type::PointerTyID: {
 493     PointerType *PTy = cast<PointerType>(Ty);
 494     print(PTy->getElementType(), OS);
 495     if (unsigned AddressSpace = PTy->getAddressSpace())
 496       OS << " addrspace(" << AddressSpace << ')';
 497     OS << '*';
 498     return;
 499   }
 500   case Type::ArrayTyID: {
 501     ArrayType *ATy = cast<ArrayType>(Ty);
 502     OS << '[' << ATy->getNumElements() << " x ";
 503     print(ATy->getElementType(), OS);
 504     OS << ']';
 505     return;
 506   }
 507   case Type::VectorTyID: {
 508     VectorType *PTy = cast<VectorType>(Ty);
 509     OS << "<" << PTy->getNumElements() << " x ";
 510     print(PTy->getElementType(), OS);
 511     OS << '>';
 512     return;
 513   }
 514   }
 515   llvm_unreachable("Invalid TypeID");
 516 }
 517
 518 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
 519   if (STy->isOpaque()) {
 520     OS << "opaque";
 521     return;
 522   }
 523
 524   if (STy->isPacked())
 525     OS << '<';
 526
 527   if (STy->getNumElements() == 0) {
 528     OS << "{}";
 529   } else {
 530     StructType::element_iterator I = STy->element_begin();
 531     OS << "{ ";
 532     print(*I++, OS);
 533     for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
 534       OS << ", ";
 535       print(*I, OS);
 536     }
 537
 538     OS << " }";
 539   }
 540   if (STy->isPacked())
 541     OS << '>';
 542 }
 543
 544 namespace {
 545 //===----------------------------------------------------------------------===//
 546 // SlotTracker Class: Enumerate slot numbers for unnamed values
 547 //===----------------------------------------------------------------------===//
 548 /// This class provides computation of slot numbers for LLVM Assembly writing.
 549 ///
 550 class SlotTracker {
 551 public:
 552   /// ValueMap - A mapping of Values to slot numbers.
 553   typedef DenseMap<const Value*, unsigned> ValueMap;
 554
 555 private:
 556   /// TheModule - The module for which we are holding slot numbers.
 557   const Module* TheModule;
 558
 559   /// TheFunction - The function for which we are holding slot numbers.
 560   const Function* TheFunction;
 561   bool FunctionProcessed;
 562   bool ShouldInitializeAllMetadata;
 563
 564   /// mMap - The slot map for the module level data.
 565   ValueMap mMap;
 566   unsigned mNext;
 567
 568   /// fMap - The slot map for the function level data.
 569   ValueMap fMap;
 570   unsigned fNext;
 571
 572   /// mdnMap - Map for MDNodes.
 573   DenseMap<const MDNode*, unsigned> mdnMap;
 574   unsigned mdnNext;
 575
 576   /// asMap - The slot map for attribute sets.
 577   DenseMap<AttributeSet, unsigned> asMap;
 578   unsigned asNext;
 579 public:
 580   /// Construct from a module.
 581   ///
 582   /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
 583   /// functions, giving correct numbering for metadata referenced only from
 584   /// within a function (even if no functions have been initialized).
 585   explicit SlotTracker(const Module *M,
 586                        bool ShouldInitializeAllMetadata = false);
 587   /// Construct from a function, starting out in incorp state.
 588   ///
 589   /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
 590   /// functions, giving correct numbering for metadata referenced only from
 591   /// within a function (even if no functions have been initialized).
 592   explicit SlotTracker(const Function *F,
 593                        bool ShouldInitializeAllMetadata = false);
 594
 595   /// Return the slot number of the specified value in it's type
 596   /// plane.  If something is not in the SlotTracker, return -1.
 597   int getLocalSlot(const Value *V);
 598   int getGlobalSlot(const GlobalValue *V);
 599   int getMetadataSlot(const MDNode *N);
 600   int getAttributeGroupSlot(AttributeSet AS);
 601
 602   /// If you'd like to deal with a function instead of just a module, use
 603   /// this method to get its data into the SlotTracker.
 604   void incorporateFunction(const Function *F) {
 605     TheFunction = F;
 606     FunctionProcessed = false;
 607   }
 608
 609   const Function *getFunction() const { return TheFunction; }
 610
 611   /// After calling incorporateFunction, use this method to remove the
 612   /// most recently incorporated function from the SlotTracker. This
 613   /// will reset the state of the machine back to just the module contents.
 614   void purgeFunction();
 615
 616   /// MDNode map iterators.
 617   typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
 618   mdn_iterator mdn_begin() { return mdnMap.begin(); }
 619   mdn_iterator mdn_end() { return mdnMap.end(); }
 620   unsigned mdn_size() const { return mdnMap.size(); }
 621   bool mdn_empty() const { return mdnMap.empty(); }
 622
 623   /// AttributeSet map iterators.
 624   typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
 625   as_iterator as_begin()   { return asMap.begin(); }
 626   as_iterator as_end()     { return asMap.end(); }
 627   unsigned as_size() const { return asMap.size(); }
 628   bool as_empty() const    { return asMap.empty(); }
 629
 630   /// This function does the actual initialization.
 631   inline void initialize();
 632
 633   // Implementation Details
 634 private:
 635   /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
 636   void CreateModuleSlot(const GlobalValue *V);
 637
 638   /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
 639   void CreateMetadataSlot(const MDNode *N);
 640
 641   /// CreateFunctionSlot - Insert the specified Value* into the slot table.
 642   void CreateFunctionSlot(const Value *V);
 643
 644   /// \brief Insert the specified AttributeSet into the slot table.
 645   void CreateAttributeSetSlot(AttributeSet AS);
 646
 647   /// Add all of the module level global variables (and their initializers)
 648   /// and function declarations, but not the contents of those functions.
 649   void processModule();
 650
 651   /// Add all of the functions arguments, basic blocks, and instructions.
 652   void processFunction();
 653
 654   /// Add all of the metadata from a function.
 655   void processFunctionMetadata(const Function &F);
 656
 657   /// Add all of the metadata from an instruction.
 658   void processInstructionMetadata(const Instruction &I);
 659
 660   SlotTracker(const SlotTracker &) = delete;
 661   void operator=(const SlotTracker &) = delete;
 662 };
 663 } // namespace
 664
 665 static SlotTracker *createSlotTracker(const Module *M) {
 666   return new SlotTracker(M);
 667 }
 668
 669 static SlotTracker *createSlotTracker(const Value *V) {
 670   if (const Argument *FA = dyn_cast<Argument>(V))
 671     return new SlotTracker(FA->getParent());
 672
 673   if (const Instruction *I = dyn_cast<Instruction>(V))
 674     if (I->getParent())
 675       return new SlotTracker(I->getParent()->getParent());
 676
 677   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 678     return new SlotTracker(BB->getParent());
 679
 680   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
 681     return new SlotTracker(GV->getParent());
 682
 683   if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
 684     return new SlotTracker(GA->getParent());
 685
 686   if (const Function *Func = dyn_cast<Function>(V))
 687     return new SlotTracker(Func);
 688
 689   return nullptr;
 690 }
 691
 692 #if 0
 693 #define ST_DEBUG(X) dbgs() << X
 694 #else
 695 #define ST_DEBUG(X)
 696 #endif
 697
 698 // Module level constructor. Causes the contents of the Module (sans functions)
 699 // to be added to the slot table.
 700 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
 701     : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
 702       ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
 703       fNext(0), mdnNext(0), asNext(0) {}
 704
 705 // Function level constructor. Causes the contents of the Module and the one
 706 // function provided to be added to the slot table.
 707 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
 708     : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
 709       FunctionProcessed(false),
 710       ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
 711       fNext(0), mdnNext(0), asNext(0) {}
 712
 713 inline void SlotTracker::initialize() {
 714   if (TheModule) {
 715     processModule();
 716     TheModule = nullptr; ///< Prevent re-processing next time we're called.
 717   }
 718
 719   if (TheFunction && !FunctionProcessed)
 720     processFunction();
 721 }
 722
 723 // Iterate through all the global variables, functions, and global
 724 // variable initializers and create slots for them.
 725 void SlotTracker::processModule() {
 726   ST_DEBUG("begin processModule!\n");
 727
 728   // Add all of the unnamed global variables to the value table.
 729   for (Module::const_global_iterator I = TheModule->global_begin(),
 730          E = TheModule->global_end(); I != E; ++I) {
 731     if (!I->hasName())
 732       CreateModuleSlot(I);
 733   }
 734
 735   // Add metadata used by named metadata.
 736   for (Module::const_named_metadata_iterator
 737          I = TheModule->named_metadata_begin(),
 738          E = TheModule->named_metadata_end(); I != E; ++I) {
 739     const NamedMDNode *NMD = I;
 740     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
 741       CreateMetadataSlot(NMD->getOperand(i));
 742   }
 743
 744   for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
 745        I != E; ++I) {
 746     if (!I->hasName())
 747       // Add all the unnamed functions to the table.
 748       CreateModuleSlot(I);
 749
 750     if (ShouldInitializeAllMetadata)
 751       processFunctionMetadata(*I);
 752
 753     // Add all the function attributes to the table.
 754     // FIXME: Add attributes of other objects?
 755     AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
 756     if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
 757       CreateAttributeSetSlot(FnAttrs);
 758   }
 759
 760   ST_DEBUG("end processModule!\n");
 761 }
 762
 763 // Process the arguments, basic blocks, and instructions  of a function.
 764 void SlotTracker::processFunction() {
 765   ST_DEBUG("begin processFunction!\n");
 766   fNext = 0;
 767
 768   // Add all the function arguments with no names.
 769   for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
 770       AE = TheFunction->arg_end(); AI != AE; ++AI)
 771     if (!AI->hasName())
 772       CreateFunctionSlot(AI);
 773
 774   ST_DEBUG("Inserting Instructions:\n");
 775
 776   // Add all of the basic blocks and instructions with no names.
 777   for (auto &BB : *TheFunction) {
 778     if (!BB.hasName())
 779       CreateFunctionSlot(&BB);
 780
 781     for (auto &I : BB) {
 782       if (!I.getType()->isVoidTy() && !I.hasName())
 783         CreateFunctionSlot(&I);
 784
 785       processInstructionMetadata(I);
 786
 787       // We allow direct calls to any llvm.foo function here, because the
 788       // target may not be linked into the optimizer.
 789       if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
 790         // Add all the call attributes to the table.
 791         AttributeSet Attrs = CI->getAttributes().getFnAttributes();
 792         if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
 793           CreateAttributeSetSlot(Attrs);
 794       } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
 795         // Add all the call attributes to the table.
 796         AttributeSet Attrs = II->getAttributes().getFnAttributes();
 797         if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
 798           CreateAttributeSetSlot(Attrs);
 799       }
 800     }
 801   }
 802
 803   FunctionProcessed = true;
 804
 805   ST_DEBUG("end processFunction!\n");
 806 }
 807
 808 void SlotTracker::processFunctionMetadata(const Function &F) {
 809   for (auto &BB : F)
 810     for (auto &I : BB)
 811       processInstructionMetadata(I);
 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 DebugNode *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 DebugNode *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 = DIDescriptor::splitFlags(Flags, SplitFlags);
1447
1448   FieldSeparator FlagsFS(" | ");
1449   for (unsigned F : SplitFlags) {
1450     const char *StringF = DIDescriptor::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 writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
1472                                   TypePrinting *TypePrinter,
1473                                   SlotTracker *Machine, const Module *Context) {
1474   Out << "!GenericDebugNode(";
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 writeMDLocation(raw_ostream &Out, const MDLocation *DL,
1491                             TypePrinting *TypePrinter, SlotTracker *Machine,
1492                             const Module *Context) {
1493   Out << "!MDLocation(";
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 writeMDSubrange(raw_ostream &Out, const MDSubrange *N,
1504                             TypePrinting *, SlotTracker *, const Module *) {
1505   Out << "!MDSubrange(";
1506   MDFieldPrinter Printer(Out);
1507   Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1508   Printer.printInt("lowerBound", N->getLo());
1509   Out << ")";
1510 }
1511
1512 static void writeMDEnumerator(raw_ostream &Out, const MDEnumerator *N,
1513                               TypePrinting *, SlotTracker *, const Module *) {
1514   Out << "!MDEnumerator(";
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 writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
1522                              TypePrinting *, SlotTracker *, const Module *) {
1523   Out << "!MDBasicType(";
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 writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
1536                                TypePrinting *TypePrinter, SlotTracker *Machine,
1537                                const Module *Context) {
1538   Out << "!MDDerivedType(";
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 writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
1556                                  TypePrinting *TypePrinter,
1557                                  SlotTracker *Machine, const Module *Context) {
1558   Out << "!MDCompositeType(";
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 writeMDSubroutineType(raw_ostream &Out, const MDSubroutineType *N,
1580                                   TypePrinting *TypePrinter,
1581                                   SlotTracker *Machine, const Module *Context) {
1582   Out << "!MDSubroutineType(";
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 writeMDFile(raw_ostream &Out, const MDFile *N, TypePrinting *,
1591                         SlotTracker *, const Module *) {
1592   Out << "!MDFile(";
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 writeMDCompileUnit(raw_ostream &Out, const MDCompileUnit *N,
1602                                TypePrinting *TypePrinter, SlotTracker *Machine,
1603                                const Module *Context) {
1604   Out << "!MDCompileUnit(";
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   Out << ")";
1623 }
1624
1625 static void writeMDSubprogram(raw_ostream &Out, const MDSubprogram *N,
1626                               TypePrinting *TypePrinter, SlotTracker *Machine,
1627                               const Module *Context) {
1628   Out << "!MDSubprogram(";
1629   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1630   Printer.printString("name", N->getName());
1631   Printer.printString("linkageName", N->getLinkageName());
1632   Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1633   Printer.printMetadata("file", N->getFile());
1634   Printer.printInt("line", N->getLine());
1635   Printer.printMetadata("type", N->getType());
1636   Printer.printBool("isLocal", N->isLocalToUnit());
1637   Printer.printBool("isDefinition", N->isDefinition());
1638   Printer.printInt("scopeLine", N->getScopeLine());
1639   Printer.printMetadata("containingType", N->getContainingType());
1640   Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1641                          dwarf::VirtualityString);
1642   Printer.printInt("virtualIndex", N->getVirtualIndex());
1643   Printer.printDIFlags("flags", N->getFlags());
1644   Printer.printBool("isOptimized", N->isOptimized());
1645   Printer.printMetadata("function", N->getFunction());
1646   Printer.printMetadata("templateParams", N->getTemplateParams());
1647   Printer.printMetadata("declaration", N->getDeclaration());
1648   Printer.printMetadata("variables", N->getVariables());
1649   Out << ")";
1650 }
1651
1652 static void writeMDLexicalBlock(raw_ostream &Out, const MDLexicalBlock *N,
1653                               TypePrinting *TypePrinter, SlotTracker *Machine,
1654                               const Module *Context) {
1655   Out << "!MDLexicalBlock(";
1656   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1657   Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1658   Printer.printMetadata("file", N->getFile());
1659   Printer.printInt("line", N->getLine());
1660   Printer.printInt("column", N->getColumn());
1661   Out << ")";
1662 }
1663
1664 static void writeMDLexicalBlockFile(raw_ostream &Out,
1665                                     const MDLexicalBlockFile *N,
1666                                     TypePrinting *TypePrinter,
1667                                     SlotTracker *Machine,
1668                                     const Module *Context) {
1669   Out << "!MDLexicalBlockFile(";
1670   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1671   Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1672   Printer.printMetadata("file", N->getFile());
1673   Printer.printInt("discriminator", N->getDiscriminator(),
1674                    /* ShouldSkipZero */ false);
1675   Out << ")";
1676 }
1677
1678 static void writeMDNamespace(raw_ostream &Out, const MDNamespace *N,
1679                              TypePrinting *TypePrinter, SlotTracker *Machine,
1680                              const Module *Context) {
1681   Out << "!MDNamespace(";
1682   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1683   Printer.printString("name", N->getName());
1684   Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1685   Printer.printMetadata("file", N->getFile());
1686   Printer.printInt("line", N->getLine());
1687   Out << ")";
1688 }
1689
1690 static void writeMDTemplateTypeParameter(raw_ostream &Out,
1691                                          const MDTemplateTypeParameter *N,
1692                                          TypePrinting *TypePrinter,
1693                                          SlotTracker *Machine,
1694                                          const Module *Context) {
1695   Out << "!MDTemplateTypeParameter(";
1696   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1697   Printer.printString("name", N->getName());
1698   Printer.printMetadata("type", N->getType(), /* ShouldSkipNull */ false);
1699   Out << ")";
1700 }
1701
1702 static void writeMDTemplateValueParameter(raw_ostream &Out,
1703                                           const MDTemplateValueParameter *N,
1704                                           TypePrinting *TypePrinter,
1705                                           SlotTracker *Machine,
1706                                           const Module *Context) {
1707   Out << "!MDTemplateValueParameter(";
1708   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1709   if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1710     Printer.printTag(N);
1711   Printer.printString("name", N->getName());
1712   Printer.printMetadata("type", N->getType());
1713   Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1714   Out << ")";
1715 }
1716
1717 static void writeMDGlobalVariable(raw_ostream &Out, const MDGlobalVariable *N,
1718                                   TypePrinting *TypePrinter,
1719                                   SlotTracker *Machine, const Module *Context) {
1720   Out << "!MDGlobalVariable(";
1721   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1722   Printer.printString("name", N->getName());
1723   Printer.printString("linkageName", N->getLinkageName());
1724   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1725   Printer.printMetadata("file", N->getRawFile());
1726   Printer.printInt("line", N->getLine());
1727   Printer.printMetadata("type", N->getRawType());
1728   Printer.printBool("isLocal", N->isLocalToUnit());
1729   Printer.printBool("isDefinition", N->isDefinition());
1730   Printer.printMetadata("variable", N->getRawVariable());
1731   Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
1732   Out << ")";
1733 }
1734
1735 static void writeMDLocalVariable(raw_ostream &Out, const MDLocalVariable *N,
1736                                  TypePrinting *TypePrinter,
1737                                  SlotTracker *Machine, const Module *Context) {
1738   Out << "!MDLocalVariable(";
1739   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1740   Printer.printTag(N);
1741   Printer.printString("name", N->getName());
1742   Printer.printInt("arg", N->getArg(),
1743                    /* ShouldSkipZero */
1744                    N->getTag() == dwarf::DW_TAG_auto_variable);
1745   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1746   Printer.printMetadata("file", N->getRawFile());
1747   Printer.printInt("line", N->getLine());
1748   Printer.printMetadata("type", N->getRawType());
1749   Printer.printDIFlags("flags", N->getFlags());
1750   Printer.printMetadata("inlinedAt", N->getRawInlinedAt());
1751   Out << ")";
1752 }
1753
1754 static void writeMDExpression(raw_ostream &Out, const MDExpression *N,
1755                               TypePrinting *TypePrinter, SlotTracker *Machine,
1756                               const Module *Context) {
1757   Out << "!MDExpression(";
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 writeMDObjCProperty(raw_ostream &Out, const MDObjCProperty *N,
1776                                 TypePrinting *TypePrinter, SlotTracker *Machine,
1777                                 const Module *Context) {
1778   Out << "!MDObjCProperty(";
1779   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1780   Printer.printString("name", N->getName());
1781   Printer.printMetadata("file", N->getFile());
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->getType());
1787   Out << ")";
1788 }
1789
1790 static void writeMDImportedEntity(raw_ostream &Out, const MDImportedEntity *N,
1791                                   TypePrinting *TypePrinter,
1792                                   SlotTracker *Machine, const Module *Context) {
1793   Out << "!MDImportedEntity(";
1794   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1795   Printer.printTag(N);
1796   Printer.printString("name", N->getName());
1797   Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1798   Printer.printMetadata("entity", N->getEntity());
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   UseListOrderStack UseListOrders;
1948
1949 public:
1950   /// Construct an AssemblyWriter with an external SlotTracker
1951   AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1952                  const Module *M, AssemblyAnnotationWriter *AAW);
1953
1954   /// Construct an AssemblyWriter with an internally allocated SlotTracker
1955   AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1956                  AssemblyAnnotationWriter *AAW);
1957
1958   void printMDNodeBody(const MDNode *MD);
1959   void printNamedMDNode(const NamedMDNode *NMD);
1960
1961   void printModule(const Module *M);
1962
1963   void writeOperand(const Value *Op, bool PrintType);
1964   void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
1965   void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
1966   void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1967                           AtomicOrdering FailureOrdering,
1968                           SynchronizationScope SynchScope);
1969
1970   void writeAllMDNodes();
1971   void writeMDNode(unsigned Slot, const MDNode *Node);
1972   void writeAllAttributeGroups();
1973
1974   void printTypeIdentities();
1975   void printGlobal(const GlobalVariable *GV);
1976   void printAlias(const GlobalAlias *GV);
1977   void printComdat(const Comdat *C);
1978   void printFunction(const Function *F);
1979   void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
1980   void printBasicBlock(const BasicBlock *BB);
1981   void printInstructionLine(const Instruction &I);
1982   void printInstruction(const Instruction &I);
1983
1984   void printUseListOrder(const UseListOrder &Order);
1985   void printUseLists(const Function *F);
1986
1987 private:
1988   void init();
1989
1990   // printInfoComment - Print a little comment after the instruction indicating
1991   // which slot it occupies.
1992   void printInfoComment(const Value &V);
1993 };
1994 } // namespace
1995
1996 void AssemblyWriter::init() {
1997   if (!TheModule)
1998     return;
1999   TypePrinter.incorporateTypes(*TheModule);
2000   for (const Function &F : *TheModule)
2001     if (const Comdat *C = F.getComdat())
2002       Comdats.insert(C);
2003   for (const GlobalVariable &GV : TheModule->globals())
2004     if (const Comdat *C = GV.getComdat())
2005       Comdats.insert(C);
2006 }
2007
2008
2009 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2010                                const Module *M,
2011                                AssemblyAnnotationWriter *AAW)
2012   : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
2013   init();
2014 }
2015
2016 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2017                                AssemblyAnnotationWriter *AAW)
2018   : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
2019     Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
2020   init();
2021 }
2022
2023 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2024   if (!Operand) {
2025     Out << "<null operand!>";
2026     return;
2027   }
2028   if (PrintType) {
2029     TypePrinter.print(Operand->getType(), Out);
2030     Out << ' ';
2031   }
2032   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2033 }
2034
2035 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2036                                  SynchronizationScope SynchScope) {
2037   if (Ordering == NotAtomic)
2038     return;
2039
2040   switch (SynchScope) {
2041   case SingleThread: Out << " singlethread"; break;
2042   case CrossThread: break;
2043   }
2044
2045   switch (Ordering) {
2046   default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2047   case Unordered: Out << " unordered"; break;
2048   case Monotonic: Out << " monotonic"; break;
2049   case Acquire: Out << " acquire"; break;
2050   case Release: Out << " release"; break;
2051   case AcquireRelease: Out << " acq_rel"; break;
2052   case SequentiallyConsistent: Out << " seq_cst"; break;
2053   }
2054 }
2055
2056 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2057                                         AtomicOrdering FailureOrdering,
2058                                         SynchronizationScope SynchScope) {
2059   assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2060
2061   switch (SynchScope) {
2062   case SingleThread: Out << " singlethread"; break;
2063   case CrossThread: break;
2064   }
2065
2066   switch (SuccessOrdering) {
2067   default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2068   case Unordered: Out << " unordered"; break;
2069   case Monotonic: Out << " monotonic"; break;
2070   case Acquire: Out << " acquire"; break;
2071   case Release: Out << " release"; break;
2072   case AcquireRelease: Out << " acq_rel"; break;
2073   case SequentiallyConsistent: Out << " seq_cst"; break;
2074   }
2075
2076   switch (FailureOrdering) {
2077   default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2078   case Unordered: Out << " unordered"; break;
2079   case Monotonic: Out << " monotonic"; break;
2080   case Acquire: Out << " acquire"; break;
2081   case Release: Out << " release"; break;
2082   case AcquireRelease: Out << " acq_rel"; break;
2083   case SequentiallyConsistent: Out << " seq_cst"; break;
2084   }
2085 }
2086
2087 void AssemblyWriter::writeParamOperand(const Value *Operand,
2088                                        AttributeSet Attrs, unsigned Idx) {
2089   if (!Operand) {
2090     Out << "<null operand!>";
2091     return;
2092   }
2093
2094   // Print the type
2095   TypePrinter.print(Operand->getType(), Out);
2096   // Print parameter attributes list
2097   if (Attrs.hasAttributes(Idx))
2098     Out << ' ' << Attrs.getAsString(Idx);
2099   Out << ' ';
2100   // Print the operand
2101   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2102 }
2103
2104 void AssemblyWriter::printModule(const Module *M) {
2105   Machine.initialize();
2106
2107   if (shouldPreserveAssemblyUseListOrder())
2108     UseListOrders = predictUseListOrder(M);
2109
2110   if (!M->getModuleIdentifier().empty() &&
2111       // Don't print the ID if it will start a new line (which would
2112       // require a comment char before it).
2113       M->getModuleIdentifier().find('\n') == std::string::npos)
2114     Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2115
2116   const std::string &DL = M->getDataLayoutStr();
2117   if (!DL.empty())
2118     Out << "target datalayout = \"" << DL << "\"\n";
2119   if (!M->getTargetTriple().empty())
2120     Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2121
2122   if (!M->getModuleInlineAsm().empty()) {
2123     // Split the string into lines, to make it easier to read the .ll file.
2124     std::string Asm = M->getModuleInlineAsm();
2125     size_t CurPos = 0;
2126     size_t NewLine = Asm.find_first_of('\n', CurPos);
2127     Out << '\n';
2128     while (NewLine != std::string::npos) {
2129       // We found a newline, print the portion of the asm string from the
2130       // last newline up to this newline.
2131       Out << "module asm \"";
2132       PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
2133                          Out);
2134       Out << "\"\n";
2135       CurPos = NewLine+1;
2136       NewLine = Asm.find_first_of('\n', CurPos);
2137     }
2138     std::string rest(Asm.begin()+CurPos, Asm.end());
2139     if (!rest.empty()) {
2140       Out << "module asm \"";
2141       PrintEscapedString(rest, Out);
2142       Out << "\"\n";
2143     }
2144   }
2145
2146   printTypeIdentities();
2147
2148   // Output all comdats.
2149   if (!Comdats.empty())
2150     Out << '\n';
2151   for (const Comdat *C : Comdats) {
2152     printComdat(C);
2153     if (C != Comdats.back())
2154       Out << '\n';
2155   }
2156
2157   // Output all globals.
2158   if (!M->global_empty()) Out << '\n';
2159   for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
2160        I != E; ++I) {
2161     printGlobal(I); Out << '\n';
2162   }
2163
2164   // Output all aliases.
2165   if (!M->alias_empty()) Out << "\n";
2166   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
2167        I != E; ++I)
2168     printAlias(I);
2169
2170   // Output global use-lists.
2171   printUseLists(nullptr);
2172
2173   // Output all of the functions.
2174   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
2175     printFunction(I);
2176   assert(UseListOrders.empty() && "All use-lists should have been consumed");
2177
2178   // Output all attribute groups.
2179   if (!Machine.as_empty()) {
2180     Out << '\n';
2181     writeAllAttributeGroups();
2182   }
2183
2184   // Output named metadata.
2185   if (!M->named_metadata_empty()) Out << '\n';
2186
2187   for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
2188        E = M->named_metadata_end(); I != E; ++I)
2189     printNamedMDNode(I);
2190
2191   // Output metadata.
2192   if (!Machine.mdn_empty()) {
2193     Out << '\n';
2194     writeAllMDNodes();
2195   }
2196 }
2197
2198 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2199   Out << '!';
2200   StringRef Name = NMD->getName();
2201   if (Name.empty()) {
2202     Out << "<empty name> ";
2203   } else {
2204     if (isalpha(static_cast<unsigned char>(Name[0])) ||
2205         Name[0] == '-' || Name[0] == '$' ||
2206         Name[0] == '.' || Name[0] == '_')
2207       Out << Name[0];
2208     else
2209       Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2210     for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2211       unsigned char C = Name[i];
2212       if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2213           C == '.' || C == '_')
2214         Out << C;
2215       else
2216         Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2217     }
2218   }
2219   Out << " = !{";
2220   for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2221     if (i) Out << ", ";
2222     int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2223     if (Slot == -1)
2224       Out << "<badref>";
2225     else
2226       Out << '!' << Slot;
2227   }
2228   Out << "}\n";
2229 }
2230
2231
2232 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2233                          formatted_raw_ostream &Out) {
2234   switch (LT) {
2235   case GlobalValue::ExternalLinkage: break;
2236   case GlobalValue::PrivateLinkage:       Out << "private ";        break;
2237   case GlobalValue::InternalLinkage:      Out << "internal ";       break;
2238   case GlobalValue::LinkOnceAnyLinkage:   Out << "linkonce ";       break;
2239   case GlobalValue::LinkOnceODRLinkage:   Out << "linkonce_odr ";   break;
2240   case GlobalValue::WeakAnyLinkage:       Out << "weak ";           break;
2241   case GlobalValue::WeakODRLinkage:       Out << "weak_odr ";       break;
2242   case GlobalValue::CommonLinkage:        Out << "common ";         break;
2243   case GlobalValue::AppendingLinkage:     Out << "appending ";      break;
2244   case GlobalValue::ExternalWeakLinkage:  Out << "extern_weak ";    break;
2245   case GlobalValue::AvailableExternallyLinkage:
2246     Out << "available_externally ";
2247     break;
2248   }
2249 }
2250
2251
2252 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2253                             formatted_raw_ostream &Out) {
2254   switch (Vis) {
2255   case GlobalValue::DefaultVisibility: break;
2256   case GlobalValue::HiddenVisibility:    Out << "hidden "; break;
2257   case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2258   }
2259 }
2260
2261 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2262                                  formatted_raw_ostream &Out) {
2263   switch (SCT) {
2264   case GlobalValue::DefaultStorageClass: break;
2265   case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2266   case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2267   }
2268 }
2269
2270 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2271                                   formatted_raw_ostream &Out) {
2272   switch (TLM) {
2273     case GlobalVariable::NotThreadLocal:
2274       break;
2275     case GlobalVariable::GeneralDynamicTLSModel:
2276       Out << "thread_local ";
2277       break;
2278     case GlobalVariable::LocalDynamicTLSModel:
2279       Out << "thread_local(localdynamic) ";
2280       break;
2281     case GlobalVariable::InitialExecTLSModel:
2282       Out << "thread_local(initialexec) ";
2283       break;
2284     case GlobalVariable::LocalExecTLSModel:
2285       Out << "thread_local(localexec) ";
2286       break;
2287   }
2288 }
2289
2290 static void maybePrintComdat(formatted_raw_ostream &Out,
2291                              const GlobalObject &GO) {
2292   const Comdat *C = GO.getComdat();
2293   if (!C)
2294     return;
2295
2296   if (isa<GlobalVariable>(GO))
2297     Out << ',';
2298   Out << " comdat";
2299
2300   if (GO.getName() == C->getName())
2301     return;
2302
2303   Out << '(';
2304   PrintLLVMName(Out, C->getName(), ComdatPrefix);
2305   Out << ')';
2306 }
2307
2308 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2309   if (GV->isMaterializable())
2310     Out << "; Materializable\n";
2311
2312   WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2313   Out << " = ";
2314
2315   if (!GV->hasInitializer() && GV->hasExternalLinkage())
2316     Out << "external ";
2317
2318   PrintLinkage(GV->getLinkage(), Out);
2319   PrintVisibility(GV->getVisibility(), Out);
2320   PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2321   PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2322   if (GV->hasUnnamedAddr())
2323     Out << "unnamed_addr ";
2324
2325   if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2326     Out << "addrspace(" << AddressSpace << ") ";
2327   if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2328   Out << (GV->isConstant() ? "constant " : "global ");
2329   TypePrinter.print(GV->getType()->getElementType(), Out);
2330
2331   if (GV->hasInitializer()) {
2332     Out << ' ';
2333     writeOperand(GV->getInitializer(), false);
2334   }
2335
2336   if (GV->hasSection()) {
2337     Out << ", section \"";
2338     PrintEscapedString(GV->getSection(), Out);
2339     Out << '"';
2340   }
2341   maybePrintComdat(Out, *GV);
2342   if (GV->getAlignment())
2343     Out << ", align " << GV->getAlignment();
2344
2345   printInfoComment(*GV);
2346 }
2347
2348 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2349   if (GA->isMaterializable())
2350     Out << "; Materializable\n";
2351
2352   // Don't crash when dumping partially built GA
2353   if (!GA->hasName())
2354     Out << "<<nameless>> = ";
2355   else {
2356     PrintLLVMName(Out, GA);
2357     Out << " = ";
2358   }
2359   PrintLinkage(GA->getLinkage(), Out);
2360   PrintVisibility(GA->getVisibility(), Out);
2361   PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2362   PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2363   if (GA->hasUnnamedAddr())
2364     Out << "unnamed_addr ";
2365
2366   Out << "alias ";
2367
2368   const Constant *Aliasee = GA->getAliasee();
2369
2370   if (!Aliasee) {
2371     TypePrinter.print(GA->getType(), Out);
2372     Out << " <<NULL ALIASEE>>";
2373   } else {
2374     writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2375   }
2376
2377   printInfoComment(*GA);
2378   Out << '\n';
2379 }
2380
2381 void AssemblyWriter::printComdat(const Comdat *C) {
2382   C->print(Out);
2383 }
2384
2385 void AssemblyWriter::printTypeIdentities() {
2386   if (TypePrinter.NumberedTypes.empty() &&
2387       TypePrinter.NamedTypes.empty())
2388     return;
2389
2390   Out << '\n';
2391
2392   // We know all the numbers that each type is used and we know that it is a
2393   // dense assignment.  Convert the map to an index table.
2394   std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2395   for (DenseMap<StructType*, unsigned>::iterator I =
2396        TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2397        I != E; ++I) {
2398     assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2399     NumberedTypes[I->second] = I->first;
2400   }
2401
2402   // Emit all numbered types.
2403   for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2404     Out << '%' << i << " = type ";
2405
2406     // Make sure we print out at least one level of the type structure, so
2407     // that we do not get %2 = type %2
2408     TypePrinter.printStructBody(NumberedTypes[i], Out);
2409     Out << '\n';
2410   }
2411
2412   for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2413     PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2414     Out << " = type ";
2415
2416     // Make sure we print out at least one level of the type structure, so
2417     // that we do not get %FILE = type %FILE
2418     TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2419     Out << '\n';
2420   }
2421 }
2422
2423 /// printFunction - Print all aspects of a function.
2424 ///
2425 void AssemblyWriter::printFunction(const Function *F) {
2426   // Print out the return type and name.
2427   Out << '\n';
2428
2429   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2430
2431   if (F->isMaterializable())
2432     Out << "; Materializable\n";
2433
2434   const AttributeSet &Attrs = F->getAttributes();
2435   if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2436     AttributeSet AS = Attrs.getFnAttributes();
2437     std::string AttrStr;
2438
2439     unsigned Idx = 0;
2440     for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2441       if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2442         break;
2443
2444     for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2445          I != E; ++I) {
2446       Attribute Attr = *I;
2447       if (!Attr.isStringAttribute()) {
2448         if (!AttrStr.empty()) AttrStr += ' ';
2449         AttrStr += Attr.getAsString();
2450       }
2451     }
2452
2453     if (!AttrStr.empty())
2454       Out << "; Function Attrs: " << AttrStr << '\n';
2455   }
2456
2457   if (F->isDeclaration())
2458     Out << "declare ";
2459   else
2460     Out << "define ";
2461
2462   PrintLinkage(F->getLinkage(), Out);
2463   PrintVisibility(F->getVisibility(), Out);
2464   PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2465
2466   // Print the calling convention.
2467   if (F->getCallingConv() != CallingConv::C) {
2468     PrintCallingConv(F->getCallingConv(), Out);
2469     Out << " ";
2470   }
2471
2472   FunctionType *FT = F->getFunctionType();
2473   if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2474     Out <<  Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2475   TypePrinter.print(F->getReturnType(), Out);
2476   Out << ' ';
2477   WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2478   Out << '(';
2479   Machine.incorporateFunction(F);
2480
2481   // Loop over the arguments, printing them...
2482
2483   unsigned Idx = 1;
2484   if (!F->isDeclaration()) {
2485     // If this isn't a declaration, print the argument names as well.
2486     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2487          I != E; ++I) {
2488       // Insert commas as we go... the first arg doesn't get a comma
2489       if (I != F->arg_begin()) Out << ", ";
2490       printArgument(I, Attrs, Idx);
2491       Idx++;
2492     }
2493   } else {
2494     // Otherwise, print the types from the function type.
2495     for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2496       // Insert commas as we go... the first arg doesn't get a comma
2497       if (i) Out << ", ";
2498
2499       // Output type...
2500       TypePrinter.print(FT->getParamType(i), Out);
2501
2502       if (Attrs.hasAttributes(i+1))
2503         Out << ' ' << Attrs.getAsString(i+1);
2504     }
2505   }
2506
2507   // Finish printing arguments...
2508   if (FT->isVarArg()) {
2509     if (FT->getNumParams()) Out << ", ";
2510     Out << "...";  // Output varargs portion of signature!
2511   }
2512   Out << ')';
2513   if (F->hasUnnamedAddr())
2514     Out << " unnamed_addr";
2515   if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2516     Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2517   if (F->hasSection()) {
2518     Out << " section \"";
2519     PrintEscapedString(F->getSection(), Out);
2520     Out << '"';
2521   }
2522   maybePrintComdat(Out, *F);
2523   if (F->getAlignment())
2524     Out << " align " << F->getAlignment();
2525   if (F->hasGC())
2526     Out << " gc \"" << F->getGC() << '"';
2527   if (F->hasPrefixData()) {
2528     Out << " prefix ";
2529     writeOperand(F->getPrefixData(), true);
2530   }
2531   if (F->hasPrologueData()) {
2532     Out << " prologue ";
2533     writeOperand(F->getPrologueData(), true);
2534   }
2535
2536   if (F->isDeclaration()) {
2537     Out << '\n';
2538   } else {
2539     Out << " {";
2540     // Output all of the function's basic blocks.
2541     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2542       printBasicBlock(I);
2543
2544     // Output the function's use-lists.
2545     printUseLists(F);
2546
2547     Out << "}\n";
2548   }
2549
2550   Machine.purgeFunction();
2551 }
2552
2553 /// printArgument - This member is called for every argument that is passed into
2554 /// the function.  Simply print it out
2555 ///
2556 void AssemblyWriter::printArgument(const Argument *Arg,
2557                                    AttributeSet Attrs, unsigned Idx) {
2558   // Output type...
2559   TypePrinter.print(Arg->getType(), Out);
2560
2561   // Output parameter attributes list
2562   if (Attrs.hasAttributes(Idx))
2563     Out << ' ' << Attrs.getAsString(Idx);
2564
2565   // Output name, if available...
2566   if (Arg->hasName()) {
2567     Out << ' ';
2568     PrintLLVMName(Out, Arg);
2569   }
2570 }
2571
2572 /// printBasicBlock - This member is called for each basic block in a method.
2573 ///
2574 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2575   if (BB->hasName()) {              // Print out the label if it exists...
2576     Out << "\n";
2577     PrintLLVMName(Out, BB->getName(), LabelPrefix);
2578     Out << ':';
2579   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
2580     Out << "\n; <label>:";
2581     int Slot = Machine.getLocalSlot(BB);
2582     if (Slot != -1)
2583       Out << Slot;
2584     else
2585       Out << "<badref>";
2586   }
2587
2588   if (!BB->getParent()) {
2589     Out.PadToColumn(50);
2590     Out << "; Error: Block without parent!";
2591   } else if (BB != &BB->getParent()->getEntryBlock()) {  // Not the entry block?
2592     // Output predecessors for the block.
2593     Out.PadToColumn(50);
2594     Out << ";";
2595     const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2596
2597     if (PI == PE) {
2598       Out << " No predecessors!";
2599     } else {
2600       Out << " preds = ";
2601       writeOperand(*PI, false);
2602       for (++PI; PI != PE; ++PI) {
2603         Out << ", ";
2604         writeOperand(*PI, false);
2605       }
2606     }
2607   }
2608
2609   Out << "\n";
2610
2611   if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2612
2613   // Output all of the instructions in the basic block...
2614   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2615     printInstructionLine(*I);
2616   }
2617
2618   if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2619 }
2620
2621 /// printInstructionLine - Print an instruction and a newline character.
2622 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2623   printInstruction(I);
2624   Out << '\n';
2625 }
2626
2627 /// printInfoComment - Print a little comment after the instruction indicating
2628 /// which slot it occupies.
2629 ///
2630 void AssemblyWriter::printInfoComment(const Value &V) {
2631   if (AnnotationWriter)
2632     AnnotationWriter->printInfoComment(V, Out);
2633 }
2634
2635 // This member is called for each Instruction in a function..
2636 void AssemblyWriter::printInstruction(const Instruction &I) {
2637   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2638
2639   // Print out indentation for an instruction.
2640   Out << "  ";
2641
2642   // Print out name if it exists...
2643   if (I.hasName()) {
2644     PrintLLVMName(Out, &I);
2645     Out << " = ";
2646   } else if (!I.getType()->isVoidTy()) {
2647     // Print out the def slot taken.
2648     int SlotNum = Machine.getLocalSlot(&I);
2649     if (SlotNum == -1)
2650       Out << "<badref> = ";
2651     else
2652       Out << '%' << SlotNum << " = ";
2653   }
2654
2655   if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2656     if (CI->isMustTailCall())
2657       Out << "musttail ";
2658     else if (CI->isTailCall())
2659       Out << "tail ";
2660   }
2661
2662   // Print out the opcode...
2663   Out << I.getOpcodeName();
2664
2665   // If this is an atomic load or store, print out the atomic marker.
2666   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isAtomic()) ||
2667       (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2668     Out << " atomic";
2669
2670   if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2671     Out << " weak";
2672
2673   // If this is a volatile operation, print out the volatile marker.
2674   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
2675       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2676       (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2677       (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2678     Out << " volatile";
2679
2680   // Print out optimization information.
2681   WriteOptimizationInfo(Out, &I);
2682
2683   // Print out the compare instruction predicates
2684   if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2685     Out << ' ' << getPredicateText(CI->getPredicate());
2686
2687   // Print out the atomicrmw operation
2688   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2689     writeAtomicRMWOperation(Out, RMWI->getOperation());
2690
2691   // Print out the type of the operands...
2692   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2693
2694   // Special case conditional branches to swizzle the condition out to the front
2695   if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2696     const BranchInst &BI(cast<BranchInst>(I));
2697     Out << ' ';
2698     writeOperand(BI.getCondition(), true);
2699     Out << ", ";
2700     writeOperand(BI.getSuccessor(0), true);
2701     Out << ", ";
2702     writeOperand(BI.getSuccessor(1), true);
2703
2704   } else if (isa<SwitchInst>(I)) {
2705     const SwitchInst& SI(cast<SwitchInst>(I));
2706     // Special case switch instruction to get formatting nice and correct.
2707     Out << ' ';
2708     writeOperand(SI.getCondition(), true);
2709     Out << ", ";
2710     writeOperand(SI.getDefaultDest(), true);
2711     Out << " [";
2712     for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2713          i != e; ++i) {
2714       Out << "\n    ";
2715       writeOperand(i.getCaseValue(), true);
2716       Out << ", ";
2717       writeOperand(i.getCaseSuccessor(), true);
2718     }
2719     Out << "\n  ]";
2720   } else if (isa<IndirectBrInst>(I)) {
2721     // Special case indirectbr instruction to get formatting nice and correct.
2722     Out << ' ';
2723     writeOperand(Operand, true);
2724     Out << ", [";
2725
2726     for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2727       if (i != 1)
2728         Out << ", ";
2729       writeOperand(I.getOperand(i), true);
2730     }
2731     Out << ']';
2732   } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2733     Out << ' ';
2734     TypePrinter.print(I.getType(), Out);
2735     Out << ' ';
2736
2737     for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2738       if (op) Out << ", ";
2739       Out << "[ ";
2740       writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2741       writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2742     }
2743   } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2744     Out << ' ';
2745     writeOperand(I.getOperand(0), true);
2746     for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2747       Out << ", " << *i;
2748   } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2749     Out << ' ';
2750     writeOperand(I.getOperand(0), true); Out << ", ";
2751     writeOperand(I.getOperand(1), true);
2752     for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2753       Out << ", " << *i;
2754   } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2755     Out << ' ';
2756     TypePrinter.print(I.getType(), Out);
2757     Out << " personality ";
2758     writeOperand(I.getOperand(0), true); Out << '\n';
2759
2760     if (LPI->isCleanup())
2761       Out << "          cleanup";
2762
2763     for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2764       if (i != 0 || LPI->isCleanup()) Out << "\n";
2765       if (LPI->isCatch(i))
2766         Out << "          catch ";
2767       else
2768         Out << "          filter ";
2769
2770       writeOperand(LPI->getClause(i), true);
2771     }
2772   } else if (isa<ReturnInst>(I) && !Operand) {
2773     Out << " void";
2774   } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2775     // Print the calling convention being used.
2776     if (CI->getCallingConv() != CallingConv::C) {
2777       Out << " ";
2778       PrintCallingConv(CI->getCallingConv(), Out);
2779     }
2780
2781     Operand = CI->getCalledValue();
2782     PointerType *PTy = cast<PointerType>(Operand->getType());
2783     FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2784     Type *RetTy = FTy->getReturnType();
2785     const AttributeSet &PAL = CI->getAttributes();
2786
2787     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2788       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2789
2790     // If possible, print out the short form of the call instruction.  We can
2791     // only do this if the first argument is a pointer to a nonvararg function,
2792     // and if the return type is not a pointer to a function.
2793     //
2794     Out << ' ';
2795     if (!FTy->isVarArg() &&
2796         (!RetTy->isPointerTy() ||
2797          !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2798       TypePrinter.print(RetTy, Out);
2799       Out << ' ';
2800       writeOperand(Operand, false);
2801     } else {
2802       writeOperand(Operand, true);
2803     }
2804     Out << '(';
2805     for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2806       if (op > 0)
2807         Out << ", ";
2808       writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2809     }
2810
2811     // Emit an ellipsis if this is a musttail call in a vararg function.  This
2812     // is only to aid readability, musttail calls forward varargs by default.
2813     if (CI->isMustTailCall() && CI->getParent() &&
2814         CI->getParent()->getParent() &&
2815         CI->getParent()->getParent()->isVarArg())
2816       Out << ", ...";
2817
2818     Out << ')';
2819     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2820       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2821   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2822     Operand = II->getCalledValue();
2823     PointerType *PTy = cast<PointerType>(Operand->getType());
2824     FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2825     Type *RetTy = FTy->getReturnType();
2826     const AttributeSet &PAL = II->getAttributes();
2827
2828     // Print the calling convention being used.
2829     if (II->getCallingConv() != CallingConv::C) {
2830       Out << " ";
2831       PrintCallingConv(II->getCallingConv(), Out);
2832     }
2833
2834     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2835       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2836
2837     // If possible, print out the short form of the invoke instruction. We can
2838     // only do this if the first argument is a pointer to a nonvararg function,
2839     // and if the return type is not a pointer to a function.
2840     //
2841     Out << ' ';
2842     if (!FTy->isVarArg() &&
2843         (!RetTy->isPointerTy() ||
2844          !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2845       TypePrinter.print(RetTy, Out);
2846       Out << ' ';
2847       writeOperand(Operand, false);
2848     } else {
2849       writeOperand(Operand, true);
2850     }
2851     Out << '(';
2852     for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2853       if (op)
2854         Out << ", ";
2855       writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2856     }
2857
2858     Out << ')';
2859     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2860       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2861
2862     Out << "\n          to ";
2863     writeOperand(II->getNormalDest(), true);
2864     Out << " unwind ";
2865     writeOperand(II->getUnwindDest(), true);
2866
2867   } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2868     Out << ' ';
2869     if (AI->isUsedWithInAlloca())
2870       Out << "inalloca ";
2871     TypePrinter.print(AI->getAllocatedType(), Out);
2872
2873     // Explicitly write the array size if the code is broken, if it's an array
2874     // allocation, or if the type is not canonical for scalar allocations.  The
2875     // latter case prevents the type from mutating when round-tripping through
2876     // assembly.
2877     if (!AI->getArraySize() || AI->isArrayAllocation() ||
2878         !AI->getArraySize()->getType()->isIntegerTy(32)) {
2879       Out << ", ";
2880       writeOperand(AI->getArraySize(), true);
2881     }
2882     if (AI->getAlignment()) {
2883       Out << ", align " << AI->getAlignment();
2884     }
2885   } else if (isa<CastInst>(I)) {
2886     if (Operand) {
2887       Out << ' ';
2888       writeOperand(Operand, true);   // Work with broken code
2889     }
2890     Out << " to ";
2891     TypePrinter.print(I.getType(), Out);
2892   } else if (isa<VAArgInst>(I)) {
2893     if (Operand) {
2894       Out << ' ';
2895       writeOperand(Operand, true);   // Work with broken code
2896     }
2897     Out << ", ";
2898     TypePrinter.print(I.getType(), Out);
2899   } else if (Operand) {   // Print the normal way.
2900     if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
2901       Out << ' ';
2902       TypePrinter.print(GEP->getSourceElementType(), Out);
2903       Out << ',';
2904     } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
2905       Out << ' ';
2906       TypePrinter.print(LI->getType(), Out);
2907       Out << ',';
2908     }
2909
2910     // PrintAllTypes - Instructions who have operands of all the same type
2911     // omit the type from all but the first operand.  If the instruction has
2912     // different type operands (for example br), then they are all printed.
2913     bool PrintAllTypes = false;
2914     Type *TheType = Operand->getType();
2915
2916     // Select, Store and ShuffleVector always print all types.
2917     if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2918         || isa<ReturnInst>(I)) {
2919       PrintAllTypes = true;
2920     } else {
2921       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2922         Operand = I.getOperand(i);
2923         // note that Operand shouldn't be null, but the test helps make dump()
2924         // more tolerant of malformed IR
2925         if (Operand && Operand->getType() != TheType) {
2926           PrintAllTypes = true;    // We have differing types!  Print them all!
2927           break;
2928         }
2929       }
2930     }
2931
2932     if (!PrintAllTypes) {
2933       Out << ' ';
2934       TypePrinter.print(TheType, Out);
2935     }
2936
2937     Out << ' ';
2938     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2939       if (i) Out << ", ";
2940       writeOperand(I.getOperand(i), PrintAllTypes);
2941     }
2942   }
2943
2944   // Print atomic ordering/alignment for memory operations
2945   if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2946     if (LI->isAtomic())
2947       writeAtomic(LI->getOrdering(), LI->getSynchScope());
2948     if (LI->getAlignment())
2949       Out << ", align " << LI->getAlignment();
2950   } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2951     if (SI->isAtomic())
2952       writeAtomic(SI->getOrdering(), SI->getSynchScope());
2953     if (SI->getAlignment())
2954       Out << ", align " << SI->getAlignment();
2955   } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2956     writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2957                        CXI->getSynchScope());
2958   } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2959     writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2960   } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2961     writeAtomic(FI->getOrdering(), FI->getSynchScope());
2962   }
2963
2964   // Print Metadata info.
2965   SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2966   I.getAllMetadata(InstMD);
2967   if (!InstMD.empty()) {
2968     SmallVector<StringRef, 8> MDNames;
2969     I.getType()->getContext().getMDKindNames(MDNames);
2970     for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2971       unsigned Kind = InstMD[i].first;
2972        if (Kind < MDNames.size()) {
2973          Out << ", !" << MDNames[Kind];
2974        } else {
2975          Out << ", !<unknown kind #" << Kind << ">";
2976        }
2977       Out << ' ';
2978       WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2979                              TheModule);
2980     }
2981   }
2982   printInfoComment(I);
2983 }
2984
2985 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2986   Out << '!' << Slot << " = ";
2987   printMDNodeBody(Node);
2988   Out << "\n";
2989 }
2990
2991 void AssemblyWriter::writeAllMDNodes() {
2992   SmallVector<const MDNode *, 16> Nodes;
2993   Nodes.resize(Machine.mdn_size());
2994   for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2995        I != E; ++I)
2996     Nodes[I->second] = cast<MDNode>(I->first);
2997
2998   for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2999     writeMDNode(i, Nodes[i]);
3000   }
3001 }
3002
3003 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3004   WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3005 }
3006
3007 void AssemblyWriter::writeAllAttributeGroups() {
3008   std::vector<std::pair<AttributeSet, unsigned> > asVec;
3009   asVec.resize(Machine.as_size());
3010
3011   for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3012        I != E; ++I)
3013     asVec[I->second] = *I;
3014
3015   for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3016          I = asVec.begin(), E = asVec.end(); I != E; ++I)
3017     Out << "attributes #" << I->second << " = { "
3018         << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3019 }
3020
3021 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3022   bool IsInFunction = Machine.getFunction();
3023   if (IsInFunction)
3024     Out << "  ";
3025
3026   Out << "uselistorder";
3027   if (const BasicBlock *BB =
3028           IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3029     Out << "_bb ";
3030     writeOperand(BB->getParent(), false);
3031     Out << ", ";
3032     writeOperand(BB, false);
3033   } else {
3034     Out << " ";
3035     writeOperand(Order.V, true);
3036   }
3037   Out << ", { ";
3038
3039   assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3040   Out << Order.Shuffle[0];
3041   for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3042     Out << ", " << Order.Shuffle[I];
3043   Out << " }\n";
3044 }
3045
3046 void AssemblyWriter::printUseLists(const Function *F) {
3047   auto hasMore =
3048       [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3049   if (!hasMore())
3050     // Nothing to do.
3051     return;
3052
3053   Out << "\n; uselistorder directives\n";
3054   while (hasMore()) {
3055     printUseListOrder(UseListOrders.back());
3056     UseListOrders.pop_back();
3057   }
3058 }
3059
3060 //===----------------------------------------------------------------------===//
3061 //                       External Interface declarations
3062 //===----------------------------------------------------------------------===//
3063
3064 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3065   SlotTracker SlotTable(this);
3066   formatted_raw_ostream OS(ROS);
3067   AssemblyWriter W(OS, SlotTable, this, AAW);
3068   W.printModule(this);
3069 }
3070
3071 void NamedMDNode::print(raw_ostream &ROS) const {
3072   SlotTracker SlotTable(getParent());
3073   formatted_raw_ostream OS(ROS);
3074   AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3075   W.printNamedMDNode(this);
3076 }
3077
3078 void Comdat::print(raw_ostream &ROS) const {
3079   PrintLLVMName(ROS, getName(), ComdatPrefix);
3080   ROS << " = comdat ";
3081
3082   switch (getSelectionKind()) {
3083   case Comdat::Any:
3084     ROS << "any";
3085     break;
3086   case Comdat::ExactMatch:
3087     ROS << "exactmatch";
3088     break;
3089   case Comdat::Largest:
3090     ROS << "largest";
3091     break;
3092   case Comdat::NoDuplicates:
3093     ROS << "noduplicates";
3094     break;
3095   case Comdat::SameSize:
3096     ROS << "samesize";
3097     break;
3098   }
3099
3100   ROS << '\n';
3101 }
3102
3103 void Type::print(raw_ostream &OS) const {
3104   TypePrinting TP;
3105   TP.print(const_cast<Type*>(this), OS);
3106
3107   // If the type is a named struct type, print the body as well.
3108   if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3109     if (!STy->isLiteral()) {
3110       OS << " = type ";
3111       TP.printStructBody(STy, OS);
3112     }
3113 }
3114
3115 static bool isReferencingMDNode(const Instruction &I) {
3116   if (const auto *CI = dyn_cast<CallInst>(&I))
3117     if (Function *F = CI->getCalledFunction())
3118       if (F->isIntrinsic())
3119         for (auto &Op : I.operands())
3120           if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3121             if (isa<MDNode>(V->getMetadata()))
3122               return true;
3123   return false;
3124 }
3125
3126 void Value::print(raw_ostream &ROS) const {
3127   formatted_raw_ostream OS(ROS);
3128   if (const Instruction *I = dyn_cast<Instruction>(this)) {
3129     const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3130     SlotTracker SlotTable(
3131         F,
3132         /* ShouldInitializeAllMetadata */ isReferencingMDNode(*I));
3133     AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3134     W.printInstruction(*I);
3135   } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3136     SlotTracker SlotTable(BB->getParent());
3137     AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3138     W.printBasicBlock(BB);
3139   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3140     SlotTracker SlotTable(GV->getParent(),
3141                           /* ShouldInitializeAllMetadata */ isa<Function>(GV));
3142     AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3143     if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3144       W.printGlobal(V);
3145     else if (const Function *F = dyn_cast<Function>(GV))
3146       W.printFunction(F);
3147     else
3148       W.printAlias(cast<GlobalAlias>(GV));
3149   } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3150     V->getMetadata()->print(ROS, getModuleFromVal(V));
3151   } else if (const Constant *C = dyn_cast<Constant>(this)) {
3152     TypePrinting TypePrinter;
3153     TypePrinter.print(C->getType(), OS);
3154     OS << ' ';
3155     WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3156   } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3157     this->printAsOperand(OS);
3158   } else {
3159     llvm_unreachable("Unknown value to print out!");
3160   }
3161 }
3162
3163 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
3164   // Fast path: Don't construct and populate a TypePrinting object if we
3165   // won't be needing any types printed.
3166   bool IsMetadata = isa<MetadataAsValue>(this);
3167   if (!PrintType && ((!isa<Constant>(this) && !IsMetadata) || hasName() ||
3168                      isa<GlobalValue>(this))) {
3169     WriteAsOperandInternal(O, this, nullptr, nullptr, M);
3170     return;
3171   }
3172
3173   if (!M)
3174     M = getModuleFromVal(this);
3175
3176   TypePrinting TypePrinter;
3177   if (M)
3178     TypePrinter.incorporateTypes(*M);
3179   if (PrintType) {
3180     TypePrinter.print(getType(), O);
3181     O << ' ';
3182   }
3183
3184   SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ IsMetadata);
3185   WriteAsOperandInternal(O, this, &TypePrinter, &Machine, M);
3186 }
3187
3188 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3189                               const Module *M, bool OnlyAsOperand) {
3190   formatted_raw_ostream OS(ROS);
3191
3192   auto *N = dyn_cast<MDNode>(&MD);
3193   TypePrinting TypePrinter;
3194   SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ N);
3195   if (M)
3196     TypePrinter.incorporateTypes(*M);
3197
3198   WriteAsOperandInternal(OS, &MD, &TypePrinter, &Machine, M,
3199                          /* FromValue */ true);
3200   if (OnlyAsOperand || !N)
3201     return;
3202
3203   OS << " = ";
3204   WriteMDNodeBodyInternal(OS, N, &TypePrinter, &Machine, M);
3205 }
3206
3207 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3208   printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ true);
3209 }
3210
3211 void Metadata::print(raw_ostream &OS, const Module *M) const {
3212   printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ false);
3213 }
3214
3215 // Value::dump - allow easy printing of Values from the debugger.
3216 LLVM_DUMP_METHOD
3217 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3218
3219 // Type::dump - allow easy printing of Types from the debugger.
3220 LLVM_DUMP_METHOD
3221 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3222
3223 // Module::dump() - Allow printing of Modules from the debugger.
3224 LLVM_DUMP_METHOD
3225 void Module::dump() const { print(dbgs(), nullptr); }
3226
3227 // \brief Allow printing of Comdats from the debugger.
3228 LLVM_DUMP_METHOD
3229 void Comdat::dump() const { print(dbgs()); }
3230
3231 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3232 LLVM_DUMP_METHOD
3233 void NamedMDNode::dump() const { print(dbgs()); }
3234
3235 LLVM_DUMP_METHOD
3236 void Metadata::dump() const { dump(nullptr); }
3237
3238 LLVM_DUMP_METHOD
3239 void Metadata::dump(const Module *M) const {
3240   print(dbgs(), M);
3241   dbgs() << '\n';
3242 }