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 "AsmWriter.h"
  18 #include "llvm/ADT/DenseMap.h"
  19 #include "llvm/ADT/STLExtras.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/ValueSymbolTable.h"
  36 #include "llvm/Support/Debug.h"
  37 #include "llvm/Support/Dwarf.h"
  38 #include "llvm/Support/ErrorHandling.h"
  39 #include "llvm/Support/FormattedStream.h"
  40 #include "llvm/Support/MathExtras.h"
  41 #include <algorithm>
  42 #include <cctype>
  43 using namespace llvm;
  44
  45 // Make virtual table appear in this compilation unit.
  46 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
  47
  48 //===----------------------------------------------------------------------===//
  49 // Helper Functions
  50 //===----------------------------------------------------------------------===//
  51
  52 namespace {
  53 struct OrderMap {
  54   DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
  55
  56   unsigned size() const { return IDs.size(); }
  57   std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
  58   std::pair<unsigned, bool> lookup(const Value *V) const {
  59     return IDs.lookup(V);
  60   }
  61   void index(const Value *V) {
  62     // Explicitly sequence get-size and insert-value operations to avoid UB.
  63     unsigned ID = IDs.size() + 1;
  64     IDs[V].first = ID;
  65   }
  66 };
  67 }
  68
  69 static void orderValue(const Value *V, OrderMap &OM) {
  70   if (OM.lookup(V).first)
  71     return;
  72
  73   if (const Constant *C = dyn_cast<Constant>(V))
  74     if (C->getNumOperands() && !isa<GlobalValue>(C))
  75       for (const Value *Op : C->operands())
  76         if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
  77           orderValue(Op, OM);
  78
  79   // Note: we cannot cache this lookup above, since inserting into the map
  80   // changes the map's size, and thus affects the other IDs.
  81   OM.index(V);
  82 }
  83
  84 static OrderMap orderModule(const Module *M) {
  85   // This needs to match the order used by ValueEnumerator::ValueEnumerator()
  86   // and ValueEnumerator::incorporateFunction().
  87   OrderMap OM;
  88
  89   for (const GlobalVariable &G : M->globals()) {
  90     if (G.hasInitializer())
  91       if (!isa<GlobalValue>(G.getInitializer()))
  92         orderValue(G.getInitializer(), OM);
  93     orderValue(&G, OM);
  94   }
  95   for (const GlobalAlias &A : M->aliases()) {
  96     if (!isa<GlobalValue>(A.getAliasee()))
  97       orderValue(A.getAliasee(), OM);
  98     orderValue(&A, OM);
  99   }
 100   for (const Function &F : *M) {
 101     if (F.hasPrefixData())
 102       if (!isa<GlobalValue>(F.getPrefixData()))
 103         orderValue(F.getPrefixData(), OM);
 104     orderValue(&F, OM);
 105
 106     if (F.isDeclaration())
 107       continue;
 108
 109     for (const Argument &A : F.args())
 110       orderValue(&A, OM);
 111     for (const BasicBlock &BB : F) {
 112       orderValue(&BB, OM);
 113       for (const Instruction &I : BB) {
 114         for (const Value *Op : I.operands())
 115           if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
 116               isa<InlineAsm>(*Op))
 117             orderValue(Op, OM);
 118         orderValue(&I, OM);
 119       }
 120     }
 121   }
 122   return OM;
 123 }
 124
 125 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
 126                                          unsigned ID, const OrderMap &OM,
 127                                          UseListOrderStack &Stack) {
 128   // Predict use-list order for this one.
 129   typedef std::pair<const Use *, unsigned> Entry;
 130   SmallVector<Entry, 64> List;
 131   for (const Use &U : V->uses())
 132     // Check if this user will be serialized.
 133     if (OM.lookup(U.getUser()).first)
 134       List.push_back(std::make_pair(&U, List.size()));
 135
 136   if (List.size() < 2)
 137     // We may have lost some users.
 138     return;
 139
 140   bool GetsReversed =
 141       !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
 142   if (auto *BA = dyn_cast<BlockAddress>(V))
 143     ID = OM.lookup(BA->getBasicBlock()).first;
 144   std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
 145     const Use *LU = L.first;
 146     const Use *RU = R.first;
 147     if (LU == RU)
 148       return false;
 149
 150     auto LID = OM.lookup(LU->getUser()).first;
 151     auto RID = OM.lookup(RU->getUser()).first;
 152
 153     // If ID is 4, then expect: 7 6 5 1 2 3.
 154     if (LID < RID) {
 155       if (GetsReversed)
 156         if (RID <= ID)
 157           return true;
 158       return false;
 159     }
 160     if (RID < LID) {
 161       if (GetsReversed)
 162         if (LID <= ID)
 163           return false;
 164       return true;
 165     }
 166
 167     // LID and RID are equal, so we have different operands of the same user.
 168     // Assume operands are added in order for all instructions.
 169     if (GetsReversed)
 170       if (LID <= ID)
 171         return LU->getOperandNo() < RU->getOperandNo();
 172     return LU->getOperandNo() > RU->getOperandNo();
 173   });
 174
 175   if (std::is_sorted(
 176           List.begin(), List.end(),
 177           [](const Entry &L, const Entry &R) { return L.second < R.second; }))
 178     // Order is already correct.
 179     return;
 180
 181   // Store the shuffle.
 182   Stack.emplace_back(V, F, List.size());
 183   assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
 184   for (size_t I = 0, E = List.size(); I != E; ++I)
 185     Stack.back().Shuffle[I] = List[I].second;
 186 }
 187
 188 static void predictValueUseListOrder(const Value *V, const Function *F,
 189                                      OrderMap &OM, UseListOrderStack &Stack) {
 190   auto &IDPair = OM[V];
 191   assert(IDPair.first && "Unmapped value");
 192   if (IDPair.second)
 193     // Already predicted.
 194     return;
 195
 196   // Do the actual prediction.
 197   IDPair.second = true;
 198   if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
 199     predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
 200
 201   // Recursive descent into constants.
 202   if (const Constant *C = dyn_cast<Constant>(V))
 203     if (C->getNumOperands()) // Visit GlobalValues.
 204       for (const Value *Op : C->operands())
 205         if (isa<Constant>(Op)) // Visit GlobalValues.
 206           predictValueUseListOrder(Op, F, OM, Stack);
 207 }
 208
 209 static UseListOrderStack predictUseListOrder(const Module *M) {
 210   OrderMap OM = orderModule(M);
 211
 212   // Use-list orders need to be serialized after all the users have been added
 213   // to a value, or else the shuffles will be incomplete.  Store them per
 214   // function in a stack.
 215   //
 216   // Aside from function order, the order of values doesn't matter much here.
 217   UseListOrderStack Stack;
 218
 219   // We want to visit the functions backward now so we can list function-local
 220   // constants in the last Function they're used in.  Module-level constants
 221   // have already been visited above.
 222   for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
 223     const Function &F = *I;
 224     if (F.isDeclaration())
 225       continue;
 226     for (const BasicBlock &BB : F)
 227       predictValueUseListOrder(&BB, &F, OM, Stack);
 228     for (const Argument &A : F.args())
 229       predictValueUseListOrder(&A, &F, OM, Stack);
 230     for (const BasicBlock &BB : F)
 231       for (const Instruction &I : BB)
 232         for (const Value *Op : I.operands())
 233           if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
 234             predictValueUseListOrder(Op, &F, OM, Stack);
 235     for (const BasicBlock &BB : F)
 236       for (const Instruction &I : BB)
 237         predictValueUseListOrder(&I, &F, OM, Stack);
 238   }
 239
 240   // Visit globals last.
 241   for (const GlobalVariable &G : M->globals())
 242     predictValueUseListOrder(&G, nullptr, OM, Stack);
 243   for (const Function &F : *M)
 244     predictValueUseListOrder(&F, nullptr, OM, Stack);
 245   for (const GlobalAlias &A : M->aliases())
 246     predictValueUseListOrder(&A, nullptr, OM, Stack);
 247   for (const GlobalVariable &G : M->globals())
 248     if (G.hasInitializer())
 249       predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
 250   for (const GlobalAlias &A : M->aliases())
 251     predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
 252   for (const Function &F : *M)
 253     if (F.hasPrefixData())
 254       predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
 255
 256   return Stack;
 257 }
 258
 259 static const Module *getModuleFromVal(const Value *V) {
 260   if (const Argument *MA = dyn_cast<Argument>(V))
 261     return MA->getParent() ? MA->getParent()->getParent() : nullptr;
 262
 263   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 264     return BB->getParent() ? BB->getParent()->getParent() : nullptr;
 265
 266   if (const Instruction *I = dyn_cast<Instruction>(V)) {
 267     const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
 268     return M ? M->getParent() : nullptr;
 269   }
 270
 271   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
 272     return GV->getParent();
 273   return nullptr;
 274 }
 275
 276 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
 277   switch (cc) {
 278   default:                         Out << "cc" << cc; break;
 279   case CallingConv::Fast:          Out << "fastcc"; break;
 280   case CallingConv::Cold:          Out << "coldcc"; break;
 281   case CallingConv::WebKit_JS:     Out << "webkit_jscc"; break;
 282   case CallingConv::AnyReg:        Out << "anyregcc"; break;
 283   case CallingConv::PreserveMost:  Out << "preserve_mostcc"; break;
 284   case CallingConv::PreserveAll:   Out << "preserve_allcc"; break;
 285   case CallingConv::X86_StdCall:   Out << "x86_stdcallcc"; break;
 286   case CallingConv::X86_FastCall:  Out << "x86_fastcallcc"; break;
 287   case CallingConv::X86_ThisCall:  Out << "x86_thiscallcc"; break;
 288   case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
 289   case CallingConv::Intel_OCL_BI:  Out << "intel_ocl_bicc"; break;
 290   case CallingConv::ARM_APCS:      Out << "arm_apcscc"; break;
 291   case CallingConv::ARM_AAPCS:     Out << "arm_aapcscc"; break;
 292   case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
 293   case CallingConv::MSP430_INTR:   Out << "msp430_intrcc"; break;
 294   case CallingConv::PTX_Kernel:    Out << "ptx_kernel"; break;
 295   case CallingConv::PTX_Device:    Out << "ptx_device"; break;
 296   case CallingConv::X86_64_SysV:   Out << "x86_64_sysvcc"; break;
 297   case CallingConv::X86_64_Win64:  Out << "x86_64_win64cc"; break;
 298   case CallingConv::SPIR_FUNC:     Out << "spir_func"; break;
 299   case CallingConv::SPIR_KERNEL:   Out << "spir_kernel"; break;
 300   }
 301 }
 302
 303 // PrintEscapedString - Print each character of the specified string, escaping
 304 // it if it is not printable or if it is an escape char.
 305 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
 306   for (unsigned i = 0, e = Name.size(); i != e; ++i) {
 307     unsigned char C = Name[i];
 308     if (isprint(C) && C != '\\' && C != '"')
 309       Out << C;
 310     else
 311       Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
 312   }
 313 }
 314
 315 enum PrefixType {
 316   GlobalPrefix,
 317   ComdatPrefix,
 318   LabelPrefix,
 319   LocalPrefix,
 320   NoPrefix
 321 };
 322
 323 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
 324 /// prefixed with % (if the string only contains simple characters) or is
 325 /// surrounded with ""'s (if it has special chars in it).  Print it out.
 326 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
 327   assert(!Name.empty() && "Cannot get empty name!");
 328   switch (Prefix) {
 329   case NoPrefix: break;
 330   case GlobalPrefix: OS << '@'; break;
 331   case ComdatPrefix: OS << '$'; break;
 332   case LabelPrefix:  break;
 333   case LocalPrefix:  OS << '%'; break;
 334   }
 335
 336   // Scan the name to see if it needs quotes first.
 337   bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
 338   if (!NeedsQuotes) {
 339     for (unsigned i = 0, e = Name.size(); i != e; ++i) {
 340       // By making this unsigned, the value passed in to isalnum will always be
 341       // in the range 0-255.  This is important when building with MSVC because
 342       // its implementation will assert.  This situation can arise when dealing
 343       // with UTF-8 multibyte characters.
 344       unsigned char C = Name[i];
 345       if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
 346           C != '_') {
 347         NeedsQuotes = true;
 348         break;
 349       }
 350     }
 351   }
 352
 353   // If we didn't need any quotes, just write out the name in one blast.
 354   if (!NeedsQuotes) {
 355     OS << Name;
 356     return;
 357   }
 358
 359   // Okay, we need quotes.  Output the quotes and escape any scary characters as
 360   // needed.
 361   OS << '"';
 362   PrintEscapedString(Name, OS);
 363   OS << '"';
 364 }
 365
 366 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
 367 /// prefixed with % (if the string only contains simple characters) or is
 368 /// surrounded with ""'s (if it has special chars in it).  Print it out.
 369 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
 370   PrintLLVMName(OS, V->getName(),
 371                 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
 372 }
 373
 374
 375 namespace llvm {
 376
 377 void TypePrinting::incorporateTypes(const Module &M) {
 378   NamedTypes.run(M, false);
 379
 380   // The list of struct types we got back includes all the struct types, split
 381   // the unnamed ones out to a numbering and remove the anonymous structs.
 382   unsigned NextNumber = 0;
 383
 384   std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
 385   for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
 386     StructType *STy = *I;
 387
 388     // Ignore anonymous types.
 389     if (STy->isLiteral())
 390       continue;
 391
 392     if (STy->getName().empty())
 393       NumberedTypes[STy] = NextNumber++;
 394     else
 395       *NextToUse++ = STy;
 396   }
 397
 398   NamedTypes.erase(NextToUse, NamedTypes.end());
 399 }
 400
 401
 402 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
 403 /// use of type names or up references to shorten the type name where possible.
 404 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
 405   switch (Ty->getTypeID()) {
 406   case Type::VoidTyID:      OS << "void"; return;
 407   case Type::HalfTyID:      OS << "half"; return;
 408   case Type::FloatTyID:     OS << "float"; return;
 409   case Type::DoubleTyID:    OS << "double"; return;
 410   case Type::X86_FP80TyID:  OS << "x86_fp80"; return;
 411   case Type::FP128TyID:     OS << "fp128"; return;
 412   case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
 413   case Type::LabelTyID:     OS << "label"; return;
 414   case Type::MetadataTyID:  OS << "metadata"; return;
 415   case Type::X86_MMXTyID:   OS << "x86_mmx"; return;
 416   case Type::IntegerTyID:
 417     OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
 418     return;
 419
 420   case Type::FunctionTyID: {
 421     FunctionType *FTy = cast<FunctionType>(Ty);
 422     print(FTy->getReturnType(), OS);
 423     OS << " (";
 424     for (FunctionType::param_iterator I = FTy->param_begin(),
 425          E = FTy->param_end(); I != E; ++I) {
 426       if (I != FTy->param_begin())
 427         OS << ", ";
 428       print(*I, OS);
 429     }
 430     if (FTy->isVarArg()) {
 431       if (FTy->getNumParams()) OS << ", ";
 432       OS << "...";
 433     }
 434     OS << ')';
 435     return;
 436   }
 437   case Type::StructTyID: {
 438     StructType *STy = cast<StructType>(Ty);
 439
 440     if (STy->isLiteral())
 441       return printStructBody(STy, OS);
 442
 443     if (!STy->getName().empty())
 444       return PrintLLVMName(OS, STy->getName(), LocalPrefix);
 445
 446     DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
 447     if (I != NumberedTypes.end())
 448       OS << '%' << I->second;
 449     else  // Not enumerated, print the hex address.
 450       OS << "%\"type " << STy << '\"';
 451     return;
 452   }
 453   case Type::PointerTyID: {
 454     PointerType *PTy = cast<PointerType>(Ty);
 455     print(PTy->getElementType(), OS);
 456     if (unsigned AddressSpace = PTy->getAddressSpace())
 457       OS << " addrspace(" << AddressSpace << ')';
 458     OS << '*';
 459     return;
 460   }
 461   case Type::ArrayTyID: {
 462     ArrayType *ATy = cast<ArrayType>(Ty);
 463     OS << '[' << ATy->getNumElements() << " x ";
 464     print(ATy->getElementType(), OS);
 465     OS << ']';
 466     return;
 467   }
 468   case Type::VectorTyID: {
 469     VectorType *PTy = cast<VectorType>(Ty);
 470     OS << "<" << PTy->getNumElements() << " x ";
 471     print(PTy->getElementType(), OS);
 472     OS << '>';
 473     return;
 474   }
 475   }
 476   llvm_unreachable("Invalid TypeID");
 477 }
 478
 479 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
 480   if (STy->isOpaque()) {
 481     OS << "opaque";
 482     return;
 483   }
 484
 485   if (STy->isPacked())
 486     OS << '<';
 487
 488   if (STy->getNumElements() == 0) {
 489     OS << "{}";
 490   } else {
 491     StructType::element_iterator I = STy->element_begin();
 492     OS << "{ ";
 493     print(*I++, OS);
 494     for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
 495       OS << ", ";
 496       print(*I, OS);
 497     }
 498
 499     OS << " }";
 500   }
 501   if (STy->isPacked())
 502     OS << '>';
 503 }
 504
 505 //===----------------------------------------------------------------------===//
 506 // SlotTracker Class: Enumerate slot numbers for unnamed values
 507 //===----------------------------------------------------------------------===//
 508 /// This class provides computation of slot numbers for LLVM Assembly writing.
 509 ///
 510 class SlotTracker {
 511 public:
 512   /// ValueMap - A mapping of Values to slot numbers.
 513   typedef DenseMap<const Value*, unsigned> ValueMap;
 514
 515 private:
 516   /// TheModule - The module for which we are holding slot numbers.
 517   const Module* TheModule;
 518
 519   /// TheFunction - The function for which we are holding slot numbers.
 520   const Function* TheFunction;
 521   bool FunctionProcessed;
 522
 523   /// mMap - The slot map for the module level data.
 524   ValueMap mMap;
 525   unsigned mNext;
 526
 527   /// fMap - The slot map for the function level data.
 528   ValueMap fMap;
 529   unsigned fNext;
 530
 531   /// mdnMap - Map for MDNodes.
 532   DenseMap<const MDNode*, unsigned> mdnMap;
 533   unsigned mdnNext;
 534
 535   /// asMap - The slot map for attribute sets.
 536   DenseMap<AttributeSet, unsigned> asMap;
 537   unsigned asNext;
 538 public:
 539   /// Construct from a module
 540   explicit SlotTracker(const Module *M);
 541   /// Construct from a function, starting out in incorp state.
 542   explicit SlotTracker(const Function *F);
 543
 544   /// Return the slot number of the specified value in it's type
 545   /// plane.  If something is not in the SlotTracker, return -1.
 546   int getLocalSlot(const Value *V);
 547   int getGlobalSlot(const GlobalValue *V);
 548   int getMetadataSlot(const MDNode *N);
 549   int getAttributeGroupSlot(AttributeSet AS);
 550
 551   /// If you'd like to deal with a function instead of just a module, use
 552   /// this method to get its data into the SlotTracker.
 553   void incorporateFunction(const Function *F) {
 554     TheFunction = F;
 555     FunctionProcessed = false;
 556   }
 557
 558   const Function *getFunction() const { return TheFunction; }
 559
 560   /// After calling incorporateFunction, use this method to remove the
 561   /// most recently incorporated function from the SlotTracker. This
 562   /// will reset the state of the machine back to just the module contents.
 563   void purgeFunction();
 564
 565   /// MDNode map iterators.
 566   typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
 567   mdn_iterator mdn_begin() { return mdnMap.begin(); }
 568   mdn_iterator mdn_end() { return mdnMap.end(); }
 569   unsigned mdn_size() const { return mdnMap.size(); }
 570   bool mdn_empty() const { return mdnMap.empty(); }
 571
 572   /// AttributeSet map iterators.
 573   typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
 574   as_iterator as_begin()   { return asMap.begin(); }
 575   as_iterator as_end()     { return asMap.end(); }
 576   unsigned as_size() const { return asMap.size(); }
 577   bool as_empty() const    { return asMap.empty(); }
 578
 579   /// This function does the actual initialization.
 580   inline void initialize();
 581
 582   // Implementation Details
 583 private:
 584   /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
 585   void CreateModuleSlot(const GlobalValue *V);
 586
 587   /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
 588   void CreateMetadataSlot(const MDNode *N);
 589
 590   /// CreateFunctionSlot - Insert the specified Value* into the slot table.
 591   void CreateFunctionSlot(const Value *V);
 592
 593   /// \brief Insert the specified AttributeSet into the slot table.
 594   void CreateAttributeSetSlot(AttributeSet AS);
 595
 596   /// Add all of the module level global variables (and their initializers)
 597   /// and function declarations, but not the contents of those functions.
 598   void processModule();
 599
 600   /// Add all of the functions arguments, basic blocks, and instructions.
 601   void processFunction();
 602
 603   SlotTracker(const SlotTracker &) LLVM_DELETED_FUNCTION;
 604   void operator=(const SlotTracker &) LLVM_DELETED_FUNCTION;
 605 };
 606
 607 SlotTracker *createSlotTracker(const Module *M) {
 608   return new SlotTracker(M);
 609 }
 610
 611 static SlotTracker *createSlotTracker(const Value *V) {
 612   if (const Argument *FA = dyn_cast<Argument>(V))
 613     return new SlotTracker(FA->getParent());
 614
 615   if (const Instruction *I = dyn_cast<Instruction>(V))
 616     if (I->getParent())
 617       return new SlotTracker(I->getParent()->getParent());
 618
 619   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 620     return new SlotTracker(BB->getParent());
 621
 622   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
 623     return new SlotTracker(GV->getParent());
 624
 625   if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
 626     return new SlotTracker(GA->getParent());
 627
 628   if (const Function *Func = dyn_cast<Function>(V))
 629     return new SlotTracker(Func);
 630
 631   if (const MDNode *MD = dyn_cast<MDNode>(V)) {
 632     if (!MD->isFunctionLocal())
 633       return new SlotTracker(MD->getFunction());
 634
 635     return new SlotTracker((Function *)nullptr);
 636   }
 637
 638   return nullptr;
 639 }
 640
 641 #if 0
 642 #define ST_DEBUG(X) dbgs() << X
 643 #else
 644 #define ST_DEBUG(X)
 645 #endif
 646
 647 // Module level constructor. Causes the contents of the Module (sans functions)
 648 // to be added to the slot table.
 649 SlotTracker::SlotTracker(const Module *M)
 650   : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
 651     mNext(0), fNext(0),  mdnNext(0), asNext(0) {
 652 }
 653
 654 // Function level constructor. Causes the contents of the Module and the one
 655 // function provided to be added to the slot table.
 656 SlotTracker::SlotTracker(const Function *F)
 657   : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
 658     FunctionProcessed(false), mNext(0), fNext(0), mdnNext(0), asNext(0) {
 659 }
 660
 661 inline void SlotTracker::initialize() {
 662   if (TheModule) {
 663     processModule();
 664     TheModule = nullptr; ///< Prevent re-processing next time we're called.
 665   }
 666
 667   if (TheFunction && !FunctionProcessed)
 668     processFunction();
 669 }
 670
 671 // Iterate through all the global variables, functions, and global
 672 // variable initializers and create slots for them.
 673 void SlotTracker::processModule() {
 674   ST_DEBUG("begin processModule!\n");
 675
 676   // Add all of the unnamed global variables to the value table.
 677   for (Module::const_global_iterator I = TheModule->global_begin(),
 678          E = TheModule->global_end(); I != E; ++I) {
 679     if (!I->hasName())
 680       CreateModuleSlot(I);
 681   }
 682
 683   // Add metadata used by named metadata.
 684   for (Module::const_named_metadata_iterator
 685          I = TheModule->named_metadata_begin(),
 686          E = TheModule->named_metadata_end(); I != E; ++I) {
 687     const NamedMDNode *NMD = I;
 688     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
 689       CreateMetadataSlot(NMD->getOperand(i));
 690   }
 691
 692   for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
 693        I != E; ++I) {
 694     if (!I->hasName())
 695       // Add all the unnamed functions to the table.
 696       CreateModuleSlot(I);
 697
 698     // Add all the function attributes to the table.
 699     // FIXME: Add attributes of other objects?
 700     AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
 701     if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
 702       CreateAttributeSetSlot(FnAttrs);
 703   }
 704
 705   ST_DEBUG("end processModule!\n");
 706 }
 707
 708 // Process the arguments, basic blocks, and instructions  of a function.
 709 void SlotTracker::processFunction() {
 710   ST_DEBUG("begin processFunction!\n");
 711   fNext = 0;
 712
 713   // Add all the function arguments with no names.
 714   for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
 715       AE = TheFunction->arg_end(); AI != AE; ++AI)
 716     if (!AI->hasName())
 717       CreateFunctionSlot(AI);
 718
 719   ST_DEBUG("Inserting Instructions:\n");
 720
 721   SmallVector<std::pair<unsigned, MDNode *>, 4> MDForInst;
 722
 723   // Add all of the basic blocks and instructions with no names.
 724   for (Function::const_iterator BB = TheFunction->begin(),
 725        E = TheFunction->end(); BB != E; ++BB) {
 726     if (!BB->hasName())
 727       CreateFunctionSlot(BB);
 728
 729     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
 730          ++I) {
 731       if (!I->getType()->isVoidTy() && !I->hasName())
 732         CreateFunctionSlot(I);
 733
 734       // Intrinsics can directly use metadata.  We allow direct calls to any
 735       // llvm.foo function here, because the target may not be linked into the
 736       // optimizer.
 737       if (const CallInst *CI = dyn_cast<CallInst>(I)) {
 738         if (Function *F = CI->getCalledFunction())
 739           if (F->isIntrinsic())
 740             for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 741               if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
 742                 CreateMetadataSlot(N);
 743
 744         // Add all the call attributes to the table.
 745         AttributeSet Attrs = CI->getAttributes().getFnAttributes();
 746         if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
 747           CreateAttributeSetSlot(Attrs);
 748       } else if (const InvokeInst *II = dyn_cast<InvokeInst>(I)) {
 749         // Add all the call attributes to the table.
 750         AttributeSet Attrs = II->getAttributes().getFnAttributes();
 751         if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
 752           CreateAttributeSetSlot(Attrs);
 753       }
 754
 755       // Process metadata attached with this instruction.
 756       I->getAllMetadata(MDForInst);
 757       for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
 758         CreateMetadataSlot(MDForInst[i].second);
 759       MDForInst.clear();
 760     }
 761   }
 762
 763   FunctionProcessed = true;
 764
 765   ST_DEBUG("end processFunction!\n");
 766 }
 767
 768 /// Clean up after incorporating a function. This is the only way to get out of
 769 /// the function incorporation state that affects get*Slot/Create*Slot. Function
 770 /// incorporation state is indicated by TheFunction != 0.
 771 void SlotTracker::purgeFunction() {
 772   ST_DEBUG("begin purgeFunction!\n");
 773   fMap.clear(); // Simply discard the function level map
 774   TheFunction = nullptr;
 775   FunctionProcessed = false;
 776   ST_DEBUG("end purgeFunction!\n");
 777 }
 778
 779 /// getGlobalSlot - Get the slot number of a global value.
 780 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
 781   // Check for uninitialized state and do lazy initialization.
 782   initialize();
 783
 784   // Find the value in the module map
 785   ValueMap::iterator MI = mMap.find(V);
 786   return MI == mMap.end() ? -1 : (int)MI->second;
 787 }
 788
 789 /// getMetadataSlot - Get the slot number of a MDNode.
 790 int SlotTracker::getMetadataSlot(const MDNode *N) {
 791   // Check for uninitialized state and do lazy initialization.
 792   initialize();
 793
 794   // Find the MDNode in the module map
 795   mdn_iterator MI = mdnMap.find(N);
 796   return MI == mdnMap.end() ? -1 : (int)MI->second;
 797 }
 798
 799
 800 /// getLocalSlot - Get the slot number for a value that is local to a function.
 801 int SlotTracker::getLocalSlot(const Value *V) {
 802   assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
 803
 804   // Check for uninitialized state and do lazy initialization.
 805   initialize();
 806
 807   ValueMap::iterator FI = fMap.find(V);
 808   return FI == fMap.end() ? -1 : (int)FI->second;
 809 }
 810
 811 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
 812   // Check for uninitialized state and do lazy initialization.
 813   initialize();
 814
 815   // Find the AttributeSet in the module map.
 816   as_iterator AI = asMap.find(AS);
 817   return AI == asMap.end() ? -1 : (int)AI->second;
 818 }
 819
 820 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
 821 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
 822   assert(V && "Can't insert a null Value into SlotTracker!");
 823   assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
 824   assert(!V->hasName() && "Doesn't need a slot!");
 825
 826   unsigned DestSlot = mNext++;
 827   mMap[V] = DestSlot;
 828
 829   ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
 830            DestSlot << " [");
 831   // G = Global, F = Function, A = Alias, o = other
 832   ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
 833             (isa<Function>(V) ? 'F' :
 834              (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
 835 }
 836
 837 /// CreateSlot - Create a new slot for the specified value if it has no name.
 838 void SlotTracker::CreateFunctionSlot(const Value *V) {
 839   assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
 840
 841   unsigned DestSlot = fNext++;
 842   fMap[V] = DestSlot;
 843
 844   // G = Global, F = Function, o = other
 845   ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
 846            DestSlot << " [o]\n");
 847 }
 848
 849 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
 850 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
 851   assert(N && "Can't insert a null Value into SlotTracker!");
 852
 853   // Don't insert if N is a function-local metadata, these are always printed
 854   // inline.
 855   if (!N->isFunctionLocal()) {
 856     mdn_iterator I = mdnMap.find(N);
 857     if (I != mdnMap.end())
 858       return;
 859
 860     unsigned DestSlot = mdnNext++;
 861     mdnMap[N] = DestSlot;
 862   }
 863
 864   // Recursively add any MDNodes referenced by operands.
 865   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
 866     if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
 867       CreateMetadataSlot(Op);
 868 }
 869
 870 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
 871   assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
 872          "Doesn't need a slot!");
 873
 874   as_iterator I = asMap.find(AS);
 875   if (I != asMap.end())
 876     return;
 877
 878   unsigned DestSlot = asNext++;
 879   asMap[AS] = DestSlot;
 880 }
 881
 882 //===----------------------------------------------------------------------===//
 883 // AsmWriter Implementation
 884 //===----------------------------------------------------------------------===//
 885
 886 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
 887                                    TypePrinting *TypePrinter,
 888                                    SlotTracker *Machine,
 889                                    const Module *Context);
 890
 891 static const char *getPredicateText(unsigned predicate) {
 892   const char * pred = "unknown";
 893   switch (predicate) {
 894   case FCmpInst::FCMP_FALSE: pred = "false"; break;
 895   case FCmpInst::FCMP_OEQ:   pred = "oeq"; break;
 896   case FCmpInst::FCMP_OGT:   pred = "ogt"; break;
 897   case FCmpInst::FCMP_OGE:   pred = "oge"; break;
 898   case FCmpInst::FCMP_OLT:   pred = "olt"; break;
 899   case FCmpInst::FCMP_OLE:   pred = "ole"; break;
 900   case FCmpInst::FCMP_ONE:   pred = "one"; break;
 901   case FCmpInst::FCMP_ORD:   pred = "ord"; break;
 902   case FCmpInst::FCMP_UNO:   pred = "uno"; break;
 903   case FCmpInst::FCMP_UEQ:   pred = "ueq"; break;
 904   case FCmpInst::FCMP_UGT:   pred = "ugt"; break;
 905   case FCmpInst::FCMP_UGE:   pred = "uge"; break;
 906   case FCmpInst::FCMP_ULT:   pred = "ult"; break;
 907   case FCmpInst::FCMP_ULE:   pred = "ule"; break;
 908   case FCmpInst::FCMP_UNE:   pred = "une"; break;
 909   case FCmpInst::FCMP_TRUE:  pred = "true"; break;
 910   case ICmpInst::ICMP_EQ:    pred = "eq"; break;
 911   case ICmpInst::ICMP_NE:    pred = "ne"; break;
 912   case ICmpInst::ICMP_SGT:   pred = "sgt"; break;
 913   case ICmpInst::ICMP_SGE:   pred = "sge"; break;
 914   case ICmpInst::ICMP_SLT:   pred = "slt"; break;
 915   case ICmpInst::ICMP_SLE:   pred = "sle"; break;
 916   case ICmpInst::ICMP_UGT:   pred = "ugt"; break;
 917   case ICmpInst::ICMP_UGE:   pred = "uge"; break;
 918   case ICmpInst::ICMP_ULT:   pred = "ult"; break;
 919   case ICmpInst::ICMP_ULE:   pred = "ule"; break;
 920   }
 921   return pred;
 922 }
 923
 924 static void writeAtomicRMWOperation(raw_ostream &Out,
 925                                     AtomicRMWInst::BinOp Op) {
 926   switch (Op) {
 927   default: Out << " <unknown operation " << Op << ">"; break;
 928   case AtomicRMWInst::Xchg: Out << " xchg"; break;
 929   case AtomicRMWInst::Add:  Out << " add"; break;
 930   case AtomicRMWInst::Sub:  Out << " sub"; break;
 931   case AtomicRMWInst::And:  Out << " and"; break;
 932   case AtomicRMWInst::Nand: Out << " nand"; break;
 933   case AtomicRMWInst::Or:   Out << " or"; break;
 934   case AtomicRMWInst::Xor:  Out << " xor"; break;
 935   case AtomicRMWInst::Max:  Out << " max"; break;
 936   case AtomicRMWInst::Min:  Out << " min"; break;
 937   case AtomicRMWInst::UMax: Out << " umax"; break;
 938   case AtomicRMWInst::UMin: Out << " umin"; break;
 939   }
 940 }
 941
 942 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
 943   if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
 944     // Unsafe algebra implies all the others, no need to write them all out
 945     if (FPO->hasUnsafeAlgebra())
 946       Out << " fast";
 947     else {
 948       if (FPO->hasNoNaNs())
 949         Out << " nnan";
 950       if (FPO->hasNoInfs())
 951         Out << " ninf";
 952       if (FPO->hasNoSignedZeros())
 953         Out << " nsz";
 954       if (FPO->hasAllowReciprocal())
 955         Out << " arcp";
 956     }
 957   }
 958
 959   if (const OverflowingBinaryOperator *OBO =
 960         dyn_cast<OverflowingBinaryOperator>(U)) {
 961     if (OBO->hasNoUnsignedWrap())
 962       Out << " nuw";
 963     if (OBO->hasNoSignedWrap())
 964       Out << " nsw";
 965   } else if (const PossiblyExactOperator *Div =
 966                dyn_cast<PossiblyExactOperator>(U)) {
 967     if (Div->isExact())
 968       Out << " exact";
 969   } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
 970     if (GEP->isInBounds())
 971       Out << " inbounds";
 972   }
 973 }
 974
 975 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
 976                                   TypePrinting &TypePrinter,
 977                                   SlotTracker *Machine,
 978                                   const Module *Context) {
 979   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
 980     if (CI->getType()->isIntegerTy(1)) {
 981       Out << (CI->getZExtValue() ? "true" : "false");
 982       return;
 983     }
 984     Out << CI->getValue();
 985     return;
 986   }
 987
 988   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 989     if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
 990         &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
 991       // We would like to output the FP constant value in exponential notation,
 992       // but we cannot do this if doing so will lose precision.  Check here to
 993       // make sure that we only output it in exponential format if we can parse
 994       // the value back and get the same value.
 995       //
 996       bool ignored;
 997       bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
 998       bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
 999       bool isInf = CFP->getValueAPF().isInfinity();
