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