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