1000       bool isNaN = CFP->getValueAPF().isNaN();
1001       if (!isHalf && !isInf && !isNaN) {
1002         double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1003                                 CFP->getValueAPF().convertToFloat();
1004         SmallString<128> StrVal;
1005         raw_svector_ostream(StrVal) << Val;
1006
1007         // Check to make sure that the stringized number is not some string like
1008         // "Inf" or NaN, that atof will accept, but the lexer will not.  Check
1009         // that the string matches the "[-+]?[0-9]" regex.
1010         //
1011         if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1012             ((StrVal[0] == '-' || StrVal[0] == '+') &&
1013              (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1014           // Reparse stringized version!
1015           if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1016             Out << StrVal.str();
1017             return;
1018           }
1019         }
1020       }
1021       // Otherwise we could not reparse it to exactly the same value, so we must
1022       // output the string in hexadecimal format!  Note that loading and storing
1023       // floating point types changes the bits of NaNs on some hosts, notably
1024       // x86, so we must not use these types.
1025       static_assert(sizeof(double) == sizeof(uint64_t),
1026                     "assuming that double is 64 bits!");
1027       char Buffer[40];
1028       APFloat apf = CFP->getValueAPF();
1029       // Halves and floats are represented in ASCII IR as double, convert.
1030       if (!isDouble)
1031         apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1032                           &ignored);
1033       Out << "0x" <<
1034               utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1035                             Buffer+40);
1036       return;
1037     }
1038
1039     // Either half, or some form of long double.
1040     // These appear as a magic letter identifying the type, then a
1041     // fixed number of hex digits.
1042     Out << "0x";
1043     // Bit position, in the current word, of the next nibble to print.
1044     int shiftcount;
1045
1046     if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1047       Out << 'K';
1048       // api needed to prevent premature destruction
1049       APInt api = CFP->getValueAPF().bitcastToAPInt();
1050       const uint64_t* p = api.getRawData();
1051       uint64_t word = p[1];
1052       shiftcount = 12;
1053       int width = api.getBitWidth();
1054       for (int j=0; j<width; j+=4, shiftcount-=4) {
1055         unsigned int nibble = (word>>shiftcount) & 15;
1056         if (nibble < 10)
1057           Out << (unsigned char)(nibble + '0');
1058         else
1059           Out << (unsigned char)(nibble - 10 + 'A');
1060         if (shiftcount == 0 && j+4 < width) {
1061           word = *p;
1062           shiftcount = 64;
1063           if (width-j-4 < 64)
1064             shiftcount = width-j-4;
1065         }
1066       }
1067       return;
1068     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1069       shiftcount = 60;
1070       Out << 'L';
1071     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1072       shiftcount = 60;
1073       Out << 'M';
1074     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1075       shiftcount = 12;
1076       Out << 'H';
1077     } else
1078       llvm_unreachable("Unsupported floating point type");
1079     // api needed to prevent premature destruction
1080     APInt api = CFP->getValueAPF().bitcastToAPInt();
1081     const uint64_t* p = api.getRawData();
1082     uint64_t word = *p;
1083     int width = api.getBitWidth();
1084     for (int j=0; j<width; j+=4, shiftcount-=4) {
1085       unsigned int nibble = (word>>shiftcount) & 15;
1086       if (nibble < 10)
1087         Out << (unsigned char)(nibble + '0');
1088       else
1089         Out << (unsigned char)(nibble - 10 + 'A');
1090       if (shiftcount == 0 && j+4 < width) {
1091         word = *(++p);
1092         shiftcount = 64;
1093         if (width-j-4 < 64)
1094           shiftcount = width-j-4;
1095       }
1096     }
1097     return;
1098   }
1099
1100   if (isa<ConstantAggregateZero>(CV)) {
1101     Out << "zeroinitializer";
1102     return;
1103   }
1104
1105   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1106     Out << "blockaddress(";
1107     WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1108                            Context);
1109     Out << ", ";
1110     WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1111                            Context);
1112     Out << ")";
1113     return;
1114   }
1115
1116   if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1117     Type *ETy = CA->getType()->getElementType();
1118     Out << '[';
1119     TypePrinter.print(ETy, Out);
1120     Out << ' ';
1121     WriteAsOperandInternal(Out, CA->getOperand(0),
1122                            &TypePrinter, Machine,
1123                            Context);
1124     for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1125       Out << ", ";
1126       TypePrinter.print(ETy, Out);
1127       Out << ' ';
1128       WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1129                              Context);
1130     }
1131     Out << ']';
1132     return;
1133   }
1134
1135   if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1136     // As a special case, print the array as a string if it is an array of
1137     // i8 with ConstantInt values.
1138     if (CA->isString()) {
1139       Out << "c\"";
1140       PrintEscapedString(CA->getAsString(), Out);
1141       Out << '"';
1142       return;
1143     }
1144
1145     Type *ETy = CA->getType()->getElementType();
1146     Out << '[';
1147     TypePrinter.print(ETy, Out);
1148     Out << ' ';
1149     WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1150                            &TypePrinter, Machine,
1151                            Context);
1152     for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1153       Out << ", ";
1154       TypePrinter.print(ETy, Out);
1155       Out << ' ';
1156       WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1157                              Machine, Context);
1158     }
1159     Out << ']';
1160     return;
1161   }
1162
1163
1164   if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1165     if (CS->getType()->isPacked())
1166       Out << '<';
1167     Out << '{';
1168     unsigned N = CS->getNumOperands();
1169     if (N) {
1170       Out << ' ';
1171       TypePrinter.print(CS->getOperand(0)->getType(), Out);
1172       Out << ' ';
1173
1174       WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1175                              Context);
1176
1177       for (unsigned i = 1; i < N; i++) {
1178         Out << ", ";
1179         TypePrinter.print(CS->getOperand(i)->getType(), Out);
1180         Out << ' ';
1181
1182         WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1183                                Context);
1184       }
1185       Out << ' ';
1186     }
1187
1188     Out << '}';
1189     if (CS->getType()->isPacked())
1190       Out << '>';
1191     return;
1192   }
1193
1194   if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1195     Type *ETy = CV->getType()->getVectorElementType();
1196     Out << '<';
1197     TypePrinter.print(ETy, Out);
1198     Out << ' ';
1199     WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1200                            Machine, Context);
1201     for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1202       Out << ", ";
1203       TypePrinter.print(ETy, Out);
1204       Out << ' ';
1205       WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1206                              Machine, Context);
1207     }
1208     Out << '>';
1209     return;
1210   }
1211
1212   if (isa<ConstantPointerNull>(CV)) {
1213     Out << "null";
1214     return;
1215   }
1216
1217   if (isa<UndefValue>(CV)) {
1218     Out << "undef";
1219     return;
1220   }
1221
1222   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1223     Out << CE->getOpcodeName();
1224     WriteOptimizationInfo(Out, CE);
1225     if (CE->isCompare())
1226       Out << ' ' << getPredicateText(CE->getPredicate());
1227     Out << " (";
1228
1229     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1230       TypePrinter.print((*OI)->getType(), Out);
1231       Out << ' ';
1232       WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1233       if (OI+1 != CE->op_end())
1234         Out << ", ";
1235     }
1236
1237     if (CE->hasIndices()) {
1238       ArrayRef<unsigned> Indices = CE->getIndices();
1239       for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1240         Out << ", " << Indices[i];
1241     }
1242
1243     if (CE->isCast()) {
1244       Out << " to ";
1245       TypePrinter.print(CE->getType(), Out);
1246     }
1247
1248     Out << ')';
1249     return;
1250   }
1251
1252   Out << "<placeholder or erroneous Constant>";
1253 }
1254
1255 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1256                                     TypePrinting *TypePrinter,
1257                                     SlotTracker *Machine,
1258                                     const Module *Context) {
1259   Out << "!{";
1260   for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1261     const Value *V = Node->getOperand(mi);
1262     if (!V)
1263       Out << "null";
1264     else {
1265       TypePrinter->print(V->getType(), Out);
1266       Out << ' ';
1267       WriteAsOperandInternal(Out, Node->getOperand(mi),
1268                              TypePrinter, Machine, Context);
1269     }
1270     if (mi + 1 != me)
1271       Out << ", ";
1272   }
1273
1274   Out << "}";
1275 }
1276
1277 // Full implementation of printing a Value as an operand with support for
1278 // TypePrinting, etc.
1279 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1280                                    TypePrinting *TypePrinter,
1281                                    SlotTracker *Machine,
1282                                    const Module *Context) {
1283   if (V->hasName()) {
1284     PrintLLVMName(Out, V);
1285     return;
1286   }
1287
1288   const Constant *CV = dyn_cast<Constant>(V);
1289   if (CV && !isa<GlobalValue>(CV)) {
1290     assert(TypePrinter && "Constants require TypePrinting!");
1291     WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1292     return;
1293   }
1294
1295   if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1296     Out << "asm ";
1297     if (IA->hasSideEffects())
1298       Out << "sideeffect ";
1299     if (IA->isAlignStack())
1300       Out << "alignstack ";
1301     // We don't emit the AD_ATT dialect as it's the assumed default.
1302     if (IA->getDialect() == InlineAsm::AD_Intel)
1303       Out << "inteldialect ";
1304     Out << '"';
1305     PrintEscapedString(IA->getAsmString(), Out);
1306     Out << "\", \"";
1307     PrintEscapedString(IA->getConstraintString(), Out);
1308     Out << '"';
1309     return;
1310   }
1311
1312   if (const MDNode *N = dyn_cast<MDNode>(V)) {
1313     if (N->isFunctionLocal()) {
1314       // Print metadata inline, not via slot reference number.
1315       WriteMDNodeBodyInternal(Out, N, TypePrinter, Machine, Context);
1316       return;
1317     }
1318
1319     if (!Machine) {
1320       if (N->isFunctionLocal())
1321         Machine = new SlotTracker(N->getFunction());
1322       else
1323         Machine = new SlotTracker(Context);
1324     }
1325     int Slot = Machine->getMetadataSlot(N);
1326     if (Slot == -1)
1327       Out << "<badref>";
1328     else
1329       Out << '!' << Slot;
1330     return;
1331   }
1332
1333   if (const MDString *MDS = dyn_cast<MDString>(V)) {
1334     Out << "!\"";
1335     PrintEscapedString(MDS->getString(), Out);
1336     Out << '"';
1337     return;
1338   }
1339
1340   char Prefix = '%';
1341   int Slot;
1342   // If we have a SlotTracker, use it.
1343   if (Machine) {
1344     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1345       Slot = Machine->getGlobalSlot(GV);
1346       Prefix = '@';
1347     } else {
1348       Slot = Machine->getLocalSlot(V);
1349
1350       // If the local value didn't succeed, then we may be referring to a value
1351       // from a different function.  Translate it, as this can happen when using
1352       // address of blocks.
1353       if (Slot == -1)
1354         if ((Machine = createSlotTracker(V))) {
1355           Slot = Machine->getLocalSlot(V);
1356           delete Machine;
1357         }
1358     }
1359   } else if ((Machine = createSlotTracker(V))) {
1360     // Otherwise, create one to get the # and then destroy it.
1361     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1362       Slot = Machine->getGlobalSlot(GV);
1363       Prefix = '@';
1364     } else {
1365       Slot = Machine->getLocalSlot(V);
1366     }
1367     delete Machine;
1368     Machine = nullptr;
1369   } else {
1370     Slot = -1;
1371   }
1372
1373   if (Slot != -1)
1374     Out << Prefix << Slot;
1375   else
1376     Out << "<badref>";
1377 }
1378
1379 void AssemblyWriter::init() {
1380   if (!TheModule)
1381     return;
1382   TypePrinter.incorporateTypes(*TheModule);
1383   for (const Function &F : *TheModule)
1384     if (const Comdat *C = F.getComdat())
1385       Comdats.insert(C);
1386   for (const GlobalVariable &GV : TheModule->globals())
1387     if (const Comdat *C = GV.getComdat())
1388       Comdats.insert(C);
1389 }
1390
1391
1392 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1393                                const Module *M,
1394                                AssemblyAnnotationWriter *AAW)
1395   : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
1396   init();
1397 }
1398
1399 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1400                                AssemblyAnnotationWriter *AAW)
1401   : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
1402     Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
1403   init();
1404 }
1405
1406 AssemblyWriter::~AssemblyWriter() { }
1407
1408 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1409   if (!Operand) {
1410     Out << "<null operand!>";
1411     return;
1412   }
1413   if (PrintType) {
1414     TypePrinter.print(Operand->getType(), Out);
1415     Out << ' ';
1416   }
1417   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1418 }
1419
1420 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
1421                                  SynchronizationScope SynchScope) {
1422   if (Ordering == NotAtomic)
1423     return;
1424
1425   switch (SynchScope) {
1426   case SingleThread: Out << " singlethread"; break;
1427   case CrossThread: break;
1428   }
1429
1430   switch (Ordering) {
1431   default: Out << " <bad ordering " << int(Ordering) << ">"; break;
1432   case Unordered: Out << " unordered"; break;
1433   case Monotonic: Out << " monotonic"; break;
1434   case Acquire: Out << " acquire"; break;
1435   case Release: Out << " release"; break;
1436   case AcquireRelease: Out << " acq_rel"; break;
1437   case SequentiallyConsistent: Out << " seq_cst"; break;
1438   }
1439 }
1440
1441 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1442                                         AtomicOrdering FailureOrdering,
1443                                         SynchronizationScope SynchScope) {
1444   assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
1445
1446   switch (SynchScope) {
1447   case SingleThread: Out << " singlethread"; break;
1448   case CrossThread: break;
1449   }
1450
1451   switch (SuccessOrdering) {
1452   default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
1453   case Unordered: Out << " unordered"; break;
1454   case Monotonic: Out << " monotonic"; break;
1455   case Acquire: Out << " acquire"; break;
1456   case Release: Out << " release"; break;
1457   case AcquireRelease: Out << " acq_rel"; break;
1458   case SequentiallyConsistent: Out << " seq_cst"; break;
1459   }
1460
1461   switch (FailureOrdering) {
1462   default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
1463   case Unordered: Out << " unordered"; break;
1464   case Monotonic: Out << " monotonic"; break;
1465   case Acquire: Out << " acquire"; break;
1466   case Release: Out << " release"; break;
1467   case AcquireRelease: Out << " acq_rel"; break;
1468   case SequentiallyConsistent: Out << " seq_cst"; break;
1469   }
1470 }
1471
1472 void AssemblyWriter::writeParamOperand(const Value *Operand,
1473                                        AttributeSet Attrs, unsigned Idx) {
1474   if (!Operand) {
1475     Out << "<null operand!>";
1476     return;
1477   }
1478
1479   // Print the type
1480   TypePrinter.print(Operand->getType(), Out);
1481   // Print parameter attributes list
1482   if (Attrs.hasAttributes(Idx))
1483     Out << ' ' << Attrs.getAsString(Idx);
1484   Out << ' ';
1485   // Print the operand
1486   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1487 }
1488
1489 void AssemblyWriter::printModule(const Module *M) {
1490   Machine.initialize();
1491
1492   if (shouldPreserveAssemblyUseListOrder())
1493     UseListOrders = predictUseListOrder(M);
1494
1495   if (!M->getModuleIdentifier().empty() &&
1496       // Don't print the ID if it will start a new line (which would
1497       // require a comment char before it).
1498       M->getModuleIdentifier().find('\n') == std::string::npos)
1499     Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1500
1501   const std::string &DL = M->getDataLayoutStr();
1502   if (!DL.empty())
1503     Out << "target datalayout = \"" << DL << "\"\n";
1504   if (!M->getTargetTriple().empty())
1505     Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1506
1507   if (!M->getModuleInlineAsm().empty()) {
1508     // Split the string into lines, to make it easier to read the .ll file.
1509     std::string Asm = M->getModuleInlineAsm();
1510     size_t CurPos = 0;
1511     size_t NewLine = Asm.find_first_of('\n', CurPos);
1512     Out << '\n';
1513     while (NewLine != std::string::npos) {
1514       // We found a newline, print the portion of the asm string from the
1515       // last newline up to this newline.
1516       Out << "module asm \"";
1517       PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1518                          Out);
1519       Out << "\"\n";
1520       CurPos = NewLine+1;
1521       NewLine = Asm.find_first_of('\n', CurPos);
1522     }
1523     std::string rest(Asm.begin()+CurPos, Asm.end());
1524     if (!rest.empty()) {
1525       Out << "module asm \"";
1526       PrintEscapedString(rest, Out);
1527       Out << "\"\n";
1528     }
1529   }
1530
1531   printTypeIdentities();
1532
1533   // Output all comdats.
1534   if (!Comdats.empty())
1535     Out << '\n';
1536   for (const Comdat *C : Comdats) {
1537     printComdat(C);
1538     if (C != Comdats.back())
1539       Out << '\n';
1540   }
1541
1542   // Output all globals.
1543   if (!M->global_empty()) Out << '\n';
1544   for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1545        I != E; ++I) {
1546     printGlobal(I); Out << '\n';
1547   }
1548
1549   // Output all aliases.
1550   if (!M->alias_empty()) Out << "\n";
1551   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1552        I != E; ++I)
1553     printAlias(I);
1554
1555   // Output global use-lists.
1556   printUseLists(nullptr);
1557
1558   // Output all of the functions.
1559   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1560     printFunction(I);
1561   assert(UseListOrders.empty() && "All use-lists should have been consumed");
1562
1563   // Output all attribute groups.
1564   if (!Machine.as_empty()) {
1565     Out << '\n';
1566     writeAllAttributeGroups();
1567   }
1568
1569   // Output named metadata.
1570   if (!M->named_metadata_empty()) Out << '\n';
1571
1572   for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1573        E = M->named_metadata_end(); I != E; ++I)
1574     printNamedMDNode(I);
1575
1576   // Output metadata.
1577   if (!Machine.mdn_empty()) {
1578     Out << '\n';
1579     writeAllMDNodes();
1580   }
1581 }
1582
1583 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1584   Out << '!';
1585   StringRef Name = NMD->getName();
1586   if (Name.empty()) {
1587     Out << "<empty name> ";
1588   } else {
1589     if (isalpha(static_cast<unsigned char>(Name[0])) ||
1590         Name[0] == '-' || Name[0] == '$' ||
1591         Name[0] == '.' || Name[0] == '_')
1592       Out << Name[0];
1593     else
1594       Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
1595     for (unsigned i = 1, e = Name.size(); i != e; ++i) {
1596       unsigned char C = Name[i];
1597       if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
1598           C == '.' || C == '_')
1599         Out << C;
1600       else
1601         Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1602     }
1603   }
1604   Out << " = !{";
1605   for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1606     if (i) Out << ", ";
1607     int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
1608     if (Slot == -1)
1609       Out << "<badref>";
1610     else
1611       Out << '!' << Slot;
1612   }
1613   Out << "}\n";
1614 }
1615
1616
1617 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1618                          formatted_raw_ostream &Out) {
1619   switch (LT) {
1620   case GlobalValue::ExternalLinkage: break;
1621   case GlobalValue::PrivateLinkage:       Out << "private ";        break;
1622   case GlobalValue::InternalLinkage:      Out << "internal ";       break;
1623   case GlobalValue::LinkOnceAnyLinkage:   Out << "linkonce ";       break;
1624   case GlobalValue::LinkOnceODRLinkage:   Out << "linkonce_odr ";   break;
1625   case GlobalValue::WeakAnyLinkage:       Out << "weak ";           break;
1626   case GlobalValue::WeakODRLinkage:       Out << "weak_odr ";       break;
1627   case GlobalValue::CommonLinkage:        Out << "common ";         break;
1628   case GlobalValue::AppendingLinkage:     Out << "appending ";      break;
1629   case GlobalValue::ExternalWeakLinkage:  Out << "extern_weak ";    break;
1630   case GlobalValue::AvailableExternallyLinkage:
1631     Out << "available_externally ";
1632     break;
1633   }
1634 }
1635
1636
1637 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1638                             formatted_raw_ostream &Out) {
1639   switch (Vis) {
1640   case GlobalValue::DefaultVisibility: break;
1641   case GlobalValue::HiddenVisibility:    Out << "hidden "; break;
1642   case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1643   }
1644 }
1645
1646 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
1647                                  formatted_raw_ostream &Out) {
1648   switch (SCT) {
1649   case GlobalValue::DefaultStorageClass: break;
1650   case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
1651   case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
1652   }
1653 }
1654
1655 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
1656                                   formatted_raw_ostream &Out) {
1657   switch (TLM) {
1658     case GlobalVariable::NotThreadLocal:
1659       break;
1660     case GlobalVariable::GeneralDynamicTLSModel:
1661       Out << "thread_local ";
1662       break;
1663     case GlobalVariable::LocalDynamicTLSModel:
1664       Out << "thread_local(localdynamic) ";
1665       break;
1666     case GlobalVariable::InitialExecTLSModel:
1667       Out << "thread_local(initialexec) ";
1668       break;
1669     case GlobalVariable::LocalExecTLSModel:
1670       Out << "thread_local(localexec) ";
1671       break;
1672   }
1673 }
1674
1675 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1676   if (GV->isMaterializable())
1677     Out << "; Materializable\n";
1678
1679   WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
1680   Out << " = ";
1681
1682   if (!GV->hasInitializer() && GV->hasExternalLinkage())
1683     Out << "external ";
1684
1685   PrintLinkage(GV->getLinkage(), Out);
1686   PrintVisibility(GV->getVisibility(), Out);
1687   PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
1688   PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
1689   if (GV->hasUnnamedAddr())
1690     Out << "unnamed_addr ";
1691
1692   if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1693     Out << "addrspace(" << AddressSpace << ") ";
1694   if (GV->isExternallyInitialized()) Out << "externally_initialized ";
1695   Out << (GV->isConstant() ? "constant " : "global ");
1696   TypePrinter.print(GV->getType()->getElementType(), Out);
1697
1698   if (GV->hasInitializer()) {
1699     Out << ' ';
1700     writeOperand(GV->getInitializer(), false);
1701   }
1702
1703   if (GV->hasSection()) {
1704     Out << ", section \"";
1705     PrintEscapedString(GV->getSection(), Out);
1706     Out << '"';
1707   }
1708   if (GV->hasComdat()) {
1709     Out << ", comdat ";
1710     PrintLLVMName(Out, GV->getComdat()->getName(), ComdatPrefix);
1711   }
1712   if (GV->getAlignment())
1713     Out << ", align " << GV->getAlignment();
1714
1715   printInfoComment(*GV);
1716 }
1717
1718 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1719   if (GA->isMaterializable())
1720     Out << "; Materializable\n";
1721
1722   // Don't crash when dumping partially built GA
1723   if (!GA->hasName())
1724     Out << "<<nameless>> = ";
1725   else {
1726     PrintLLVMName(Out, GA);
1727     Out << " = ";
1728   }
1729   PrintLinkage(GA->getLinkage(), Out);
1730   PrintVisibility(GA->getVisibility(), Out);
1731   PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
1732   PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
1733   if (GA->hasUnnamedAddr())
1734     Out << "unnamed_addr ";
1735
1736   Out << "alias ";
1737
1738   const Constant *Aliasee = GA->getAliasee();
1739
1740   if (!Aliasee) {
1741     TypePrinter.print(GA->getType(), Out);
1742     Out << " <<NULL ALIASEE>>";
1743   } else {
1744     writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
1745   }
1746
1747   printInfoComment(*GA);
1748   Out << '\n';
1749 }
1750
1751 void AssemblyWriter::printComdat(const Comdat *C) {
1752   C->print(Out);
1753 }
1754
1755 void AssemblyWriter::printTypeIdentities() {
1756   if (TypePrinter.NumberedTypes.empty() &&
1757       TypePrinter.NamedTypes.empty())
1758     return;
1759
1760   Out << '\n';
1761
1762   // We know all the numbers that each type is used and we know that it is a
1763   // dense assignment.  Convert the map to an index table.
1764   std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
1765   for (DenseMap<StructType*, unsigned>::iterator I =
1766        TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
1767        I != E; ++I) {
1768     assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
1769     NumberedTypes[I->second] = I->first;
1770   }
1771
1772   // Emit all numbered types.
1773   for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1774     Out << '%' << i << " = type ";
1775
1776     // Make sure we print out at least one level of the type structure, so
1777     // that we do not get %2 = type %2
1778     TypePrinter.printStructBody(NumberedTypes[i], Out);
1779     Out << '\n';
1780   }
1781
1782   for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
1783     PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
1784     Out << " = type ";
1785
1786     // Make sure we print out at least one level of the type structure, so
1787     // that we do not get %FILE = type %FILE
1788     TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
1789     Out << '\n';
1790   }
1791 }
1792
1793 /// printFunction - Print all aspects of a function.
1794 ///
1795 void AssemblyWriter::printFunction(const Function *F) {
1796   // Print out the return type and name.
1797   Out << '\n';
1798
1799   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1800
1801   if (F->isMaterializable())
1802     Out << "; Materializable\n";
1803
1804   const AttributeSet &Attrs = F->getAttributes();
1805   if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
1806     AttributeSet AS = Attrs.getFnAttributes();
1807     std::string AttrStr;
1808
1809     unsigned Idx = 0;
1810     for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
1811       if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
1812         break;
1813
1814     for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
1815          I != E; ++I) {
1816       Attribute Attr = *I;
1817       if (!Attr.isStringAttribute()) {
1818         if (!AttrStr.empty()) AttrStr += ' ';
1819         AttrStr += Attr.getAsString();
1820       }
1821     }
1822
1823     if (!AttrStr.empty())
1824       Out << "; Function Attrs: " << AttrStr << '\n';
1825   }
1826
1827   if (F->isDeclaration())
1828     Out << "declare ";
1829   else
1830     Out << "define ";
1831
1832   PrintLinkage(F->getLinkage(), Out);
1833   PrintVisibility(F->getVisibility(), Out);
1834   PrintDLLStorageClass(F->getDLLStorageClass(), Out);
1835
1836   // Print the calling convention.
1837   if (F->getCallingConv() != CallingConv::C) {
1838     PrintCallingConv(F->getCallingConv(), Out);
1839     Out << " ";
1840   }
1841
1842   FunctionType *FT = F->getFunctionType();
1843   if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
1844     Out <<  Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
1845   TypePrinter.print(F->getReturnType(), Out);
1846   Out << ' ';
1847   WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
1848   Out << '(';
1849   Machine.incorporateFunction(F);
1850
1851   // Loop over the arguments, printing them...
1852
1853   unsigned Idx = 1;
1854   if (!F->isDeclaration()) {
1855     // If this isn't a declaration, print the argument names as well.
1856     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1857          I != E; ++I) {
1858       // Insert commas as we go... the first arg doesn't get a comma
1859       if (I != F->arg_begin()) Out << ", ";
1860       printArgument(I, Attrs, Idx);
1861       Idx++;
1862     }
1863   } else {
1864     // Otherwise, print the types from the function type.
1865     for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1866       // Insert commas as we go... the first arg doesn't get a comma
1867       if (i) Out << ", ";
1868
1869       // Output type...
1870       TypePrinter.print(FT->getParamType(i), Out);
1871
1872       if (Attrs.hasAttributes(i+1))
1873         Out << ' ' << Attrs.getAsString(i+1);
1874     }
1875   }
1876
1877   // Finish printing arguments...
1878   if (FT->isVarArg()) {
1879     if (FT->getNumParams()) Out << ", ";
1880     Out << "...";  // Output varargs portion of signature!
1881   }
1882   Out << ')';
1883   if (F->hasUnnamedAddr())
1884     Out << " unnamed_addr";
1885   if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
1886     Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
1887   if (F->hasSection()) {
1888     Out << " section \"";
1889     PrintEscapedString(F->getSection(), Out);
1890     Out << '"';
1891   }
1892   if (F->hasComdat()) {
1893     Out << " comdat ";
1894     PrintLLVMName(Out, F->getComdat()->getName(), ComdatPrefix);
1895   }
1896   if (F->getAlignment())
1897     Out << " align " << F->getAlignment();
1898   if (F->hasGC())
1899     Out << " gc \"" << F->getGC() << '"';
1900   if (F->hasPrefixData()) {
1901     Out << " prefix ";
1902     writeOperand(F->getPrefixData(), true);
1903   }
1904   if (F->isDeclaration()) {
1905     Out << '\n';
1906   } else {
1907     Out << " {";
1908     // Output all of the function's basic blocks.
1909     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1910       printBasicBlock(I);
1911
1912     // Output the function's use-lists.
1913     printUseLists(F);
1914
1915     Out << "}\n";
1916   }
1917
1918   Machine.purgeFunction();
1919 }
1920
1921 /// printArgument - This member is called for every argument that is passed into
1922 /// the function.  Simply print it out
1923 ///
1924 void AssemblyWriter::printArgument(const Argument *Arg,
1925                                    AttributeSet Attrs, unsigned Idx) {
1926   // Output type...
1927   TypePrinter.print(Arg->getType(), Out);
1928
1929   // Output parameter attributes list
1930   if (Attrs.hasAttributes(Idx))
1931     Out << ' ' << Attrs.getAsString(Idx);
1932
1933   // Output name, if available...
1934   if (Arg->hasName()) {
1935     Out << ' ';
1936     PrintLLVMName(Out, Arg);
1937   }
1938 }
1939
1940 /// printBasicBlock - This member is called for each basic block in a method.
1941 ///
1942 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1943   if (BB->hasName()) {              // Print out the label if it exists...
1944     Out << "\n";
1945     PrintLLVMName(Out, BB->getName(), LabelPrefix);
1946     Out << ':';
1947   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
1948     Out << "\n; <label>:";
1949     int Slot = Machine.getLocalSlot(BB);
1950     if (Slot != -1)
1951       Out << Slot;
1952     else
1953       Out << "<badref>";
1954   }
1955
1956   if (!BB->getParent()) {
1957     Out.PadToColumn(50);
1958     Out << "; Error: Block without parent!";
1959   } else if (BB != &BB->getParent()->getEntryBlock()) {  // Not the entry block?
1960     // Output predecessors for the block.
1961     Out.PadToColumn(50);
1962     Out << ";";
1963     const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
1964
1965     if (PI == PE) {
1966       Out << " No predecessors!";
1967     } else {
1968       Out << " preds = ";
1969       writeOperand(*PI, false);
1970       for (++PI; PI != PE; ++PI) {
1971         Out << ", ";
1972         writeOperand(*PI, false);
1973       }
1974     }
1975   }
1976
1977   Out << "\n";
1978
1979   if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1980
1981   // Output all of the instructions in the basic block...
1982   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1983     printInstructionLine(*I);
1984   }
1985
1986   if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1987 }
1988
1989 /// printInstructionLine - Print an instruction and a newline character.
1990 void AssemblyWriter::printInstructionLine(const Instruction &I) {
1991   printInstruction(I);
1992   Out << '\n';
1993 }
1994
1995 /// printInfoComment - Print a little comment after the instruction indicating
1996 /// which slot it occupies.
1997 ///
1998 void AssemblyWriter::printInfoComment(const Value &V) {
1999   if (AnnotationWriter)
2000     AnnotationWriter->printInfoComment(V, Out);
2001 }
2002
2003 // This member is called for each Instruction in a function..
2004 void AssemblyWriter::printInstruction(const Instruction &I) {
2005   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2006
2007   // Print out indentation for an instruction.
2008   Out << "  ";
2009
2010   // Print out name if it exists...
2011   if (I.hasName()) {
2012     PrintLLVMName(Out, &I);
2013     Out << " = ";
2014   } else if (!I.getType()->isVoidTy()) {
2015     // Print out the def slot taken.
2016     int SlotNum = Machine.getLocalSlot(&I);
2017     if (SlotNum == -1)
2018       Out << "<badref> = ";
2019     else
2020       Out << '%' << SlotNum << " = ";
2021   }
2022
2023   if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2024     if (CI->isMustTailCall())
2025       Out << "musttail ";
2026     else if (CI->isTailCall())
2027       Out << "tail ";
2028   }
2029
2030   // Print out the opcode...
2031   Out << I.getOpcodeName();
2032
2033   // If this is an atomic load or store, print out the atomic marker.
2034   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isAtomic()) ||
2035       (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2036     Out << " atomic";
2037
2038   if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2039     Out << " weak";
2040
2041   // If this is a volatile operation, print out the volatile marker.
2042   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
2043       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2044       (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2045       (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2046     Out << " volatile";
2047
2048   // Print out optimization information.
2049   WriteOptimizationInfo(Out, &I);
2050
2051   // Print out the compare instruction predicates
2052   if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2053     Out << ' ' << getPredicateText(CI->getPredicate());
2054
2055   // Print out the atomicrmw operation
2056   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2057     writeAtomicRMWOperation(Out, RMWI->getOperation());
2058
2059   // Print out the type of the operands...
2060   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2061
2062   // Special case conditional branches to swizzle the condition out to the front
2063   if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2064     const BranchInst &BI(cast<BranchInst>(I));
2065     Out << ' ';
2066     writeOperand(BI.getCondition(), true);
2067     Out << ", ";
2068     writeOperand(BI.getSuccessor(0), true);
2069     Out << ", ";
2070     writeOperand(BI.getSuccessor(1), true);
2071
2072   } else if (isa<SwitchInst>(I)) {
2073     const SwitchInst& SI(cast<SwitchInst>(I));
2074     // Special case switch instruction to get formatting nice and correct.
2075     Out << ' ';
2076     writeOperand(SI.getCondition(), true);
2077     Out << ", ";
2078     writeOperand(SI.getDefaultDest(), true);
2079     Out << " [";
2080     for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2081          i != e; ++i) {
2082       Out << "\n    ";
2083       writeOperand(i.getCaseValue(), true);
2084       Out << ", ";
2085       writeOperand(i.getCaseSuccessor(), true);
2086     }
2087     Out << "\n  ]";
2088   } else if (isa<IndirectBrInst>(I)) {
2089     // Special case indirectbr instruction to get formatting nice and correct.
2090     Out << ' ';
2091     writeOperand(Operand, true);
2092     Out << ", [";
2093
2094     for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2095       if (i != 1)
2096         Out << ", ";
2097       writeOperand(I.getOperand(i), true);
2098     }
2099     Out << ']';
2100   } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2101     Out << ' ';
2102     TypePrinter.print(I.getType(), Out);
2103     Out << ' ';
2104
2105     for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2106       if (op) Out << ", ";
2107       Out << "[ ";
2108       writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2109       writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2110     }
2111   } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2112     Out << ' ';
2113     writeOperand(I.getOperand(0), true);
2114     for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2115       Out << ", " << *i;
2116   } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2117     Out << ' ';
2118     writeOperand(I.getOperand(0), true); Out << ", ";
2119     writeOperand(I.getOperand(1), true);
2120     for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2121       Out << ", " << *i;
2122   } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2123     Out << ' ';
2124     TypePrinter.print(I.getType(), Out);
2125     Out << " personality ";
2126     writeOperand(I.getOperand(0), true); Out << '\n';
2127
2128     if (LPI->isCleanup())
2129       Out << "          cleanup";
2130
2131     for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2132       if (i != 0 || LPI->isCleanup()) Out << "\n";
2133       if (LPI->isCatch(i))
2134         Out << "          catch ";
2135       else
2136         Out << "          filter ";
2137
2138       writeOperand(LPI->getClause(i), true);
2139     }
2140   } else if (isa<ReturnInst>(I) && !Operand) {
2141     Out << " void";
2142   } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2143     // Print the calling convention being used.
2144     if (CI->getCallingConv() != CallingConv::C) {
2145       Out << " ";
2146       PrintCallingConv(CI->getCallingConv(), Out);
2147     }
2148
2149     Operand = CI->getCalledValue();
2150     PointerType *PTy = cast<PointerType>(Operand->getType());
2151     FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2152     Type *RetTy = FTy->getReturnType();
2153     const AttributeSet &PAL = CI->getAttributes();
2154
2155     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2156       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2157
2158     // If possible, print out the short form of the call instruction.  We can
2159     // only do this if the first argument is a pointer to a nonvararg function,
2160     // and if the return type is not a pointer to a function.
2161     //
2162     Out << ' ';
2163     if (!FTy->isVarArg() &&
2164         (!RetTy->isPointerTy() ||
2165          !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2166       TypePrinter.print(RetTy, Out);
2167       Out << ' ';
2168       writeOperand(Operand, false);
2169     } else {
2170       writeOperand(Operand, true);
2171     }
2172     Out << '(';
2173     for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2174       if (op > 0)
2175         Out << ", ";
2176       writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2177     }
2178
2179     // Emit an ellipsis if this is a musttail call in a vararg function.  This
2180     // is only to aid readability, musttail calls forward varargs by default.
2181     if (CI->isMustTailCall() && CI->getParent() &&
2182         CI->getParent()->getParent() &&
2183         CI->getParent()->getParent()->isVarArg())
2184       Out << ", ...";
2185
2186     Out << ')';
2187     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2188       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2189   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2190     Operand = II->getCalledValue();
2191     PointerType *PTy = cast<PointerType>(Operand->getType());
2192     FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2193     Type *RetTy = FTy->getReturnType();
2194     const AttributeSet &PAL = II->getAttributes();
2195
2196     // Print the calling convention being used.
2197     if (II->getCallingConv() != CallingConv::C) {
2198       Out << " ";
2199       PrintCallingConv(II->getCallingConv(), Out);
2200     }
2201
2202     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2203       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2204
2205     // If possible, print out the short form of the invoke instruction. We can
2206     // only do this if the first argument is a pointer to a nonvararg function,
2207     // and if the return type is not a pointer to a function.
2208     //
2209     Out << ' ';
2210     if (!FTy->isVarArg() &&
2211         (!RetTy->isPointerTy() ||
2212          !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2213       TypePrinter.print(RetTy, Out);
2214       Out << ' ';
2215       writeOperand(Operand, false);
2216     } else {
2217       writeOperand(Operand, true);
2218     }
2219     Out << '(';
2220     for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2221       if (op)
2222         Out << ", ";
2223       writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2224     }
2225
2226     Out << ')';
2227     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2228       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2229
2230     Out << "\n          to ";
2231     writeOperand(II->getNormalDest(), true);
2232     Out << " unwind ";
2233     writeOperand(II->getUnwindDest(), true);
2234
2235   } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2236     Out << ' ';
2237     if (AI->isUsedWithInAlloca())
2238       Out << "inalloca ";
2239     TypePrinter.print(AI->getAllocatedType(), Out);
2240     if (!AI->getArraySize() || AI->isArrayAllocation()) {
2241       Out << ", ";
2242       writeOperand(AI->getArraySize(), true);
2243     }
2244     if (AI->getAlignment()) {
2245       Out << ", align " << AI->getAlignment();
2246     }
2247   } else if (isa<CastInst>(I)) {
2248     if (Operand) {
2249       Out << ' ';
2250       writeOperand(Operand, true);   // Work with broken code
2251     }
2252     Out << " to ";
2253     TypePrinter.print(I.getType(), Out);
2254   } else if (isa<VAArgInst>(I)) {
2255     if (Operand) {
2256       Out << ' ';
2257       writeOperand(Operand, true);   // Work with broken code
2258     }
2259     Out << ", ";
2260     TypePrinter.print(I.getType(), Out);
2261   } else if (Operand) {   // Print the normal way.
2262
2263     // PrintAllTypes - Instructions who have operands of all the same type
2264     // omit the type from all but the first operand.  If the instruction has
2265     // different type operands (for example br), then they are all printed.
2266     bool PrintAllTypes = false;
2267     Type *TheType = Operand->getType();
2268
2269     // Select, Store and ShuffleVector always print all types.
2270     if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2271         || isa<ReturnInst>(I)) {
2272       PrintAllTypes = true;
2273     } else {
2274       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2275         Operand = I.getOperand(i);
2276         // note that Operand shouldn't be null, but the test helps make dump()
2277         // more tolerant of malformed IR
2278         if (Operand && Operand->getType() != TheType) {
2279           PrintAllTypes = true;    // We have differing types!  Print them all!
2280           break;
2281         }
2282       }
2283     }
2284
2285     if (!PrintAllTypes) {
2286       Out << ' ';
2287       TypePrinter.print(TheType, Out);
2288     }
2289
2290     Out << ' ';
2291     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2292       if (i) Out << ", ";
2293       writeOperand(I.getOperand(i), PrintAllTypes);
2294     }
2295   }
2296
2297   // Print atomic ordering/alignment for memory operations
2298   if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2299     if (LI->isAtomic())
2300       writeAtomic(LI->getOrdering(), LI->getSynchScope());
2301     if (LI->getAlignment())
2302       Out << ", align " << LI->getAlignment();
2303   } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2304     if (SI->isAtomic())
2305       writeAtomic(SI->getOrdering(), SI->getSynchScope());
2306     if (SI->getAlignment())
2307       Out << ", align " << SI->getAlignment();
2308   } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2309     writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2310                        CXI->getSynchScope());
2311   } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2312     writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2313   } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2314     writeAtomic(FI->getOrdering(), FI->getSynchScope());
2315   }
2316
2317   // Print Metadata info.
2318   SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2319   I.getAllMetadata(InstMD);
2320   if (!InstMD.empty()) {
2321     SmallVector<StringRef, 8> MDNames;
2322     I.getType()->getContext().getMDKindNames(MDNames);
2323     for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2324       unsigned Kind = InstMD[i].first;
2325        if (Kind < MDNames.size()) {
2326          Out << ", !" << MDNames[Kind];
2327        } else {
2328          Out << ", !<unknown kind #" << Kind << ">";
2329        }
2330       Out << ' ';
2331       WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2332                              TheModule);
2333     }
2334   }
2335   printInfoComment(I);
2336 }
2337
2338 static void WriteMDNodeComment(const MDNode *Node,
2339                                formatted_raw_ostream &Out) {
2340   if (Node->getNumOperands() < 1)
2341     return;
2342
2343   Value *Op = Node->getOperand(0);
2344   if (!Op || !isa<MDString>(Op))
2345     return;
2346
2347   DIDescriptor Desc(Node);
2348   if (!Desc.Verify())
2349     return;
2350
2351   unsigned Tag = Desc.getTag();
2352   Out.PadToColumn(50);
2353   if (dwarf::TagString(Tag)) {
2354     Out << "; ";
2355     Desc.print(Out);
2356   } else if (Tag == dwarf::DW_TAG_user_base) {
2357     Out << "; [ DW_TAG_user_base ]";
2358   }
2359 }
2360
2361 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2362   Out << '!' << Slot << " = metadata ";
2363   printMDNodeBody(Node);
2364 }
2365
2366 void AssemblyWriter::writeAllMDNodes() {
2367   SmallVector<const MDNode *, 16> Nodes;
2368   Nodes.resize(Machine.mdn_size());
2369   for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2370        I != E; ++I)
2371     Nodes[I->second] = cast<MDNode>(I->first);
2372
2373   for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2374     writeMDNode(i, Nodes[i]);
2375   }
2376 }
2377
2378 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2379   WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
2380   WriteMDNodeComment(Node, Out);
2381   Out << "\n";
2382 }
2383
2384 void AssemblyWriter::writeAllAttributeGroups() {
2385   std::vector<std::pair<AttributeSet, unsigned> > asVec;
2386   asVec.resize(Machine.as_size());
2387
2388   for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
2389        I != E; ++I)
2390     asVec[I->second] = *I;
2391
2392   for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
2393          I = asVec.begin(), E = asVec.end(); I != E; ++I)
2394     Out << "attributes #" << I->second << " = { "
2395         << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
2396 }
2397
2398 } // namespace llvm
2399
2400 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
2401   bool IsInFunction = Machine.getFunction();
2402   if (IsInFunction)
2403     Out << "  ";
2404
2405   Out << "uselistorder";
2406   if (const BasicBlock *BB =
2407           IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
2408     Out << "_bb ";
2409     writeOperand(BB->getParent(), false);
2410     Out << ", ";
2411     writeOperand(BB, false);
2412   } else {
2413     Out << " ";
2414     writeOperand(Order.V, true);
2415   }
2416   Out << ", { ";
2417
2418   assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
2419   Out << Order.Shuffle[0];
2420   for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
2421     Out << ", " << Order.Shuffle[I];
2422   Out << " }\n";
2423 }
2424
2425 void AssemblyWriter::printUseLists(const Function *F) {
2426   auto hasMore =
2427       [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
2428   if (!hasMore())
2429     // Nothing to do.
2430     return;
2431
2432   Out << "\n; uselistorder directives\n";
2433   while (hasMore()) {
2434     printUseListOrder(UseListOrders.back());
2435     UseListOrders.pop_back();
2436   }
2437 }
2438
2439 //===----------------------------------------------------------------------===//
2440 //                       External Interface declarations
2441 //===----------------------------------------------------------------------===//
2442
2443 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2444   SlotTracker SlotTable(this);
2445   formatted_raw_ostream OS(ROS);
2446   AssemblyWriter W(OS, SlotTable, this, AAW);
2447   W.printModule(this);
2448 }
2449
2450 void NamedMDNode::print(raw_ostream &ROS) const {
2451   SlotTracker SlotTable(getParent());
2452   formatted_raw_ostream OS(ROS);
2453   AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
2454   W.printNamedMDNode(this);
2455 }
2456
2457 void Comdat::print(raw_ostream &ROS) const {
2458   PrintLLVMName(ROS, getName(), ComdatPrefix);
2459   ROS << " = comdat ";
2460
2461   switch (getSelectionKind()) {
2462   case Comdat::Any:
2463     ROS << "any";
2464     break;
2465   case Comdat::ExactMatch:
2466     ROS << "exactmatch";
2467     break;
2468   case Comdat::Largest:
2469     ROS << "largest";
2470     break;
2471   case Comdat::NoDuplicates:
2472     ROS << "noduplicates";
2473     break;
2474   case Comdat::SameSize:
2475     ROS << "samesize";
2476     break;
2477   }
2478
2479   ROS << '\n';
2480 }
2481
2482 void Type::print(raw_ostream &OS) const {
2483   TypePrinting TP;
2484   TP.print(const_cast<Type*>(this), OS);
2485
2486   // If the type is a named struct type, print the body as well.
2487   if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
2488     if (!STy->isLiteral()) {
2489       OS << " = type ";
2490       TP.printStructBody(STy, OS);
2491     }
2492 }
2493
2494 void Value::print(raw_ostream &ROS) const {
2495   formatted_raw_ostream OS(ROS);
2496   if (const Instruction *I = dyn_cast<Instruction>(this)) {
2497     const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
2498     SlotTracker SlotTable(F);
2499     AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
2500     W.printInstruction(*I);
2501   } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2502     SlotTracker SlotTable(BB->getParent());
2503     AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
2504     W.printBasicBlock(BB);
2505   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2506     SlotTracker SlotTable(GV->getParent());
2507     AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
2508     if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2509       W.printGlobal(V);
2510     else if (const Function *F = dyn_cast<Function>(GV))
2511       W.printFunction(F);
2512     else
2513       W.printAlias(cast<GlobalAlias>(GV));
2514   } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
2515     const Function *F = N->getFunction();
2516     SlotTracker SlotTable(F);
2517     AssemblyWriter W(OS, SlotTable, F ? F->getParent() : nullptr, nullptr);
2518     W.printMDNodeBody(N);
2519   } else if (const Constant *C = dyn_cast<Constant>(this)) {
2520     TypePrinting TypePrinter;
2521     TypePrinter.print(C->getType(), OS);
2522     OS << ' ';
2523     WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
2524   } else if (isa<InlineAsm>(this) || isa<MDString>(this) ||
2525              isa<Argument>(this)) {
2526     this->printAsOperand(OS);
2527   } else {
2528     llvm_unreachable("Unknown value to print out!");
2529   }
2530 }
2531
2532 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
2533   // Fast path: Don't construct and populate a TypePrinting object if we
2534   // won't be needing any types printed.
2535   if (!PrintType &&
2536       ((!isa<Constant>(this) && !isa<MDNode>(this)) ||
2537        hasName() || isa<GlobalValue>(this))) {
2538     WriteAsOperandInternal(O, this, nullptr, nullptr, M);
2539     return;
2540   }
2541
2542   if (!M)
2543     M = getModuleFromVal(this);
2544
2545   TypePrinting TypePrinter;
2546   if (M)
2547     TypePrinter.incorporateTypes(*M);
2548   if (PrintType) {
2549     TypePrinter.print(getType(), O);
2550     O << ' ';
2551   }
2552
2553   WriteAsOperandInternal(O, this, &TypePrinter, nullptr, M);
2554 }
2555
2556 // Value::dump - allow easy printing of Values from the debugger.
2557 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
2558
2559 // Type::dump - allow easy printing of Types from the debugger.
2560 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
2561
2562 // Module::dump() - Allow printing of Modules from the debugger.
2563 void Module::dump() const { print(dbgs(), nullptr); }
2564
2565 // \brief Allow printing of Comdats from the debugger.
2566 void Comdat::dump() const { print(dbgs()); }
2567
2568 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
2569 void NamedMDNode::dump() const { print(dbgs()); }