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