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 &) LLVM_DELETED_FUNCTION;
 610   void operator=(const SlotTracker &) LLVM_DELETED_FUNCTION;
 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.str();
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     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1227       TypePrinter.print((*OI)->getType(), Out);
1228       Out << ' ';
1229       WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1230       if (OI+1 != CE->op_end())
1231         Out << ", ";
1232     }
1233
1234     if (CE->hasIndices()) {
1235       ArrayRef<unsigned> Indices = CE->getIndices();
1236       for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1237         Out << ", " << Indices[i];
1238     }
1239
1240     if (CE->isCast()) {
1241       Out << " to ";
1242       TypePrinter.print(CE->getType(), Out);
1243     }
1244
1245     Out << ')';
1246     return;
1247   }
1248
1249   Out << "<placeholder or erroneous Constant>";
1250 }
1251
1252 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1253                          TypePrinting *TypePrinter, SlotTracker *Machine,
1254                          const Module *Context) {
1255   Out << "!{";
1256   for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1257     const Metadata *MD = Node->getOperand(mi);
1258     if (!MD)
1259       Out << "null";
1260     else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1261       Value *V = MDV->getValue();
1262       TypePrinter->print(V->getType(), Out);
1263       Out << ' ';
1264       WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1265     } else {
1266       WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1267     }
1268     if (mi + 1 != me)
1269       Out << ", ";
1270   }
1271
1272   Out << "}";
1273 }
1274
1275 namespace {
1276 struct FieldSeparator {
1277   bool Skip;
1278   FieldSeparator() : Skip(true) {}
1279 };
1280 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1281   if (FS.Skip) {
1282     FS.Skip = false;
1283     return OS;
1284   }
1285   return OS << ", ";
1286 }
1287 } // end namespace
1288
1289 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1290                                    TypePrinting *TypePrinter,
1291                                    SlotTracker *Machine,
1292                                    const Module *Context) {
1293   if (!MD) {
1294     Out << "null";
1295     return;
1296   }
1297   WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1298 }
1299
1300 static void writeTag(raw_ostream &Out, FieldSeparator &FS, const DebugNode *N) {
1301   Out << FS << "tag: ";
1302   if (const char *Tag = dwarf::TagString(N->getTag()))
1303     Out << Tag;
1304   else
1305     Out << N->getTag();
1306 }
1307
1308 static void writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
1309                                   TypePrinting *TypePrinter,
1310                                   SlotTracker *Machine, const Module *Context) {
1311   Out << "!GenericDebugNode(";
1312   FieldSeparator FS;
1313   writeTag(Out, FS, N);
1314   if (!N->getHeader().empty()) {
1315     Out << FS << "header: \"";
1316     PrintEscapedString(N->getHeader(), Out);
1317     Out << "\"";
1318   }
1319   if (N->getNumDwarfOperands()) {
1320     Out << FS << "operands: {";
1321     FieldSeparator IFS;
1322     for (auto &I : N->dwarf_operands()) {
1323       Out << IFS;
1324       writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1325     }
1326     Out << "}";
1327   }
1328   Out << ")";
1329 }
1330
1331 static void writeMDLocation(raw_ostream &Out, const MDLocation *DL,
1332                             TypePrinting *TypePrinter, SlotTracker *Machine,
1333                             const Module *Context) {
1334   Out << "!MDLocation(";
1335   FieldSeparator FS;
1336   // Always output the line, since 0 is a relevant and important value for it.
1337   Out << FS << "line: " << DL->getLine();
1338   if (DL->getColumn())
1339     Out << FS << "column: " << DL->getColumn();
1340   Out << FS << "scope: ";
1341   WriteAsOperandInternal(Out, DL->getScope(), TypePrinter, Machine, Context);
1342   if (DL->getInlinedAt()) {
1343     Out << FS << "inlinedAt: ";
1344     WriteAsOperandInternal(Out, DL->getInlinedAt(), TypePrinter, Machine,
1345                            Context);
1346   }
1347   Out << ")";
1348 }
1349
1350 static void writeMDSubrange(raw_ostream &Out, const MDSubrange *N,
1351                             TypePrinting *, SlotTracker *, const Module *) {
1352   Out << "!MDSubrange(";
1353   FieldSeparator FS;
1354   Out << FS << "count: " << N->getCount();
1355   if (N->getLo())
1356     Out << FS << "lowerBound: " << N->getLo();
1357   Out << ")";
1358 }
1359
1360 static void writeMDEnumerator(raw_ostream &Out, const MDEnumerator *N,
1361                               TypePrinting *, SlotTracker *, const Module *) {
1362   Out << "!MDEnumerator(";
1363   FieldSeparator FS;
1364   Out << FS << "value: " << N->getValue();
1365   Out << FS << "name: \"" << N->getName() << "\"";
1366   Out << ")";
1367 }
1368
1369 static void writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
1370                              TypePrinting *, SlotTracker *, const Module *) {
1371   Out << "!MDBasicType(";
1372   FieldSeparator FS;
1373   writeTag(Out, FS, N);
1374   if (!N->getName().empty())
1375     Out << FS << "name: \"" << N->getName() << "\"";
1376   if (N->getSizeInBits())
1377     Out << FS << "size: " << N->getSizeInBits();
1378   if (N->getAlignInBits())
1379     Out << FS << "align: " << N->getAlignInBits();
1380   if (unsigned Encoding = N->getEncoding()) {
1381     Out << FS << "encoding: ";
1382     if (const char *S = dwarf::AttributeEncodingString(Encoding))
1383       Out << S;
1384     else
1385       Out << Encoding;
1386   }
1387   Out << ")";
1388 }
1389
1390 static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
1391                                TypePrinting *TypePrinter, SlotTracker *Machine,
1392                                const Module *Context) {
1393   Out << "!MDDerivedType(";
1394   FieldSeparator FS;
1395   writeTag(Out, FS, N);
1396   if (!N->getName().empty())
1397     Out << FS << "name: \"" << N->getName() << "\"";
1398   if (N->getFile()) {
1399     Out << FS << "file: ";
1400     writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1401                            Context);
1402   }
1403   if (N->getLine())
1404     Out << FS << "line: " << N->getLine();
1405   if (N->getScope()) {
1406     Out << FS << "scope: ";
1407     writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1408   }
1409   Out << FS << "baseType: ";
1410   writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine, Context);
1411   if (N->getSizeInBits())
1412     Out << FS << "size: " << N->getSizeInBits();
1413   if (N->getAlignInBits())
1414     Out << FS << "align: " << N->getAlignInBits();
1415   if (N->getOffsetInBits())
1416     Out << FS << "offset: " << N->getOffsetInBits();
1417   if (N->getFlags())
1418     Out << FS << "flags: " << N->getFlags();
1419   if (N->getExtraData()) {
1420     Out << FS << "extraData: ";
1421     writeMetadataAsOperand(Out, N->getExtraData(), TypePrinter, Machine,
1422                            Context);
1423   }
1424   Out << ")";
1425 }
1426
1427 static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
1428                                  TypePrinting *TypePrinter,
1429                                  SlotTracker *Machine, const Module *Context) {
1430   Out << "!MDCompositeType(";
1431   FieldSeparator FS;
1432   writeTag(Out, FS, N);
1433   if (!N->getName().empty())
1434     Out << FS << "name: \"" << N->getName() << "\"";
1435   if (N->getFile()) {
1436     Out << FS << "file: ";
1437     writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1438                            Context);
1439   }
1440   if (N->getLine())
1441     Out << FS << "line: " << N->getLine();
1442   if (N->getScope()) {
1443     Out << FS << "scope: ";
1444     writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1445   }
1446   if (N->getBaseType()) {
1447     Out << FS << "baseType: ";
1448     writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine,
1449                            Context);
1450   }
1451   if (N->getSizeInBits())
1452     Out << FS << "size: " << N->getSizeInBits();
1453   if (N->getAlignInBits())
1454     Out << FS << "align: " << N->getAlignInBits();
1455   if (N->getOffsetInBits())
1456     Out << FS << "offset: " << N->getOffsetInBits();
1457   if (N->getFlags())
1458     Out << FS << "flags: " << N->getFlags();
1459   if (N->getElements()) {
1460     Out << FS << "elements: ";
1461     writeMetadataAsOperand(Out, N->getElements(), TypePrinter, Machine,
1462                            Context);
1463   }
1464   if (unsigned Lang = N->getRuntimeLang()) {
1465     Out << FS << "runtimeLang: ";
1466     if (const char *S = dwarf::LanguageString(Lang))
1467       Out << S;
1468     else
1469       Out << Lang;
1470   }
1471
1472   if (N->getVTableHolder()) {
1473     Out << FS << "vtableHolder: ";
1474     writeMetadataAsOperand(Out, N->getVTableHolder(), TypePrinter, Machine,
1475                            Context);
1476   }
1477   if (N->getTemplateParams()) {
1478     Out << FS << "templateParams: ";
1479     writeMetadataAsOperand(Out, N->getTemplateParams(), TypePrinter, Machine,
1480                            Context);
1481   }
1482   if (!N->getIdentifier().empty())
1483     Out << FS << "identifier: \"" << N->getIdentifier() << "\"";
1484   Out << ")";
1485 }
1486
1487 static void writeMDSubroutineType(raw_ostream &Out, const MDSubroutineType *N,
1488                                   TypePrinting *TypePrinter,
1489                                   SlotTracker *Machine, const Module *Context) {
1490   Out << "!MDSubroutineType(";
1491   FieldSeparator FS;
1492   if (N->getFlags())
1493     Out << FS << "flags: " << N->getFlags();
1494   Out << FS << "types: ";
1495   writeMetadataAsOperand(Out, N->getTypeArray(), TypePrinter, Machine, Context);
1496   Out << ")";
1497 }
1498
1499 static void writeMDFile(raw_ostream &Out, const MDFile *N, TypePrinting *,
1500                         SlotTracker *, const Module *) {
1501   Out << "!MDFile(";
1502   FieldSeparator FS;
1503   Out << FS << "filename: \"" << N->getFilename() << "\"";
1504   Out << FS << "directory: \"" << N->getDirectory() << "\"";
1505   Out << ")";
1506 }
1507
1508 static void writeMDCompileUnit(raw_ostream &, const MDCompileUnit *,
1509                                TypePrinting *, SlotTracker *, const Module *) {
1510   llvm_unreachable("write not implemented");
1511 }
1512 static void writeMDSubprogram(raw_ostream &, const MDSubprogram *,
1513                               TypePrinting *, SlotTracker *, const Module *) {
1514   llvm_unreachable("write not implemented");
1515 }
1516 static void writeMDLexicalBlock(raw_ostream &, const MDLexicalBlock *,
1517                                 TypePrinting *, SlotTracker *, const Module *) {
1518   llvm_unreachable("write not implemented");
1519 }
1520 static void writeMDLexicalBlockFile(raw_ostream &, const MDLexicalBlockFile *,
1521                                     TypePrinting *, SlotTracker *,
1522                                     const Module *) {
1523   llvm_unreachable("write not implemented");
1524 }
1525 static void writeMDNamespace(raw_ostream &, const MDNamespace *, TypePrinting *,
1526                              SlotTracker *, const Module *) {
1527   llvm_unreachable("write not implemented");
1528 }
1529 static void writeMDTemplateTypeParameter(raw_ostream &,
1530                                          const MDTemplateTypeParameter *,
1531                                          TypePrinting *, SlotTracker *,
1532                                          const Module *) {
1533   llvm_unreachable("write not implemented");
1534 }
1535 static void writeMDTemplateValueParameter(raw_ostream &,
1536                                           const MDTemplateValueParameter *,
1537                                           TypePrinting *, SlotTracker *,
1538                                           const Module *) {
1539   llvm_unreachable("write not implemented");
1540 }
1541 static void writeMDGlobalVariable(raw_ostream &, const MDGlobalVariable *,
1542                                   TypePrinting *, SlotTracker *,
1543                                   const Module *) {
1544   llvm_unreachable("write not implemented");
1545 }
1546 static void writeMDLocalVariable(raw_ostream &, const MDLocalVariable *,
1547                                  TypePrinting *, SlotTracker *,
1548                                  const Module *) {
1549   llvm_unreachable("write not implemented");
1550 }
1551 static void writeMDExpression(raw_ostream &, const MDExpression *,
1552                               TypePrinting *, SlotTracker *, const Module *) {
1553   llvm_unreachable("write not implemented");
1554 }
1555 static void writeMDObjCProperty(raw_ostream &, const MDObjCProperty *,
1556                                 TypePrinting *, SlotTracker *, const Module *) {
1557   llvm_unreachable("write not implemented");
1558 }
1559 static void writeMDImportedEntity(raw_ostream &, const MDImportedEntity *,
1560                                   TypePrinting *, SlotTracker *,
1561                                   const Module *) {
1562   llvm_unreachable("write not implemented");
1563 }
1564
1565 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1566                                     TypePrinting *TypePrinter,
1567                                     SlotTracker *Machine,
1568                                     const Module *Context) {
1569   assert(!Node->isTemporary() && "Unexpected forward declaration");
1570
1571   if (Node->isDistinct())
1572     Out << "distinct ";
1573
1574   switch (Node->getMetadataID()) {
1575   default:
1576     llvm_unreachable("Expected uniquable MDNode");
1577 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
1578   case Metadata::CLASS##Kind:                                                  \
1579     write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context);       \
1580     break;
1581 #include "llvm/IR/Metadata.def"
1582   }
1583 }
1584
1585 // Full implementation of printing a Value as an operand with support for
1586 // TypePrinting, etc.
1587 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1588                                    TypePrinting *TypePrinter,
1589                                    SlotTracker *Machine,
1590                                    const Module *Context) {
1591   if (V->hasName()) {
1592     PrintLLVMName(Out, V);
1593     return;
1594   }
1595
1596   const Constant *CV = dyn_cast<Constant>(V);
1597   if (CV && !isa<GlobalValue>(CV)) {
1598     assert(TypePrinter && "Constants require TypePrinting!");
1599     WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1600     return;
1601   }
1602
1603   if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1604     Out << "asm ";
1605     if (IA->hasSideEffects())
1606       Out << "sideeffect ";
1607     if (IA->isAlignStack())
1608       Out << "alignstack ";
1609     // We don't emit the AD_ATT dialect as it's the assumed default.
1610     if (IA->getDialect() == InlineAsm::AD_Intel)
1611       Out << "inteldialect ";
1612     Out << '"';
1613     PrintEscapedString(IA->getAsmString(), Out);
1614     Out << "\", \"";
1615     PrintEscapedString(IA->getConstraintString(), Out);
1616     Out << '"';
1617     return;
1618   }
1619
1620   if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1621     WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1622                            Context, /* FromValue */ true);
1623     return;
1624   }
1625
1626   char Prefix = '%';
1627   int Slot;
1628   // If we have a SlotTracker, use it.
1629   if (Machine) {
1630     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1631       Slot = Machine->getGlobalSlot(GV);
1632       Prefix = '@';
1633     } else {
1634       Slot = Machine->getLocalSlot(V);
1635
1636       // If the local value didn't succeed, then we may be referring to a value
1637       // from a different function.  Translate it, as this can happen when using
1638       // address of blocks.
1639       if (Slot == -1)
1640         if ((Machine = createSlotTracker(V))) {
1641           Slot = Machine->getLocalSlot(V);
1642           delete Machine;
1643         }
1644     }
1645   } else if ((Machine = createSlotTracker(V))) {
1646     // Otherwise, create one to get the # and then destroy it.
1647     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1648       Slot = Machine->getGlobalSlot(GV);
1649       Prefix = '@';
1650     } else {
1651       Slot = Machine->getLocalSlot(V);
1652     }
1653     delete Machine;
1654     Machine = nullptr;
1655   } else {
1656     Slot = -1;
1657   }
1658
1659   if (Slot != -1)
1660     Out << Prefix << Slot;
1661   else
1662     Out << "<badref>";
1663 }
1664
1665 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1666                                    TypePrinting *TypePrinter,
1667                                    SlotTracker *Machine, const Module *Context,
1668                                    bool FromValue) {
1669   if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1670     if (!Machine)
1671       Machine = new SlotTracker(Context);
1672     int Slot = Machine->getMetadataSlot(N);
1673     if (Slot == -1)
1674       // Give the pointer value instead of "badref", since this comes up all
1675       // the time when debugging.
1676       Out << "<" << N << ">";
1677     else
1678       Out << '!' << Slot;
1679     return;
1680   }
1681
1682   if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1683     Out << "!\"";
1684     PrintEscapedString(MDS->getString(), Out);
1685     Out << '"';
1686     return;
1687   }
1688
1689   auto *V = cast<ValueAsMetadata>(MD);
1690   assert(TypePrinter && "TypePrinter required for metadata values");
1691   assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1692          "Unexpected function-local metadata outside of value argument");
1693
1694   TypePrinter->print(V->getValue()->getType(), Out);
1695   Out << ' ';
1696   WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1697 }
1698
1699 void AssemblyWriter::init() {
1700   if (!TheModule)
1701     return;
1702   TypePrinter.incorporateTypes(*TheModule);
1703   for (const Function &F : *TheModule)
1704     if (const Comdat *C = F.getComdat())
1705       Comdats.insert(C);
1706   for (const GlobalVariable &GV : TheModule->globals())
1707     if (const Comdat *C = GV.getComdat())
1708       Comdats.insert(C);
1709 }
1710
1711
1712 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1713                                const Module *M,
1714                                AssemblyAnnotationWriter *AAW)
1715   : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
1716   init();
1717 }
1718
1719 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1720                                AssemblyAnnotationWriter *AAW)
1721   : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
1722     Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
1723   init();
1724 }
1725
1726 AssemblyWriter::~AssemblyWriter() { }
1727
1728 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1729   if (!Operand) {
1730     Out << "<null operand!>";
1731     return;
1732   }
1733   if (PrintType) {
1734     TypePrinter.print(Operand->getType(), Out);
1735     Out << ' ';
1736   }
1737   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1738 }
1739
1740 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
1741                                  SynchronizationScope SynchScope) {
1742   if (Ordering == NotAtomic)
1743     return;
1744
1745   switch (SynchScope) {
1746   case SingleThread: Out << " singlethread"; break;
1747   case CrossThread: break;
1748   }
1749
1750   switch (Ordering) {
1751   default: Out << " <bad ordering " << int(Ordering) << ">"; break;
1752   case Unordered: Out << " unordered"; break;
1753   case Monotonic: Out << " monotonic"; break;
1754   case Acquire: Out << " acquire"; break;
1755   case Release: Out << " release"; break;
1756   case AcquireRelease: Out << " acq_rel"; break;
1757   case SequentiallyConsistent: Out << " seq_cst"; break;
1758   }
1759 }
1760
1761 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1762                                         AtomicOrdering FailureOrdering,
1763                                         SynchronizationScope SynchScope) {
1764   assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
1765
1766   switch (SynchScope) {
1767   case SingleThread: Out << " singlethread"; break;
1768   case CrossThread: break;
1769   }
1770
1771   switch (SuccessOrdering) {
1772   default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
1773   case Unordered: Out << " unordered"; break;
1774   case Monotonic: Out << " monotonic"; break;
1775   case Acquire: Out << " acquire"; break;
1776   case Release: Out << " release"; break;
1777   case AcquireRelease: Out << " acq_rel"; break;
1778   case SequentiallyConsistent: Out << " seq_cst"; break;
1779   }
1780
1781   switch (FailureOrdering) {
1782   default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
1783   case Unordered: Out << " unordered"; break;
1784   case Monotonic: Out << " monotonic"; break;
1785   case Acquire: Out << " acquire"; break;
1786   case Release: Out << " release"; break;
1787   case AcquireRelease: Out << " acq_rel"; break;
1788   case SequentiallyConsistent: Out << " seq_cst"; break;
1789   }
1790 }
1791
1792 void AssemblyWriter::writeParamOperand(const Value *Operand,
1793                                        AttributeSet Attrs, unsigned Idx) {
1794   if (!Operand) {
1795     Out << "<null operand!>";
1796     return;
1797   }
1798
1799   // Print the type
1800   TypePrinter.print(Operand->getType(), Out);
1801   // Print parameter attributes list
1802   if (Attrs.hasAttributes(Idx))
1803     Out << ' ' << Attrs.getAsString(Idx);
1804   Out << ' ';
1805   // Print the operand
1806   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1807 }
1808
1809 void AssemblyWriter::printModule(const Module *M) {
1810   Machine.initialize();
1811
1812   if (shouldPreserveAssemblyUseListOrder())
1813     UseListOrders = predictUseListOrder(M);
1814
1815   if (!M->getModuleIdentifier().empty() &&
1816       // Don't print the ID if it will start a new line (which would
1817       // require a comment char before it).
1818       M->getModuleIdentifier().find('\n') == std::string::npos)
1819     Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1820
1821   const std::string &DL = M->getDataLayoutStr();
1822   if (!DL.empty())
1823     Out << "target datalayout = \"" << DL << "\"\n";
1824   if (!M->getTargetTriple().empty())
1825     Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1826
1827   if (!M->getModuleInlineAsm().empty()) {
1828     // Split the string into lines, to make it easier to read the .ll file.
1829     std::string Asm = M->getModuleInlineAsm();
1830     size_t CurPos = 0;
1831     size_t NewLine = Asm.find_first_of('\n', CurPos);
1832     Out << '\n';
1833     while (NewLine != std::string::npos) {
1834       // We found a newline, print the portion of the asm string from the
1835       // last newline up to this newline.
1836       Out << "module asm \"";
1837       PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1838                          Out);
1839       Out << "\"\n";
1840       CurPos = NewLine+1;
1841       NewLine = Asm.find_first_of('\n', CurPos);
1842     }
1843     std::string rest(Asm.begin()+CurPos, Asm.end());
1844     if (!rest.empty()) {
1845       Out << "module asm \"";
1846       PrintEscapedString(rest, Out);
1847       Out << "\"\n";
1848     }
1849   }
1850
1851   printTypeIdentities();
1852
1853   // Output all comdats.
1854   if (!Comdats.empty())
1855     Out << '\n';
1856   for (const Comdat *C : Comdats) {
1857     printComdat(C);
1858     if (C != Comdats.back())
1859       Out << '\n';
1860   }
1861
1862   // Output all globals.
1863   if (!M->global_empty()) Out << '\n';
1864   for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1865        I != E; ++I) {
1866     printGlobal(I); Out << '\n';
1867   }
1868
1869   // Output all aliases.
1870   if (!M->alias_empty()) Out << "\n";
1871   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1872        I != E; ++I)
1873     printAlias(I);
1874
1875   // Output global use-lists.
1876   printUseLists(nullptr);
1877
1878   // Output all of the functions.
1879   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1880     printFunction(I);
1881   assert(UseListOrders.empty() && "All use-lists should have been consumed");
1882
1883   // Output all attribute groups.
1884   if (!Machine.as_empty()) {
1885     Out << '\n';
1886     writeAllAttributeGroups();
1887   }
1888
1889   // Output named metadata.
1890   if (!M->named_metadata_empty()) Out << '\n';
1891
1892   for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1893        E = M->named_metadata_end(); I != E; ++I)
1894     printNamedMDNode(I);
1895
1896   // Output metadata.
1897   if (!Machine.mdn_empty()) {
1898     Out << '\n';
1899     writeAllMDNodes();
1900   }
1901 }
1902
1903 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1904   Out << '!';
1905   StringRef Name = NMD->getName();
1906   if (Name.empty()) {
1907     Out << "<empty name> ";
1908   } else {
1909     if (isalpha(static_cast<unsigned char>(Name[0])) ||
1910         Name[0] == '-' || Name[0] == '$' ||
1911         Name[0] == '.' || Name[0] == '_')
1912       Out << Name[0];
1913     else
1914       Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
1915     for (unsigned i = 1, e = Name.size(); i != e; ++i) {
1916       unsigned char C = Name[i];
1917       if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
1918           C == '.' || C == '_')
1919         Out << C;
1920       else
1921         Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1922     }
1923   }
1924   Out << " = !{";
1925   for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1926     if (i) Out << ", ";
1927     int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
1928     if (Slot == -1)
1929       Out << "<badref>";
1930     else
1931       Out << '!' << Slot;
1932   }
1933   Out << "}\n";
1934 }
1935
1936
1937 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1938                          formatted_raw_ostream &Out) {
1939   switch (LT) {
1940   case GlobalValue::ExternalLinkage: break;
1941   case GlobalValue::PrivateLinkage:       Out << "private ";        break;
1942   case GlobalValue::InternalLinkage:      Out << "internal ";       break;
1943   case GlobalValue::LinkOnceAnyLinkage:   Out << "linkonce ";       break;
1944   case GlobalValue::LinkOnceODRLinkage:   Out << "linkonce_odr ";   break;
1945   case GlobalValue::WeakAnyLinkage:       Out << "weak ";           break;
1946   case GlobalValue::WeakODRLinkage:       Out << "weak_odr ";       break;
1947   case GlobalValue::CommonLinkage:        Out << "common ";         break;
1948   case GlobalValue::AppendingLinkage:     Out << "appending ";      break;
1949   case GlobalValue::ExternalWeakLinkage:  Out << "extern_weak ";    break;
1950   case GlobalValue::AvailableExternallyLinkage:
1951     Out << "available_externally ";
1952     break;
1953   }
1954 }
1955
1956
1957 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1958                             formatted_raw_ostream &Out) {
1959   switch (Vis) {
1960   case GlobalValue::DefaultVisibility: break;
1961   case GlobalValue::HiddenVisibility:    Out << "hidden "; break;
1962   case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1963   }
1964 }
1965
1966 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
1967                                  formatted_raw_ostream &Out) {
1968   switch (SCT) {
1969   case GlobalValue::DefaultStorageClass: break;
1970   case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
1971   case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
1972   }
1973 }
1974
1975 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
1976                                   formatted_raw_ostream &Out) {
1977   switch (TLM) {
1978     case GlobalVariable::NotThreadLocal:
1979       break;
1980     case GlobalVariable::GeneralDynamicTLSModel:
1981       Out << "thread_local ";
1982       break;
1983     case GlobalVariable::LocalDynamicTLSModel:
1984       Out << "thread_local(localdynamic) ";
1985       break;
1986     case GlobalVariable::InitialExecTLSModel:
1987       Out << "thread_local(initialexec) ";
1988       break;
1989     case GlobalVariable::LocalExecTLSModel:
1990       Out << "thread_local(localexec) ";
1991       break;
1992   }
1993 }
1994
1995 static void maybePrintComdat(formatted_raw_ostream &Out,
1996                              const GlobalObject &GO) {
1997   const Comdat *C = GO.getComdat();
1998   if (!C)
1999     return;
2000
2001   if (isa<GlobalVariable>(GO))
2002     Out << ',';
2003   Out << " comdat";
2004
2005   if (GO.getName() == C->getName())
2006     return;
2007
2008   Out << '(';
2009   PrintLLVMName(Out, C->getName(), ComdatPrefix);
2010   Out << ')';
2011 }
2012
2013 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2014   if (GV->isMaterializable())
2015     Out << "; Materializable\n";
2016
2017   WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2018   Out << " = ";
2019
2020   if (!GV->hasInitializer() && GV->hasExternalLinkage())
2021     Out << "external ";
2022
2023   PrintLinkage(GV->getLinkage(), Out);
2024   PrintVisibility(GV->getVisibility(), Out);
2025   PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2026   PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2027   if (GV->hasUnnamedAddr())
2028     Out << "unnamed_addr ";
2029
2030   if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2031     Out << "addrspace(" << AddressSpace << ") ";
2032   if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2033   Out << (GV->isConstant() ? "constant " : "global ");
2034   TypePrinter.print(GV->getType()->getElementType(), Out);
2035
2036   if (GV->hasInitializer()) {
2037     Out << ' ';
2038     writeOperand(GV->getInitializer(), false);
2039   }
2040
2041   if (GV->hasSection()) {
2042     Out << ", section \"";
2043     PrintEscapedString(GV->getSection(), Out);
2044     Out << '"';
2045   }
2046   maybePrintComdat(Out, *GV);
2047   if (GV->getAlignment())
2048     Out << ", align " << GV->getAlignment();
2049
2050   printInfoComment(*GV);
2051 }
2052
2053 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2054   if (GA->isMaterializable())
2055     Out << "; Materializable\n";
2056
2057   // Don't crash when dumping partially built GA
2058   if (!GA->hasName())
2059     Out << "<<nameless>> = ";
2060   else {
2061     PrintLLVMName(Out, GA);
2062     Out << " = ";
2063   }
2064   PrintLinkage(GA->getLinkage(), Out);
2065   PrintVisibility(GA->getVisibility(), Out);
2066   PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2067   PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2068   if (GA->hasUnnamedAddr())
2069     Out << "unnamed_addr ";
2070
2071   Out << "alias ";
2072
2073   const Constant *Aliasee = GA->getAliasee();
2074
2075   if (!Aliasee) {
2076     TypePrinter.print(GA->getType(), Out);
2077     Out << " <<NULL ALIASEE>>";
2078   } else {
2079     writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2080   }
2081
2082   printInfoComment(*GA);
2083   Out << '\n';
2084 }
2085
2086 void AssemblyWriter::printComdat(const Comdat *C) {
2087   C->print(Out);
2088 }
2089
2090 void AssemblyWriter::printTypeIdentities() {
2091   if (TypePrinter.NumberedTypes.empty() &&
2092       TypePrinter.NamedTypes.empty())
2093     return;
2094
2095   Out << '\n';
2096
2097   // We know all the numbers that each type is used and we know that it is a
2098   // dense assignment.  Convert the map to an index table.
2099   std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2100   for (DenseMap<StructType*, unsigned>::iterator I =
2101        TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2102        I != E; ++I) {
2103     assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2104     NumberedTypes[I->second] = I->first;
2105   }
2106
2107   // Emit all numbered types.
2108   for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2109     Out << '%' << i << " = type ";
2110
2111     // Make sure we print out at least one level of the type structure, so
2112     // that we do not get %2 = type %2
2113     TypePrinter.printStructBody(NumberedTypes[i], Out);
2114     Out << '\n';
2115   }
2116
2117   for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2118     PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2119     Out << " = type ";
2120
2121     // Make sure we print out at least one level of the type structure, so
2122     // that we do not get %FILE = type %FILE
2123     TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2124     Out << '\n';
2125   }
2126 }
2127
2128 /// printFunction - Print all aspects of a function.
2129 ///
2130 void AssemblyWriter::printFunction(const Function *F) {
2131   // Print out the return type and name.
2132   Out << '\n';
2133
2134   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2135
2136   if (F->isMaterializable())
2137     Out << "; Materializable\n";
2138
2139   const AttributeSet &Attrs = F->getAttributes();
2140   if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2141     AttributeSet AS = Attrs.getFnAttributes();
2142     std::string AttrStr;
2143
2144     unsigned Idx = 0;
2145     for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2146       if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2147         break;
2148
2149     for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2150          I != E; ++I) {
2151       Attribute Attr = *I;
2152       if (!Attr.isStringAttribute()) {
2153         if (!AttrStr.empty()) AttrStr += ' ';
2154         AttrStr += Attr.getAsString();
2155       }
2156     }
2157
2158     if (!AttrStr.empty())
2159       Out << "; Function Attrs: " << AttrStr << '\n';
2160   }
2161
2162   if (F->isDeclaration())
2163     Out << "declare ";
2164   else
2165     Out << "define ";
2166
2167   PrintLinkage(F->getLinkage(), Out);
2168   PrintVisibility(F->getVisibility(), Out);
2169   PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2170
2171   // Print the calling convention.
2172   if (F->getCallingConv() != CallingConv::C) {
2173     PrintCallingConv(F->getCallingConv(), Out);
2174     Out << " ";
2175   }
2176
2177   FunctionType *FT = F->getFunctionType();
2178   if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2179     Out <<  Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2180   TypePrinter.print(F->getReturnType(), Out);
2181   Out << ' ';
2182   WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2183   Out << '(';
2184   Machine.incorporateFunction(F);
2185
2186   // Loop over the arguments, printing them...
2187
2188   unsigned Idx = 1;
2189   if (!F->isDeclaration()) {
2190     // If this isn't a declaration, print the argument names as well.
2191     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2192          I != E; ++I) {
2193       // Insert commas as we go... the first arg doesn't get a comma
2194       if (I != F->arg_begin()) Out << ", ";
2195       printArgument(I, Attrs, Idx);
2196       Idx++;
2197     }
2198   } else {
2199     // Otherwise, print the types from the function type.
2200     for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2201       // Insert commas as we go... the first arg doesn't get a comma
2202       if (i) Out << ", ";
2203
2204       // Output type...
2205       TypePrinter.print(FT->getParamType(i), Out);
2206
2207       if (Attrs.hasAttributes(i+1))
2208         Out << ' ' << Attrs.getAsString(i+1);
2209     }
2210   }
2211
2212   // Finish printing arguments...
2213   if (FT->isVarArg()) {
2214     if (FT->getNumParams()) Out << ", ";
2215     Out << "...";  // Output varargs portion of signature!
2216   }
2217   Out << ')';
2218   if (F->hasUnnamedAddr())
2219     Out << " unnamed_addr";
2220   if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2221     Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2222   if (F->hasSection()) {
2223     Out << " section \"";
2224     PrintEscapedString(F->getSection(), Out);
2225     Out << '"';
2226   }
2227   maybePrintComdat(Out, *F);
2228   if (F->getAlignment())
2229     Out << " align " << F->getAlignment();
2230   if (F->hasGC())
2231     Out << " gc \"" << F->getGC() << '"';
2232   if (F->hasPrefixData()) {
2233     Out << " prefix ";
2234     writeOperand(F->getPrefixData(), true);
2235   }
2236   if (F->hasPrologueData()) {
2237     Out << " prologue ";
2238     writeOperand(F->getPrologueData(), true);
2239   }
2240
2241   if (F->isDeclaration()) {
2242     Out << '\n';
2243   } else {
2244     Out << " {";
2245     // Output all of the function's basic blocks.
2246     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2247       printBasicBlock(I);
2248
2249     // Output the function's use-lists.
2250     printUseLists(F);
2251
2252     Out << "}\n";
2253   }
2254
2255   Machine.purgeFunction();
2256 }
2257
2258 /// printArgument - This member is called for every argument that is passed into
2259 /// the function.  Simply print it out
2260 ///
2261 void AssemblyWriter::printArgument(const Argument *Arg,
2262                                    AttributeSet Attrs, unsigned Idx) {
2263   // Output type...
2264   TypePrinter.print(Arg->getType(), Out);
2265
2266   // Output parameter attributes list
2267   if (Attrs.hasAttributes(Idx))
2268     Out << ' ' << Attrs.getAsString(Idx);
2269
2270   // Output name, if available...
2271   if (Arg->hasName()) {
2272     Out << ' ';
2273     PrintLLVMName(Out, Arg);
2274   }
2275 }
2276
2277 /// printBasicBlock - This member is called for each basic block in a method.
2278 ///
2279 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2280   if (BB->hasName()) {              // Print out the label if it exists...
2281     Out << "\n";
2282     PrintLLVMName(Out, BB->getName(), LabelPrefix);
2283     Out << ':';
2284   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
2285     Out << "\n; <label>:";
2286     int Slot = Machine.getLocalSlot(BB);
2287     if (Slot != -1)
2288       Out << Slot;
2289     else
2290       Out << "<badref>";
2291   }
2292
2293   if (!BB->getParent()) {
2294     Out.PadToColumn(50);
2295     Out << "; Error: Block without parent!";
2296   } else if (BB != &BB->getParent()->getEntryBlock()) {  // Not the entry block?
2297     // Output predecessors for the block.
2298     Out.PadToColumn(50);
2299     Out << ";";
2300     const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2301
2302     if (PI == PE) {
2303       Out << " No predecessors!";
2304     } else {
2305       Out << " preds = ";
2306       writeOperand(*PI, false);
2307       for (++PI; PI != PE; ++PI) {
2308         Out << ", ";
2309         writeOperand(*PI, false);
2310       }
2311     }
2312   }
2313
2314   Out << "\n";
2315
2316   if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2317
2318   // Output all of the instructions in the basic block...
2319   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2320     printInstructionLine(*I);
2321   }
2322
2323   if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2324 }
2325
2326 /// printInstructionLine - Print an instruction and a newline character.
2327 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2328   printInstruction(I);
2329   Out << '\n';
2330 }
2331
2332 /// printInfoComment - Print a little comment after the instruction indicating
2333 /// which slot it occupies.
2334 ///
2335 void AssemblyWriter::printInfoComment(const Value &V) {
2336   if (AnnotationWriter)
2337     AnnotationWriter->printInfoComment(V, Out);
2338 }
2339
2340 // This member is called for each Instruction in a function..
2341 void AssemblyWriter::printInstruction(const Instruction &I) {
2342   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2343
2344   // Print out indentation for an instruction.
2345   Out << "  ";
2346
2347   // Print out name if it exists...
2348   if (I.hasName()) {
2349     PrintLLVMName(Out, &I);
2350     Out << " = ";
2351   } else if (!I.getType()->isVoidTy()) {
2352     // Print out the def slot taken.
2353     int SlotNum = Machine.getLocalSlot(&I);
2354     if (SlotNum == -1)
2355       Out << "<badref> = ";
2356     else
2357       Out << '%' << SlotNum << " = ";
2358   }
2359
2360   if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2361     if (CI->isMustTailCall())
2362       Out << "musttail ";
2363     else if (CI->isTailCall())
2364       Out << "tail ";
2365   }
2366
2367   // Print out the opcode...
2368   Out << I.getOpcodeName();
2369
2370   // If this is an atomic load or store, print out the atomic marker.
2371   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isAtomic()) ||
2372       (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2373     Out << " atomic";
2374
2375   if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2376     Out << " weak";
2377
2378   // If this is a volatile operation, print out the volatile marker.
2379   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
2380       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2381       (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2382       (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2383     Out << " volatile";
2384
2385   // Print out optimization information.
2386   WriteOptimizationInfo(Out, &I);
2387
2388   // Print out the compare instruction predicates
2389   if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2390     Out << ' ' << getPredicateText(CI->getPredicate());
2391
2392   // Print out the atomicrmw operation
2393   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2394     writeAtomicRMWOperation(Out, RMWI->getOperation());
2395
2396   // Print out the type of the operands...
2397   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2398
2399   // Special case conditional branches to swizzle the condition out to the front
2400   if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2401     const BranchInst &BI(cast<BranchInst>(I));
2402     Out << ' ';
2403     writeOperand(BI.getCondition(), true);
2404     Out << ", ";
2405     writeOperand(BI.getSuccessor(0), true);
2406     Out << ", ";
2407     writeOperand(BI.getSuccessor(1), true);
2408
2409   } else if (isa<SwitchInst>(I)) {
2410     const SwitchInst& SI(cast<SwitchInst>(I));
2411     // Special case switch instruction to get formatting nice and correct.
2412     Out << ' ';
2413     writeOperand(SI.getCondition(), true);
2414     Out << ", ";
2415     writeOperand(SI.getDefaultDest(), true);
2416     Out << " [";
2417     for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2418          i != e; ++i) {
2419       Out << "\n    ";
2420       writeOperand(i.getCaseValue(), true);
2421       Out << ", ";
2422       writeOperand(i.getCaseSuccessor(), true);
2423     }
2424     Out << "\n  ]";
2425   } else if (isa<IndirectBrInst>(I)) {
2426     // Special case indirectbr instruction to get formatting nice and correct.
2427     Out << ' ';
2428     writeOperand(Operand, true);
2429     Out << ", [";
2430
2431     for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2432       if (i != 1)
2433         Out << ", ";
2434       writeOperand(I.getOperand(i), true);
2435     }
2436     Out << ']';
2437   } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2438     Out << ' ';
2439     TypePrinter.print(I.getType(), Out);
2440     Out << ' ';
2441
2442     for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2443       if (op) Out << ", ";
2444       Out << "[ ";
2445       writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2446       writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2447     }
2448   } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2449     Out << ' ';
2450     writeOperand(I.getOperand(0), true);
2451     for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2452       Out << ", " << *i;
2453   } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2454     Out << ' ';
2455     writeOperand(I.getOperand(0), true); Out << ", ";
2456     writeOperand(I.getOperand(1), true);
2457     for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2458       Out << ", " << *i;
2459   } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2460     Out << ' ';
2461     TypePrinter.print(I.getType(), Out);
2462     Out << " personality ";
2463     writeOperand(I.getOperand(0), true); Out << '\n';
2464
2465     if (LPI->isCleanup())
2466       Out << "          cleanup";
2467
2468     for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2469       if (i != 0 || LPI->isCleanup()) Out << "\n";
2470       if (LPI->isCatch(i))
2471         Out << "          catch ";
2472       else
2473         Out << "          filter ";
2474
2475       writeOperand(LPI->getClause(i), true);
2476     }
2477   } else if (isa<ReturnInst>(I) && !Operand) {
2478     Out << " void";
2479   } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2480     // Print the calling convention being used.
2481     if (CI->getCallingConv() != CallingConv::C) {
2482       Out << " ";
2483       PrintCallingConv(CI->getCallingConv(), Out);
2484     }
2485
2486     Operand = CI->getCalledValue();
2487     PointerType *PTy = cast<PointerType>(Operand->getType());
2488     FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2489     Type *RetTy = FTy->getReturnType();
2490     const AttributeSet &PAL = CI->getAttributes();
2491
2492     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2493       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2494
2495     // If possible, print out the short form of the call instruction.  We can
2496     // only do this if the first argument is a pointer to a nonvararg function,
2497     // and if the return type is not a pointer to a function.
2498     //
2499     Out << ' ';
2500     if (!FTy->isVarArg() &&
2501         (!RetTy->isPointerTy() ||
2502          !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2503       TypePrinter.print(RetTy, Out);
2504       Out << ' ';
2505       writeOperand(Operand, false);
2506     } else {
2507       writeOperand(Operand, true);
2508     }
2509     Out << '(';
2510     for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2511       if (op > 0)
2512         Out << ", ";
2513       writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2514     }
2515
2516     // Emit an ellipsis if this is a musttail call in a vararg function.  This
2517     // is only to aid readability, musttail calls forward varargs by default.
2518     if (CI->isMustTailCall() && CI->getParent() &&
2519         CI->getParent()->getParent() &&
2520         CI->getParent()->getParent()->isVarArg())
2521       Out << ", ...";
2522
2523     Out << ')';
2524     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2525       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2526   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2527     Operand = II->getCalledValue();
2528     PointerType *PTy = cast<PointerType>(Operand->getType());
2529     FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2530     Type *RetTy = FTy->getReturnType();
2531     const AttributeSet &PAL = II->getAttributes();
2532
2533     // Print the calling convention being used.
2534     if (II->getCallingConv() != CallingConv::C) {
2535       Out << " ";
2536       PrintCallingConv(II->getCallingConv(), Out);
2537     }
2538
2539     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2540       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2541
2542     // If possible, print out the short form of the invoke instruction. We can
2543     // only do this if the first argument is a pointer to a nonvararg function,
2544     // and if the return type is not a pointer to a function.
2545     //
2546     Out << ' ';
2547     if (!FTy->isVarArg() &&
2548         (!RetTy->isPointerTy() ||
2549          !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2550       TypePrinter.print(RetTy, Out);
2551       Out << ' ';
2552       writeOperand(Operand, false);
2553     } else {
2554       writeOperand(Operand, true);
2555     }
2556     Out << '(';
2557     for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2558       if (op)
2559         Out << ", ";
2560       writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2561     }
2562
2563     Out << ')';
2564     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2565       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2566
2567     Out << "\n          to ";
2568     writeOperand(II->getNormalDest(), true);
2569     Out << " unwind ";
2570     writeOperand(II->getUnwindDest(), true);
2571
2572   } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2573     Out << ' ';
2574     if (AI->isUsedWithInAlloca())
2575       Out << "inalloca ";
2576     TypePrinter.print(AI->getAllocatedType(), Out);
2577     if (!AI->getArraySize() || AI->isArrayAllocation()) {
2578       Out << ", ";
2579       writeOperand(AI->getArraySize(), true);
2580     }
2581     if (AI->getAlignment()) {
2582       Out << ", align " << AI->getAlignment();
2583     }
2584   } else if (isa<CastInst>(I)) {
2585     if (Operand) {
2586       Out << ' ';
2587       writeOperand(Operand, true);   // Work with broken code
2588     }
2589     Out << " to ";
2590     TypePrinter.print(I.getType(), Out);
2591   } else if (isa<VAArgInst>(I)) {
2592     if (Operand) {
2593       Out << ' ';
2594       writeOperand(Operand, true);   // Work with broken code
2595     }
2596     Out << ", ";
2597     TypePrinter.print(I.getType(), Out);
2598   } else if (Operand) {   // Print the normal way.
2599
2600     // PrintAllTypes - Instructions who have operands of all the same type
2601     // omit the type from all but the first operand.  If the instruction has
2602     // different type operands (for example br), then they are all printed.
2603     bool PrintAllTypes = false;
2604     Type *TheType = Operand->getType();
2605
2606     // Select, Store and ShuffleVector always print all types.
2607     if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2608         || isa<ReturnInst>(I)) {
2609       PrintAllTypes = true;
2610     } else {
2611       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2612         Operand = I.getOperand(i);
2613         // note that Operand shouldn't be null, but the test helps make dump()
2614         // more tolerant of malformed IR
2615         if (Operand && Operand->getType() != TheType) {
2616           PrintAllTypes = true;    // We have differing types!  Print them all!
2617           break;
2618         }
2619       }
2620     }
2621
2622     if (!PrintAllTypes) {
2623       Out << ' ';
2624       TypePrinter.print(TheType, Out);
2625     }
2626
2627     Out << ' ';
2628     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2629       if (i) Out << ", ";
2630       writeOperand(I.getOperand(i), PrintAllTypes);
2631     }
2632   }
2633
2634   // Print atomic ordering/alignment for memory operations
2635   if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2636     if (LI->isAtomic())
2637       writeAtomic(LI->getOrdering(), LI->getSynchScope());
2638     if (LI->getAlignment())
2639       Out << ", align " << LI->getAlignment();
2640   } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2641     if (SI->isAtomic())
2642       writeAtomic(SI->getOrdering(), SI->getSynchScope());
2643     if (SI->getAlignment())
2644       Out << ", align " << SI->getAlignment();
2645   } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2646     writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2647                        CXI->getSynchScope());
2648   } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2649     writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2650   } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2651     writeAtomic(FI->getOrdering(), FI->getSynchScope());
2652   }
2653
2654   // Print Metadata info.
2655   SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2656   I.getAllMetadata(InstMD);
2657   if (!InstMD.empty()) {
2658     SmallVector<StringRef, 8> MDNames;
2659     I.getType()->getContext().getMDKindNames(MDNames);
2660     for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2661       unsigned Kind = InstMD[i].first;
2662        if (Kind < MDNames.size()) {
2663          Out << ", !" << MDNames[Kind];
2664        } else {
2665          Out << ", !<unknown kind #" << Kind << ">";
2666        }
2667       Out << ' ';
2668       WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2669                              TheModule);
2670     }
2671   }
2672   printInfoComment(I);
2673 }
2674
2675 static void WriteMDNodeComment(const MDNode *Node,
2676                                formatted_raw_ostream &Out) {
2677   if (Node->getNumOperands() < 1)
2678     return;
2679
2680   Metadata *Op = Node->getOperand(0);
2681   if (!Op || !isa<MDString>(Op))
2682     return;
2683
2684   DIDescriptor Desc(Node);
2685   if (!Desc.Verify())
2686     return;
2687
2688   unsigned Tag = Desc.getTag();
2689   Out.PadToColumn(50);
2690   if (dwarf::TagString(Tag)) {
2691     Out << "; ";
2692     Desc.print(Out);
2693   } else if (Tag == dwarf::DW_TAG_user_base) {
2694     Out << "; [ DW_TAG_user_base ]";
2695   }
2696 }
2697
2698 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2699   Out << '!' << Slot << " = ";
2700   printMDNodeBody(Node);
2701 }
2702
2703 void AssemblyWriter::writeAllMDNodes() {
2704   SmallVector<const MDNode *, 16> Nodes;
2705   Nodes.resize(Machine.mdn_size());
2706   for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2707        I != E; ++I)
2708     Nodes[I->second] = cast<MDNode>(I->first);
2709
2710   for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2711     writeMDNode(i, Nodes[i]);
2712   }
2713 }
2714
2715 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2716   WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
2717   WriteMDNodeComment(Node, Out);
2718   Out << "\n";
2719 }
2720
2721 void AssemblyWriter::writeAllAttributeGroups() {
2722   std::vector<std::pair<AttributeSet, unsigned> > asVec;
2723   asVec.resize(Machine.as_size());
2724
2725   for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
2726        I != E; ++I)
2727     asVec[I->second] = *I;
2728
2729   for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
2730          I = asVec.begin(), E = asVec.end(); I != E; ++I)
2731     Out << "attributes #" << I->second << " = { "
2732         << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
2733 }
2734
2735 } // namespace llvm
2736
2737 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
2738   bool IsInFunction = Machine.getFunction();
2739   if (IsInFunction)
2740     Out << "  ";
2741
2742   Out << "uselistorder";
2743   if (const BasicBlock *BB =
2744           IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
2745     Out << "_bb ";
2746     writeOperand(BB->getParent(), false);
2747     Out << ", ";
2748     writeOperand(BB, false);
2749   } else {
2750     Out << " ";
2751     writeOperand(Order.V, true);
2752   }
2753   Out << ", { ";
2754
2755   assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
2756   Out << Order.Shuffle[0];
2757   for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
2758     Out << ", " << Order.Shuffle[I];
2759   Out << " }\n";
2760 }
2761
2762 void AssemblyWriter::printUseLists(const Function *F) {
2763   auto hasMore =
2764       [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
2765   if (!hasMore())
2766     // Nothing to do.
2767     return;
2768
2769   Out << "\n; uselistorder directives\n";
2770   while (hasMore()) {
2771     printUseListOrder(UseListOrders.back());
2772     UseListOrders.pop_back();
2773   }
2774 }
2775
2776 //===----------------------------------------------------------------------===//
2777 //                       External Interface declarations
2778 //===----------------------------------------------------------------------===//
2779
2780 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2781   SlotTracker SlotTable(this);
2782   formatted_raw_ostream OS(ROS);
2783   AssemblyWriter W(OS, SlotTable, this, AAW);
2784   W.printModule(this);
2785 }
2786
2787 void NamedMDNode::print(raw_ostream &ROS) const {
2788   SlotTracker SlotTable(getParent());
2789   formatted_raw_ostream OS(ROS);
2790   AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
2791   W.printNamedMDNode(this);
2792 }
2793
2794 void Comdat::print(raw_ostream &ROS) const {
2795   PrintLLVMName(ROS, getName(), ComdatPrefix);
2796   ROS << " = comdat ";
2797
2798   switch (getSelectionKind()) {
2799   case Comdat::Any:
2800     ROS << "any";
2801     break;
2802   case Comdat::ExactMatch:
2803     ROS << "exactmatch";
2804     break;
2805   case Comdat::Largest:
2806     ROS << "largest";
2807     break;
2808   case Comdat::NoDuplicates:
2809     ROS << "noduplicates";
2810     break;
2811   case Comdat::SameSize:
2812     ROS << "samesize";
2813     break;
2814   }
2815
2816   ROS << '\n';
2817 }
2818
2819 void Type::print(raw_ostream &OS) const {
2820   TypePrinting TP;
2821   TP.print(const_cast<Type*>(this), OS);
2822
2823   // If the type is a named struct type, print the body as well.
2824   if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
2825     if (!STy->isLiteral()) {
2826       OS << " = type ";
2827       TP.printStructBody(STy, OS);
2828     }
2829 }
2830
2831 void Value::print(raw_ostream &ROS) const {
2832   formatted_raw_ostream OS(ROS);
2833   if (const Instruction *I = dyn_cast<Instruction>(this)) {
2834     const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
2835     SlotTracker SlotTable(F);
2836     AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
2837     W.printInstruction(*I);
2838   } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2839     SlotTracker SlotTable(BB->getParent());
2840     AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
2841     W.printBasicBlock(BB);
2842   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2843     SlotTracker SlotTable(GV->getParent());
2844     AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
2845     if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2846       W.printGlobal(V);
2847     else if (const Function *F = dyn_cast<Function>(GV))
2848       W.printFunction(F);
2849     else
2850       W.printAlias(cast<GlobalAlias>(GV));
2851   } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
2852     V->getMetadata()->print(ROS);
2853   } else if (const Constant *C = dyn_cast<Constant>(this)) {
2854     TypePrinting TypePrinter;
2855     TypePrinter.print(C->getType(), OS);
2856     OS << ' ';
2857     WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
2858   } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
2859     this->printAsOperand(OS);
2860   } else {
2861     llvm_unreachable("Unknown value to print out!");
2862   }
2863 }
2864
2865 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
2866   // Fast path: Don't construct and populate a TypePrinting object if we
2867   // won't be needing any types printed.
2868   if (!PrintType && ((!isa<Constant>(this) && !isa<MetadataAsValue>(this)) ||
2869                      hasName() || isa<GlobalValue>(this))) {
2870     WriteAsOperandInternal(O, this, nullptr, nullptr, M);
2871     return;
2872   }
2873
2874   if (!M)
2875     M = getModuleFromVal(this);
2876
2877   TypePrinting TypePrinter;
2878   if (M)
2879     TypePrinter.incorporateTypes(*M);
2880   if (PrintType) {
2881     TypePrinter.print(getType(), O);
2882     O << ' ';
2883   }
2884
2885   WriteAsOperandInternal(O, this, &TypePrinter, nullptr, M);
2886 }
2887
2888 void Metadata::print(raw_ostream &ROS) const {
2889   formatted_raw_ostream OS(ROS);
2890   if (auto *N = dyn_cast<MDNode>(this)) {
2891     SlotTracker SlotTable(static_cast<Function *>(nullptr));
2892     AssemblyWriter W(OS, SlotTable, nullptr, nullptr);
2893     W.printMDNodeBody(N);
2894
2895     return;
2896   }
2897   printAsOperand(OS);
2898 }
2899
2900 void Metadata::printAsOperand(raw_ostream &ROS, bool PrintType,
2901                               const Module *M) const {
2902   formatted_raw_ostream OS(ROS);
2903
2904   std::unique_ptr<TypePrinting> TypePrinter;
2905   if (PrintType) {
2906     TypePrinter.reset(new TypePrinting);
2907     if (M)
2908       TypePrinter->incorporateTypes(*M);
2909   }
2910   WriteAsOperandInternal(OS, this, TypePrinter.get(), nullptr, M,
2911                          /* FromValue */ true);
2912 }
2913
2914 // Value::dump - allow easy printing of Values from the debugger.
2915 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
2916
2917 // Type::dump - allow easy printing of Types from the debugger.
2918 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
2919
2920 // Module::dump() - Allow printing of Modules from the debugger.
2921 void Module::dump() const { print(dbgs(), nullptr); }
2922
2923 // \brief Allow printing of Comdats from the debugger.
2924 void Comdat::dump() const { print(dbgs()); }
2925
2926 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
2927 void NamedMDNode::dump() const { print(dbgs()); }
2928
2929 void Metadata::dump() const {
2930   print(dbgs());
2931   dbgs() << '\n';
2932 }