AsmWriter.cpp

Go to the documentation of this file.

//===- AsmWriter.cpp - Printing LLVM as an assembly file ------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This library implements `print` family of functions in classes like
// Module, Function, Value, etc. In-memory representation of those classes is
// converted to IR strings.
//
// Note that these routines must be extremely tolerant of various errors in the
// LLVM code, because it can be used for debugging transformations.
//
//===----------------------------------------------------------------------===//
 
#include "LLVMContextImpl.h"
#include "llvm/ADT/APFloat.h"
#include "llvm/ADT/APInt.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/STLFunctionalExtras.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/iterator_range.h"
#include "llvm/BinaryFormat/Dwarf.h"
#include "llvm/Config/llvm-config.h"
#include "llvm/IR/Argument.h"
#include "llvm/IR/AssemblyAnnotationWriter.h"
#include "llvm/IR/Attributes.h"
#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/CFG.h"
#include "llvm/IR/CallingConv.h"
#include "llvm/IR/Comdat.h"
#include "llvm/IR/Constant.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DebugInfoMetadata.h"
#include "llvm/IR/DebugProgramInstruction.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GlobalAlias.h"
#include "llvm/IR/GlobalIFunc.h"
#include "llvm/IR/GlobalObject.h"
#include "llvm/IR/GlobalValue.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/IRPrintingPasses.h"
#include "llvm/IR/InlineAsm.h"
#include "llvm/IR/InstrTypes.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/Intrinsics.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Metadata.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/ModuleSlotTracker.h"
#include "llvm/IR/ModuleSummaryIndex.h"
#include "llvm/IR/Operator.h"
#include "llvm/IR/Type.h"
#include "llvm/IR/TypeFinder.h"
#include "llvm/IR/TypedPointerType.h"
#include "llvm/IR/Use.h"
#include "llvm/IR/User.h"
#include "llvm/IR/Value.h"
#include "llvm/Support/AtomicOrdering.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/FormattedStream.h"
#include "llvm/Support/SaveAndRestore.h"
#include "llvm/Support/raw_ostream.h"
#include <cassert>
#include <cctype>
#include <cstddef>
#include <cstdint>
#include <iterator>
#include <memory>
#include <optional>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
 
using namespace llvm;
 
// See https://llvm.org/docs/DebuggingLLVM.html for why these flags are useful.
 
static cl::opt<bool>
    PrintInstAddrs("print-inst-addrs", cl::Hidden,
                   cl::desc("Print addresses of instructions when dumping"));
 
static cl::opt<bool> PrintInstDebugLocs(
    "print-inst-debug-locs", cl::Hidden,
    cl::desc("Pretty print debug locations of instructions when dumping"));
 
static cl::opt<bool> PrintProfData(
    "print-prof-data", cl::Hidden,
    cl::desc("Pretty print perf data (branch weights, etc) when dumping"));
 
static cl::opt<bool> PreserveAssemblyUseListOrder(
    "preserve-ll-uselistorder", cl::Hidden, cl::init(false),
    cl::desc("Preserve use-list order when writing LLVM assembly."));
 
static cl::opt<bool> PrintAddrspaceName("print-addrspace-name", cl::Hidden,
                                        cl::init(false),
                                        cl::desc("Print address space names"));
 
// Make virtual table appear in this compilation unit.
AssemblyAnnotationWriter::~AssemblyAnnotationWriter() = default;
 
//===----------------------------------------------------------------------===//
// Helper Functions
//===----------------------------------------------------------------------===//
 
using OrderMap = MapVector<const Value *, unsigned>;
 
using UseListOrderMap =
    DenseMap<const Function *, MapVector<const Value *, std::vector<unsigned>>>;
 
/// Look for a value that might be wrapped as metadata, e.g. a value in a
/// metadata operand. Returns the input value as-is if it is not wrapped.
static const Value *skipMetadataWrapper(const Value *V) {
  if (const auto *MAV = dyn_cast<MetadataAsValue>(V))
    if (const auto *VAM = dyn_cast<ValueAsMetadata>(MAV->getMetadata()))
      return VAM->getValue();
  return V;
}
 
static void orderValue(const Value *V, OrderMap &OM) {
  if (OM.lookup(V))
    return;
 
  if (const auto *C = dyn_cast<Constant>(V)) {
    if (isa<ConstantData>(C))
      return;
 
    if (C->getNumOperands() && !isa<GlobalValue>(C))
      for (const Value *Op : C->operands())
        if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
          orderValue(Op, OM);
  }
 
  // Note: we cannot cache this lookup above, since inserting into the map
  // changes the map's size, and thus affects the other IDs.
  unsigned ID = OM.size() + 1;
  OM[V] = ID;
}
 
static OrderMap orderModule(const Module *M) {
  OrderMap OM;
 
  auto OrderConstantValue = [&OM](const Value *V) {
    if (isa<Constant>(V) || isa<InlineAsm>(V))
      orderValue(V, OM);
  };
 
  auto OrderConstantFromMetadata = [&](Metadata *MD) {
    if (const auto *VAM = dyn_cast<ValueAsMetadata>(MD)) {
      OrderConstantValue(VAM->getValue());
    } else if (const auto *AL = dyn_cast<DIArgList>(MD)) {
      for (const auto *VAM : AL->getArgs())
        OrderConstantValue(VAM->getValue());
    }
  };
 
  for (const GlobalVariable &G : M->globals()) {
    if (G.hasInitializer())
      if (!isa<GlobalValue>(G.getInitializer()))
        orderValue(G.getInitializer(), OM);
    orderValue(&G, OM);
  }
  for (const GlobalAlias &A : M->aliases()) {
    if (!isa<GlobalValue>(A.getAliasee()))
      orderValue(A.getAliasee(), OM);
    orderValue(&A, OM);
  }
  for (const GlobalIFunc &I : M->ifuncs()) {
    if (!isa<GlobalValue>(I.getResolver()))
      orderValue(I.getResolver(), OM);
    orderValue(&I, OM);
  }
  for (const Function &F : *M) {
    for (const Use &U : F.operands())
      if (!isa<GlobalValue>(U.get()))
        orderValue(U.get(), OM);
 
    orderValue(&F, OM);
 
    if (F.isDeclaration())
      continue;
 
    for (const Argument &A : F.args())
      orderValue(&A, OM);
    for (const BasicBlock &BB : F) {
      orderValue(&BB, OM);
      for (const Instruction &I : BB) {
        // Debug records can contain Value references, that can then contain
        // Values disconnected from the rest of the Value hierachy, if wrapped
        // in some kind of constant-expression. Find and order any Values that
        // are wrapped in debug-info.
        for (DbgVariableRecord &DVR : filterDbgVars(I.getDbgRecordRange())) {
          OrderConstantFromMetadata(DVR.getRawLocation());
          if (DVR.isDbgAssign())
            OrderConstantFromMetadata(DVR.getRawAddress());
        }
 
        for (const Value *Op : I.operands()) {
          Op = skipMetadataWrapper(Op);
          if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
              isa<InlineAsm>(*Op))
            orderValue(Op, OM);
        }
        orderValue(&I, OM);
      }
    }
  }
  return OM;
}
 
static std::vector<unsigned>
predictValueUseListOrder(const Value *V, unsigned ID, const OrderMap &OM) {
  // Predict use-list order for this one.
  using Entry = std::pair<const Use *, unsigned>;
  SmallVector<Entry, 64> List;
  for (const Use &U : V->uses())
    // Check if this user will be serialized.
    if (OM.lookup(U.getUser()))
      List.push_back(std::make_pair(&U, List.size()));
 
  if (List.size() < 2)
    // We may have lost some users.
    return {};
 
  // When referencing a value before its declaration, a temporary value is
  // created, which will later be RAUWed with the actual value. This reverses
  // the use list. This happens for all values apart from basic blocks.
  bool GetsReversed = !isa<BasicBlock>(V);
  if (auto *BA = dyn_cast<BlockAddress>(V))
    ID = OM.lookup(BA->getBasicBlock());
  llvm::sort(List, [&](const Entry &L, const Entry &R) {
    const Use *LU = L.first;
    const Use *RU = R.first;
    if (LU == RU)
      return false;
 
    auto LID = OM.lookup(LU->getUser());
    auto RID = OM.lookup(RU->getUser());
 
    // If ID is 4, then expect: 7 6 5 1 2 3.
    if (LID < RID) {
      if (GetsReversed)
        if (RID <= ID)
          return true;
      return false;
    }
    if (RID < LID) {
      if (GetsReversed)
        if (LID <= ID)
          return false;
      return true;
    }
 
    // LID and RID are equal, so we have different operands of the same user.
    // Assume operands are added in order for all instructions.
    if (GetsReversed)
      if (LID <= ID)
        return LU->getOperandNo() < RU->getOperandNo();
    return LU->getOperandNo() > RU->getOperandNo();
  });
 
  if (llvm::is_sorted(List, llvm::less_second()))
    // Order is already correct.
    return {};
 
  // Store the shuffle.
  std::vector<unsigned> Shuffle(List.size());
  for (size_t I = 0, E = List.size(); I != E; ++I)
    Shuffle[I] = List[I].second;
  return Shuffle;
}
 
static UseListOrderMap predictUseListOrder(const Module *M) {
  OrderMap OM = orderModule(M);
  UseListOrderMap ULOM;
  for (const auto &Pair : OM) {
    const Value *V = Pair.first;
    if (V->use_empty() || std::next(V->use_begin()) == V->use_end())
      continue;
 
    std::vector<unsigned> Shuffle =
        predictValueUseListOrder(V, Pair.second, OM);
    if (Shuffle.empty())
      continue;
 
    const Function *F = nullptr;
    if (auto *I = dyn_cast<Instruction>(V))
      F = I->getFunction();
    if (auto *A = dyn_cast<Argument>(V))
      F = A->getParent();
    if (auto *BB = dyn_cast<BasicBlock>(V))
      F = BB->getParent();
    ULOM[F][V] = std::move(Shuffle);
  }
  return ULOM;
}
 
static const Module *getModuleFromVal(const Value *V) {
  if (const auto *MA = dyn_cast<Argument>(V))
    return MA->getParent() ? MA->getParent()->getParent() : nullptr;
 
  if (const auto *BB = dyn_cast<BasicBlock>(V))
    return BB->getParent() ? BB->getParent()->getParent() : nullptr;
 
  if (const auto *I = dyn_cast<Instruction>(V)) {
    const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
    return M ? M->getParent() : nullptr;
  }
 
  if (const auto *GV = dyn_cast<GlobalValue>(V))
    return GV->getParent();
 
  if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
    for (const User *U : MAV->users())
      if (isa<Instruction>(U))
        if (const Module *M = getModuleFromVal(U))
          return M;
    return nullptr;
  }
 
  return nullptr;
}
 
static const Module *getModuleFromDPI(const DbgMarker *Marker) {
  const Function *M =
      Marker->getParent() ? Marker->getParent()->getParent() : nullptr;
  return M ? M->getParent() : nullptr;
}
 
static const Module *getModuleFromDPI(const DbgRecord *DR) {
  return DR->getMarker() ? getModuleFromDPI(DR->getMarker()) : nullptr;
}
 
static void printCallingConv(unsigned cc, raw_ostream &Out) {
  switch (cc) {
  default:                         Out << "cc" << cc; break;
  case CallingConv::Fast:          Out << "fastcc"; break;
  case CallingConv::Cold:          Out << "coldcc"; break;
  case CallingConv::AnyReg:        Out << "anyregcc"; break;
  case CallingConv::PreserveMost:  Out << "preserve_mostcc"; break;
  case CallingConv::PreserveAll:   Out << "preserve_allcc"; break;
  case CallingConv::PreserveNone:  Out << "preserve_nonecc"; break;
  case CallingConv::CXX_FAST_TLS:  Out << "cxx_fast_tlscc"; break;
  case CallingConv::GHC:           Out << "ghccc"; break;
  case CallingConv::Tail:          Out << "tailcc"; break;
  case CallingConv::GRAAL:         Out << "graalcc"; break;
  case CallingConv::CFGuard_Check: Out << "cfguard_checkcc"; break;
  case CallingConv::X86_StdCall:   Out << "x86_stdcallcc"; break;
  case CallingConv::X86_FastCall:  Out << "x86_fastcallcc"; break;
  case CallingConv::X86_ThisCall:  Out << "x86_thiscallcc"; break;
  case CallingConv::X86_RegCall:   Out << "x86_regcallcc"; break;
  case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
  case CallingConv::Intel_OCL_BI:  Out << "intel_ocl_bicc"; break;
  case CallingConv::ARM_APCS:      Out << "arm_apcscc"; break;
  case CallingConv::ARM_AAPCS:     Out << "arm_aapcscc"; break;
  case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
  case CallingConv::AArch64_VectorCall: Out << "aarch64_vector_pcs"; break;
  case CallingConv::AArch64_SVE_VectorCall:
    Out << "aarch64_sve_vector_pcs";
    break;
  case CallingConv::AArch64_SME_ABI_Support_Routines_PreserveMost_From_X0:
    Out << "aarch64_sme_preservemost_from_x0";
    break;
  case CallingConv::AArch64_SME_ABI_Support_Routines_PreserveMost_From_X1:
    Out << "aarch64_sme_preservemost_from_x1";
    break;
  case CallingConv::AArch64_SME_ABI_Support_Routines_PreserveMost_From_X2:
    Out << "aarch64_sme_preservemost_from_x2";
    break;
  case CallingConv::MSP430_INTR:   Out << "msp430_intrcc"; break;
  case CallingConv::AVR_INTR:      Out << "avr_intrcc "; break;
  case CallingConv::AVR_SIGNAL:    Out << "avr_signalcc "; break;
  case CallingConv::PTX_Kernel:    Out << "ptx_kernel"; break;
  case CallingConv::PTX_Device:    Out << "ptx_device"; break;
  case CallingConv::X86_64_SysV:   Out << "x86_64_sysvcc"; break;
  case CallingConv::Win64:         Out << "win64cc"; break;
  case CallingConv::SPIR_FUNC:     Out << "spir_func"; break;
  case CallingConv::SPIR_KERNEL:   Out << "spir_kernel"; break;
  case CallingConv::Swift:         Out << "swiftcc"; break;
  case CallingConv::SwiftTail:     Out << "swifttailcc"; break;
  case CallingConv::X86_INTR:      Out << "x86_intrcc"; break;
  case CallingConv::DUMMY_HHVM:
    Out << "hhvmcc";
    break;
  case CallingConv::DUMMY_HHVM_C:
    Out << "hhvm_ccc";
    break;
  case CallingConv::AMDGPU_VS:     Out << "amdgpu_vs"; break;
  case CallingConv::AMDGPU_LS:     Out << "amdgpu_ls"; break;
  case CallingConv::AMDGPU_HS:     Out << "amdgpu_hs"; break;
  case CallingConv::AMDGPU_ES:     Out << "amdgpu_es"; break;
  case CallingConv::AMDGPU_GS:     Out << "amdgpu_gs"; break;
  case CallingConv::AMDGPU_PS:     Out << "amdgpu_ps"; break;
  case CallingConv::AMDGPU_CS:     Out << "amdgpu_cs"; break;
  case CallingConv::AMDGPU_CS_Chain:
    Out << "amdgpu_cs_chain";
    break;
  case CallingConv::AMDGPU_CS_ChainPreserve:
    Out << "amdgpu_cs_chain_preserve";
    break;
  case CallingConv::AMDGPU_KERNEL: Out << "amdgpu_kernel"; break;
  case CallingConv::AMDGPU_Gfx:    Out << "amdgpu_gfx"; break;
  case CallingConv::AMDGPU_Gfx_WholeWave:
    Out << "amdgpu_gfx_whole_wave";
    break;
  case CallingConv::M68k_RTD:      Out << "m68k_rtdcc"; break;
  case CallingConv::WASM_EmscriptenInvoke:
    Out << "wasm_emscripten_invokecc";
    break;
  case CallingConv::RISCV_VectorCall:
    Out << "riscv_vector_cc";
    break;
#define CC_VLS_CASE(ABI_VLEN)                                                  \
  case CallingConv::RISCV_VLSCall_##ABI_VLEN:                                  \
    Out << "riscv_vls_cc(" #ABI_VLEN ")";                                      \
    break;
    CC_VLS_CASE(32)
    CC_VLS_CASE(64)
    CC_VLS_CASE(128)
    CC_VLS_CASE(256)
    CC_VLS_CASE(512)
    CC_VLS_CASE(1024)
    CC_VLS_CASE(2048)
    CC_VLS_CASE(4096)
    CC_VLS_CASE(8192)
    CC_VLS_CASE(16384)
    CC_VLS_CASE(32768)
    CC_VLS_CASE(65536)
#undef CC_VLS_CASE
  case CallingConv::CHERIoT_CompartmentCall:
    Out << "cheriot_compartmentcallcc";
    break;
  case CallingConv::CHERIoT_CompartmentCallee:
    Out << "cheriot_compartmentcalleecc";
    break;
  case CallingConv::CHERIoT_LibraryCall:
    Out << "cheriot_librarycallcc";
    break;
  }
}
 
enum PrefixType {
  GlobalPrefix,
  ComdatPrefix,
  LabelPrefix,
  LocalPrefix,
  NoPrefix
};
 
void llvm::printLLVMNameWithoutPrefix(raw_ostream &OS, StringRef Name) {
  assert(!Name.empty() && "Cannot get empty name!");
 
  // Scan the name to see if it needs quotes first.
  bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
  if (!NeedsQuotes) {
    for (unsigned char C : Name) {
      // By making this unsigned, the value passed in to isalnum will always be
      // in the range 0-255.  This is important when building with MSVC because
      // its implementation will assert.  This situation can arise when dealing
      // with UTF-8 multibyte characters.
      if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
        NeedsQuotes = true;
        break;
      }
    }
  }
 
  // If we didn't need any quotes, just write out the name in one blast.
  if (!NeedsQuotes) {
    OS << Name;
    return;
  }
 
  // Okay, we need quotes.  Output the quotes and escape any scary characters as
  // needed.
  OS << '"';
  printEscapedString(Name, OS);
  OS << '"';
}
 
/// Turn the specified name into an 'LLVM name', which is either prefixed with %
/// (if the string only contains simple characters) or is surrounded with ""'s
/// (if it has special chars in it). Print it out.
static void printLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
  switch (Prefix) {
  case NoPrefix:
    break;
  case GlobalPrefix:
    OS << '@';
    break;
  case ComdatPrefix:
    OS << '$';
    break;
  case LabelPrefix:
    break;
  case LocalPrefix:
    OS << '%';
    break;
  }
  printLLVMNameWithoutPrefix(OS, Name);
}
 
/// Turn the specified name into an 'LLVM name', which is either prefixed with %
/// (if the string only contains simple characters) or is surrounded with ""'s
/// (if it has special chars in it). Print it out.
static void printLLVMName(raw_ostream &OS, const Value *V) {
  printLLVMName(OS, V->getName(),
                isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
}
 
static void printShuffleMask(raw_ostream &Out, Type *Ty, ArrayRef<int> Mask) {
  Out << ", <";
  if (isa<ScalableVectorType>(Ty))
    Out << "vscale x ";
  Out << Mask.size() << " x i32> ";
  if (all_of(Mask, equal_to(0))) {
    Out << "zeroinitializer";
  } else if (all_of(Mask, equal_to(PoisonMaskElem))) {
    Out << "poison";
  } else {
    Out << "<";
    ListSeparator LS;
    for (int Elt : Mask) {
      Out << LS << "i32 ";
      if (Elt == PoisonMaskElem)
        Out << "poison";
      else
        Out << Elt;
    }
    Out << ">";
  }
}
 
namespace {
 
class TypePrinting {
public:
  TypePrinting(const Module *M = nullptr)
      : M(M), TypesIncorporated(M == nullptr) {}
 
  TypePrinting(const TypePrinting &) = delete;
  TypePrinting &operator=(const TypePrinting &) = delete;
 
  /// The named types that are used by the current module.
  TypeFinder &getNamedTypes();
 
  /// The numbered types, number to type mapping.
  std::vector<StructType *> &getNumberedTypes();
 
  bool empty();
 
  void print(Type *Ty, raw_ostream &OS);
 
  void printStructBody(StructType *Ty, raw_ostream &OS);
 
private:
  void incorporateTypes();
 
  /// A module to process lazily.
  const Module *M;
  bool TypesIncorporated;
 
  TypeFinder NamedTypes;
 
  // The numbered types, along with their value.
  DenseMap<StructType *, unsigned> Type2Number;
 
  std::vector<StructType *> NumberedTypes;
};
 
} // end anonymous namespace
 
TypeFinder &TypePrinting::getNamedTypes() {
  incorporateTypes();
  return NamedTypes;
}
 
std::vector<StructType *> &TypePrinting::getNumberedTypes() {
  incorporateTypes();
 
  // We know all the numbers that each type is used and we know that it is a
  // dense assignment. Convert the map to an index table, if it's not done
  // already (judging from the sizes):
  if (NumberedTypes.size() == Type2Number.size())
    return NumberedTypes;
 
  NumberedTypes.resize(Type2Number.size());
  for (const auto &P : Type2Number) {
    assert(P.second < NumberedTypes.size() && "Didn't get a dense numbering?");
    assert(!NumberedTypes[P.second] && "Didn't get a unique numbering?");
    NumberedTypes[P.second] = P.first;
  }
  return NumberedTypes;
}
 
bool TypePrinting::empty() {
  incorporateTypes();
  return NamedTypes.empty() && Type2Number.empty();
}
 
void TypePrinting::incorporateTypes() {
  if (TypesIncorporated)
    return;
 
  NamedTypes.run(*M, false);
  TypesIncorporated = true;
 
  // The list of struct types we got back includes all the struct types, split
  // the unnamed ones out to a numbering and remove the anonymous structs.
  unsigned NextNumber = 0;
 
  std::vector<StructType *>::iterator NextToUse = NamedTypes.begin();
  for (StructType *STy : NamedTypes) {
    // Ignore anonymous types.
    if (STy->isLiteral())
      continue;
 
    if (STy->getName().empty())
      Type2Number[STy] = NextNumber++;
    else
      *NextToUse++ = STy;
  }
 
  NamedTypes.erase(NextToUse, NamedTypes.end());
}
 
static void printAddressSpace(const Module *M, unsigned AS, raw_ostream &OS,
                              StringRef Prefix = " ", StringRef Suffix = "",
                              bool ForcePrint = false) {
  if (AS == 0 && !ForcePrint)
    return;
  OS << Prefix << "addrspace(";
  StringRef ASName =
      PrintAddrspaceName && M ? M->getDataLayout().getAddressSpaceName(AS) : "";
  if (!ASName.empty())
    OS << "\"" << ASName << "\"";
  else
    OS << AS;
  OS << ")" << Suffix;
}
 
/// Write the specified type to the specified raw_ostream, making use of type
/// names or up references to shorten the type name where possible.
void TypePrinting::print(Type *Ty, raw_ostream &OS) {
  switch (Ty->getTypeID()) {
  case Type::VoidTyID:      OS << "void"; return;
  case Type::HalfTyID:      OS << "half"; return;
  case Type::BFloatTyID:    OS << "bfloat"; return;
  case Type::FloatTyID:     OS << "float"; return;
  case Type::DoubleTyID:    OS << "double"; return;
  case Type::X86_FP80TyID:  OS << "x86_fp80"; return;
  case Type::FP128TyID:     OS << "fp128"; return;
  case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
  case Type::LabelTyID:     OS << "label"; return;
  case Type::MetadataTyID:
    OS << "metadata";
    return;
  case Type::X86_AMXTyID:   OS << "x86_amx"; return;
  case Type::TokenTyID:     OS << "token"; return;
  case Type::ByteTyID:
    OS << 'b' << Ty->getByteBitWidth();
    return;
  case Type::IntegerTyID:
    OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
    return;
 
  case Type::FunctionTyID: {
    FunctionType *FTy = cast<FunctionType>(Ty);
    print(FTy->getReturnType(), OS);
    OS << " (";
    ListSeparator LS;
    for (Type *Ty : FTy->params()) {
      OS << LS;
      print(Ty, OS);
    }
    if (FTy->isVarArg())
      OS << LS << "...";
    OS << ')';
    return;
  }
  case Type::StructTyID: {
    StructType *STy = cast<StructType>(Ty);
 
    if (STy->isLiteral())
      return printStructBody(STy, OS);
 
    if (!STy->getName().empty())
      return printLLVMName(OS, STy->getName(), LocalPrefix);
 
    incorporateTypes();
    const auto I = Type2Number.find(STy);
    if (I != Type2Number.end())
      OS << '%' << I->second;
    else  // Not enumerated, print the hex address.
      OS << "%\"type " << STy << '\"';
    return;
  }
  case Type::PointerTyID: {
    PointerType *PTy = cast<PointerType>(Ty);
    OS << "ptr";
    printAddressSpace(M, PTy->getAddressSpace(), OS);
    return;
  }
  case Type::ArrayTyID: {
    ArrayType *ATy = cast<ArrayType>(Ty);
    OS << '[' << ATy->getNumElements() << " x ";
    print(ATy->getElementType(), OS);
    OS << ']';
    return;
  }
  case Type::FixedVectorTyID:
  case Type::ScalableVectorTyID: {
    VectorType *PTy = cast<VectorType>(Ty);
    ElementCount EC = PTy->getElementCount();
    OS << "<";
    if (EC.isScalable())
      OS << "vscale x ";
    OS << EC.getKnownMinValue() << " x ";
    print(PTy->getElementType(), OS);
    OS << '>';
    return;
  }
  case Type::TypedPointerTyID: {
    TypedPointerType *TPTy = cast<TypedPointerType>(Ty);
    OS << "typedptr(" << *TPTy->getElementType() << ", "
       << TPTy->getAddressSpace() << ")";
    return;
  }
  case Type::TargetExtTyID:
    TargetExtType *TETy = cast<TargetExtType>(Ty);
    OS << "target(\"";
    printEscapedString(Ty->getTargetExtName(), OS);
    OS << "\"";
    for (Type *Inner : TETy->type_params()) {
      OS << ", ";
      Inner->print(OS, /*IsForDebug=*/false, /*NoDetails=*/true);
    }
    for (unsigned IntParam : TETy->int_params())
      OS << ", " << IntParam;
    OS << ")";
    return;
  }
  llvm_unreachable("Invalid TypeID");
}
 
void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
  if (STy->isOpaque()) {
    OS << "opaque";
    return;
  }
 
  if (STy->isPacked())
    OS << '<';
 
  if (STy->getNumElements() == 0) {
    OS << "{}";
  } else {
    OS << "{ ";
    ListSeparator LS;
    for (Type *Ty : STy->elements()) {
      OS << LS;
      print(Ty, OS);
    }
 
    OS << " }";
  }
  if (STy->isPacked())
    OS << '>';
}
 
AbstractSlotTrackerStorage::~AbstractSlotTrackerStorage() = default;
 
//===----------------------------------------------------------------------===//
// SlotTracker Class: Enumerate slot numbers for unnamed values
//===----------------------------------------------------------------------===//
/// This class provides computation of slot numbers for LLVM Assembly writing.
///
class llvm::SlotTracker : public AbstractSlotTrackerStorage {
public:
  /// ValueMap - A mapping of Values to slot numbers.
  using ValueMap = DenseMap<const Value *, unsigned>;
 
private:
  /// TheModule - The module for which we are holding slot numbers.
  const Module* TheModule;
 
  /// TheFunction - The function for which we are holding slot numbers.
  const Function* TheFunction = nullptr;
  bool FunctionProcessed = false;
  bool ShouldTrackMetadataDefinitions;
 
  std::function<void(AbstractSlotTrackerStorage *, const Module *)>
      ProcessModuleHookFn;
  std::function<void(AbstractSlotTrackerStorage *, const Function *)>
      ProcessFunctionHookFn;
 
  /// The summary index for which we are holding slot numbers.
  const ModuleSummaryIndex *TheIndex = nullptr;
 
  /// mMap - The slot map for the module level data.
  ValueMap mMap;
  unsigned mNext = 0;
 
  /// fMap - The slot map for the function level data.
  ValueMap fMap;
  unsigned fNext = 0;
 
  /// mdnMap - Map for MDNodes.
  DenseMap<const MDNode *, unsigned> mdnMap;
  /// asMap - The slot map for attribute sets.
  DenseMap<AttributeSet, unsigned> asMap;
  unsigned asNext = 0;
 
  /// ModulePathMap - The slot map for Module paths used in the summary index.
  StringMap<unsigned> ModulePathMap;
  unsigned ModulePathNext = 0;
 
  /// GUIDMap - The slot map for GUIDs used in the summary index.
  DenseMap<GlobalValue::GUID, unsigned> GUIDMap;
  unsigned GUIDNext = 0;
 
  /// TypeIdMap - The slot map for type ids used in the summary index.
  StringMap<unsigned> TypeIdMap;
  unsigned TypeIdNext = 0;
 
  /// TypeIdCompatibleVtableMap - The slot map for type compatible vtable ids
  /// used in the summary index.
  StringMap<unsigned> TypeIdCompatibleVtableMap;
  unsigned TypeIdCompatibleVtableNext = 0;
 
public:
  /// Construct from a module.
  ///
  explicit SlotTracker(const Module *M,
                       bool ShouldTrackMetadataDefinitions = false);
 
  /// Construct from a function, starting out in incorp state.
  ///
  explicit SlotTracker(const Function *F);
 
  /// Construct from a module summary index.
  explicit SlotTracker(const ModuleSummaryIndex *Index);
 
  SlotTracker(const SlotTracker &) = delete;
  SlotTracker &operator=(const SlotTracker &) = delete;
 
  ~SlotTracker() override = default;
 
  void setProcessHook(
      std::function<void(AbstractSlotTrackerStorage *, const Module *)>);
  void setProcessHook(
      std::function<void(AbstractSlotTrackerStorage *, const Function *)>);
 
  void createMetadataSlot(const MDNode *N) override;
 
  /// Return the slot number of the specified value in it's type
  /// plane.  If something is not in the SlotTracker, return -1.
  int getLocalSlot(const Value *V);
  int getGlobalSlot(const GlobalValue *V);
  int getMetadataSlot(const MDNode *N) override;
  int getAttributeGroupSlot(AttributeSet AS);
  int getModulePathSlot(StringRef Path);
  int getGUIDSlot(GlobalValue::GUID GUID);
  int getTypeIdSlot(StringRef Id);
  int getTypeIdCompatibleVtableSlot(StringRef Id);
 
  /// If you'd like to deal with a function instead of just a module, use
  /// this method to get its data into the SlotTracker.
  void incorporateFunction(const Function *F) {
    TheFunction = F;
    FunctionProcessed = false;
  }
 
  const Function *getFunction() const { return TheFunction; }
 
  /// After calling incorporateFunction, use this method to remove the
  /// most recently incorporated function from the SlotTracker. This
  /// will reset the state of the machine back to just the module contents.
  void purgeFunction();
 
  /// MDNode map iterators.
  using mdn_iterator = DenseMap<const MDNode*, unsigned>::iterator;
 
  mdn_iterator mdn_begin() { return mdnMap.begin(); }
  mdn_iterator mdn_end() { return mdnMap.end(); }
  unsigned mdn_size() const { return mdnMap.size(); }
  bool mdn_empty() const { return mdnMap.empty(); }
 
  /// AttributeSet map iterators.
  using as_iterator = DenseMap<AttributeSet, unsigned>::iterator;
 
  as_iterator as_begin()   { return asMap.begin(); }
  as_iterator as_end()     { return asMap.end(); }
  unsigned as_size() const { return asMap.size(); }
  bool as_empty() const    { return asMap.empty(); }
 
  /// GUID map iterators.
  using guid_iterator = DenseMap<GlobalValue::GUID, unsigned>::iterator;
 
  /// These functions do the actual initialization.
  inline void initializeIfNeeded();
  int initializeIndexIfNeeded();
 
  // Implementation Details
private:
  /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
  void CreateModuleSlot(const GlobalValue *V);
 
  /// Record a metadata definition and the metadata nodes referenced by it.
  void CreateMetadataSlot(const MDNode *N);
 
  /// CreateFunctionSlot - Insert the specified Value* into the slot table.
  void CreateFunctionSlot(const Value *V);
 
  /// Insert the specified AttributeSet into the slot table.
  void CreateAttributeSetSlot(AttributeSet AS);
 
  inline void CreateModulePathSlot(StringRef Path);
  void CreateGUIDSlot(GlobalValue::GUID GUID);
  void CreateTypeIdSlot(StringRef Id);
  void CreateTypeIdCompatibleVtableSlot(StringRef Id);
 
  /// Add all of the module level global variables (and their initializers)
  /// and function declarations, but not the contents of those functions.
  void processModule();
  // Returns number of allocated slots
  int processIndex();
 
  /// Add all of the functions arguments, basic blocks, and instructions.
  void processFunction();
};
 
ModuleSlotTracker::ModuleSlotTracker(SlotTracker &Machine, const Module *M,
                                     const Function *F)
    : M(M), F(F), Machine(&Machine) {}
 
ModuleSlotTracker::ModuleSlotTracker(const Module *M)
    : ShouldCreateStorage(M), M(M) {}
 
ModuleSlotTracker::~ModuleSlotTracker() = default;
 
SlotTracker *ModuleSlotTracker::getMachine() {
  if (!ShouldCreateStorage)
    return Machine;
 
  ShouldCreateStorage = false;
  MachineStorage = std::make_unique<SlotTracker>(M);
  Machine = MachineStorage.get();
  if (ProcessModuleHookFn)
    Machine->setProcessHook(ProcessModuleHookFn);
  if (ProcessFunctionHookFn)
    Machine->setProcessHook(ProcessFunctionHookFn);
  return Machine;
}
 
void ModuleSlotTracker::incorporateFunction(const Function &F) {
  // Using getMachine() may lazily create the slot tracker.
  if (!getMachine())
    return;
 
  // Nothing to do if this is the right function already.
  if (this->F == &F)
    return;
  if (this->F)
    Machine->purgeFunction();
  Machine->incorporateFunction(&F);
  this->F = &F;
}
 
int ModuleSlotTracker::getLocalSlot(const Value *V) {
  assert(F && "No function incorporated");
  return Machine->getLocalSlot(V);
}
 
void ModuleSlotTracker::setProcessHook(
    std::function<void(AbstractSlotTrackerStorage *, const Module *)> Fn) {
  ProcessModuleHookFn = std::move(Fn);
}
 
void ModuleSlotTracker::setProcessHook(
    std::function<void(AbstractSlotTrackerStorage *, const Function *)> Fn) {
  ProcessFunctionHookFn = std::move(Fn);
}
 
static SlotTracker *createSlotTracker(const Value *V) {
  if (const auto *FA = dyn_cast<Argument>(V))
    return new SlotTracker(FA->getParent());
 
  if (const auto *I = dyn_cast<Instruction>(V))
    if (I->getParent())
      return new SlotTracker(I->getParent()->getParent());
 
  if (const auto *BB = dyn_cast<BasicBlock>(V))
    return new SlotTracker(BB->getParent());
 
  if (const auto *GV = dyn_cast<GlobalVariable>(V))
    return new SlotTracker(GV->getParent());
 
  if (const auto *GA = dyn_cast<GlobalAlias>(V))
    return new SlotTracker(GA->getParent());
 
  if (const auto *GIF = dyn_cast<GlobalIFunc>(V))
    return new SlotTracker(GIF->getParent());
 
  if (const auto *Func = dyn_cast<Function>(V))
    return new SlotTracker(Func);
 
  return nullptr;
}
 
#if 0
#define ST_DEBUG(X) dbgs() << X
#else
#define ST_DEBUG(X)
#endif
 
// Module level constructor. Causes the contents of the Module (sans functions)
// to be added to the slot table.
SlotTracker::SlotTracker(const Module *M, bool ShouldTrackMetadataDefinitions)
    : TheModule(M),
      ShouldTrackMetadataDefinitions(ShouldTrackMetadataDefinitions) {}
 
// Function level constructor. Causes the contents of the Module and the one
// function provided to be added to the slot table.
SlotTracker::SlotTracker(const Function *F)
    : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
      ShouldTrackMetadataDefinitions(false) {}
 
SlotTracker::SlotTracker(const ModuleSummaryIndex *Index)
    : TheModule(nullptr), ShouldTrackMetadataDefinitions(false),
      TheIndex(Index) {}
 
inline void SlotTracker::initializeIfNeeded() {
  if (TheModule) {
    processModule();
    TheModule = nullptr; ///< Prevent re-processing next time we're called.
  }
 
  if (TheFunction && !FunctionProcessed)
    processFunction();
}
 
int SlotTracker::initializeIndexIfNeeded() {
  if (!TheIndex)
    return 0;
  int NumSlots = processIndex();
  TheIndex = nullptr; ///< Prevent re-processing next time we're called.
  return NumSlots;
}
 
// Iterate through all the global variables, functions, and global
// variable initializers and create slots for them.
void SlotTracker::processModule() {
  ST_DEBUG("begin processModule!\n");
 
  // Add all of the unnamed global variables to the value table.
  for (const GlobalVariable &Var : TheModule->globals()) {
    if (!Var.hasName())
      CreateModuleSlot(&Var);
    auto Attrs = Var.getAttributes();
    if (Attrs.hasAttributes())
      CreateAttributeSetSlot(Attrs);
  }
 
  for (const GlobalAlias &A : TheModule->aliases()) {
    if (!A.hasName())
      CreateModuleSlot(&A);
  }
 
  for (const GlobalIFunc &I : TheModule->ifuncs()) {
    if (!I.hasName())
      CreateModuleSlot(&I);
  }
 
  for (const Function &F : *TheModule) {
    if (!F.hasName())
      // Add all the unnamed functions to the table.
      CreateModuleSlot(&F);
 
    // Add all the function attributes to the table.
    // FIXME: Add attributes of other objects?
    AttributeSet FnAttrs = F.getAttributes().getFnAttrs();
    if (FnAttrs.hasAttributes())
      CreateAttributeSetSlot(FnAttrs);
  }
 
  if (ProcessModuleHookFn)
    ProcessModuleHookFn(this, TheModule);
 
  ST_DEBUG("end processModule!\n");
}
 
// Process the arguments, basic blocks, and instructions  of a function.
void SlotTracker::processFunction() {
  ST_DEBUG("begin processFunction!\n");
  fNext = 0;
 
  // Add all the function arguments with no names.
  for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
      AE = TheFunction->arg_end(); AI != AE; ++AI)
    if (!AI->hasName())
      CreateFunctionSlot(&*AI);
 
  ST_DEBUG("Inserting Instructions:\n");
 
  // Add all of the basic blocks and instructions with no names.
  for (auto &BB : *TheFunction) {
    if (!BB.hasName())
      CreateFunctionSlot(&BB);
 
    for (auto &I : BB) {
      if (!I.getType()->isVoidTy() && !I.hasName())
        CreateFunctionSlot(&I);
 
      // We allow direct calls to any llvm.foo function here, because the
      // target may not be linked into the optimizer.
      if (const auto *Call = dyn_cast<CallBase>(&I)) {
        // Add all the call attributes to the table.
        AttributeSet Attrs = Call->getAttributes().getFnAttrs();
        if (Attrs.hasAttributes())
          CreateAttributeSetSlot(Attrs);
      }
    }
  }
 
  if (ProcessFunctionHookFn)
    ProcessFunctionHookFn(this, TheFunction);
 
  FunctionProcessed = true;
 
  ST_DEBUG("end processFunction!\n");
}
 
// Iterate through all the GUID in the index and create slots for them.
int SlotTracker::processIndex() {
  ST_DEBUG("begin processIndex!\n");
  assert(TheIndex);
 
  // The first block of slots are just the module ids, which start at 0 and are
  // assigned consecutively. Since the StringMap iteration order isn't
  // guaranteed, order by path string before assigning slots.
  std::vector<StringRef> ModulePaths;
  for (auto &[ModPath, _] : TheIndex->modulePaths())
    ModulePaths.push_back(ModPath);
  llvm::sort(ModulePaths);
  for (auto &ModPath : ModulePaths)
    CreateModulePathSlot(ModPath);
 
  // Start numbering the GUIDs after the module ids.
  GUIDNext = ModulePathNext;
 
  // Sort by GUID for deterministic slot assignment.
  for (const auto &GlobalList : TheIndex->sortedGlobalValueSummariesRange())
    CreateGUIDSlot(GlobalList.first);
 
  // Start numbering the TypeIdCompatibleVtables after the GUIDs.
  TypeIdCompatibleVtableNext = GUIDNext;
  for (auto &TId : TheIndex->typeIdCompatibleVtableMap())
    CreateTypeIdCompatibleVtableSlot(TId.first);
 
  // Start numbering the TypeIds after the TypeIdCompatibleVtables.
  TypeIdNext = TypeIdCompatibleVtableNext;
  for (const auto &TID : TheIndex->typeIds())
    CreateTypeIdSlot(TID.second.first);
 
  ST_DEBUG("end processIndex!\n");
  return TypeIdNext;
}
 
namespace {
class MetadataNodeVisitor {
  /// Visited MDNodes.
  SmallPtrSet<const MDNode *, 32> VisitedMDNodes;
  function_ref<void(const MDNode *)> Visit;
 
  void visit(const MDNode *N) {
    if (isa<DIExpression>(N) || !VisitedMDNodes.insert(N).second)
      return;
 
    Visit(N);
    for (const MDOperand &Op : N->operands())
      if (const auto *OpNode = dyn_cast_or_null<MDNode>(Op.get()))
        visit(OpNode);
  }
 
  void visitGlobalObjectMetadata(const GlobalObject &GO) {
    SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
    GO.getAllMetadata(MDs);
    for (auto &MD : MDs)
      visit(MD.second);
  }
 
  void visitDbgRecordMetadata(const DbgRecord &DR) {
    if (const auto *DVR = dyn_cast<const DbgVariableRecord>(&DR)) {
      if (auto *Empty = dyn_cast_if_present<MDNode>(DVR->getRawLocation()))
        visit(Empty);
      if (DVR->getRawVariable())
        visit(DVR->getRawVariable());
      if (DVR->isDbgAssign()) {
        if (auto *AssignID = DVR->getRawAssignID())
          visit(cast<MDNode>(AssignID));
        if (auto *Empty = dyn_cast_if_present<MDNode>(DVR->getRawAddress()))
          visit(Empty);
      }
    } else if (const auto *DLR = dyn_cast<const DbgLabelRecord>(&DR)) {
      visit(DLR->getRawLabel());
    } else {
      llvm_unreachable("unsupported DbgRecord kind");
    }
    if (DR.getDebugLoc())
      visit(DR.getDebugLoc().getAsMDNode());
  }
 
  void visitInstructionMetadata(const Instruction &I) {
    if (const auto *CI = dyn_cast<CallInst>(&I))
      if (Function *F = CI->getCalledFunction())
        if (F->isIntrinsic())
          for (auto &Op : I.operands())
            if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
              if (auto *N = dyn_cast<MDNode>(V->getMetadata()))
                visit(N);
 
    SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
    I.getAllMetadata(MDs);
    for (auto &MD : MDs)
      visit(MD.second);
  }
 
  void visitFunctionMetadata(const Function &F) {
    visitGlobalObjectMetadata(F);
    for (const BasicBlock &BB : F)
      for (const Instruction &I : BB) {
        for (const DbgRecord &DR : I.getDbgRecordRange())
          visitDbgRecordMetadata(DR);
        visitInstructionMetadata(I);
      }
  }
 
public:
  MetadataNodeVisitor(function_ref<void(const MDNode *)> Visit)
      : Visit(Visit) {}
 
  void visitModuleMetadata(const Module &M) {
    for (const GlobalVariable &Var : M.globals())
      visitGlobalObjectMetadata(Var);
    for (const GlobalIFunc &I : M.ifuncs())
      visitGlobalObjectMetadata(I);
    for (const NamedMDNode &NMD : M.named_metadata())
      for (const MDNode *N : NMD.operands())
        visit(N);
    for (const Function &F : M)
      visitFunctionMetadata(F);
  }
 
  void visitMetadata(ArrayRef<const MDNode *> Metadata) {
    for (const MDNode *N : Metadata)
      visit(N);
  }
 
  bool contains(const MDNode *N) const { return VisitedMDNodes.contains(N); }
};
 
class MetadataIDRenumberer {
  uint32_t NextID = 0;
 
public:
  void run(const Module &M, ArrayRef<const MDNode *> AdditionalMetadata,
           ModuleSlotTracker::MachineMDNodeListType *AdditionalMetadataNodes =
               nullptr) {
    bool IsAdditionalMetadata = false;
    auto Renumber = [&](const MDNode *N) {
      N->getContext().pImpl->setMetadataPrintID(const_cast<MDNode *>(N),
                                                NextID++);
      if (IsAdditionalMetadata && AdditionalMetadataNodes)
        AdditionalMetadataNodes->emplace_back(
            N->getContext().pImpl->getMetadataPrintID(N), N);
    };
    MetadataNodeVisitor Visitor(Renumber);
 
    Visitor.visitModuleMetadata(M);
 
    IsAdditionalMetadata = true;
    Visitor.visitMetadata(AdditionalMetadata);
 
    // Keep IDs unique for nodes outside the canonical output.
    SmallVector<MDNode *, 32> RemainingNodes;
    M.getContext().pImpl->getAllMetadataNodes(RemainingNodes);
    llvm::erase_if(RemainingNodes, [&](const MDNode *N) {
      return Visitor.contains(N) ||
             M.getContext().pImpl->getMetadataPrintID(N) >= NextID;
    });
    llvm::sort(RemainingNodes, [&](const MDNode *LHS, const MDNode *RHS) {
      return M.getContext().pImpl->getMetadataPrintID(LHS) <
             M.getContext().pImpl->getMetadataPrintID(RHS);
    });
    for (MDNode *N : RemainingNodes)
      M.getContext().pImpl->setMetadataPrintID(
          N, M.getContext().pImpl->allocateMetadataPrintID());
 
    if (AdditionalMetadataNodes)
      llvm::sort(*AdditionalMetadataNodes);
  }
};
} // namespace
 
void Module::renumberMetadataForAssembly() {
  MetadataIDRenumberer().run(*this, {});
}
 
void ModuleSlotTracker::renumberMetadataForAssembly(
    ArrayRef<const MDNode *> AdditionalMetadata,
    MachineMDNodeListType *AdditionalMetadataNodes) const {
  assert(M && "metadata renumbering requires a module");
  MetadataIDRenumberer().run(*M, AdditionalMetadata, AdditionalMetadataNodes);
}
 
void ModuleSlotTracker::collectAdditionalMetadata(
    ArrayRef<const MDNode *> AdditionalMetadata,
    MachineMDNodeListType &AdditionalMetadataNodes) const {
  assert(M && "metadata collection requires a module");
  bool IsAdditionalMetadata = false;
  auto Collect = [&](const MDNode *N) {
    if (IsAdditionalMetadata)
      AdditionalMetadataNodes.emplace_back(
          N->getContext().pImpl->getMetadataPrintID(N), N);
  };
  MetadataNodeVisitor Visitor(Collect);
  Visitor.visitModuleMetadata(*M);
  IsAdditionalMetadata = true;
  Visitor.visitMetadata(AdditionalMetadata);
  llvm::sort(AdditionalMetadataNodes);
}
 
/// Clean up after incorporating a function. This is the only way to get out of
/// the function incorporation state that affects get*Slot/Create*Slot. Function
/// incorporation state is indicated by TheFunction != 0.
void SlotTracker::purgeFunction() {
  ST_DEBUG("begin purgeFunction!\n");
  fMap.clear(); // Simply discard the function level map
  TheFunction = nullptr;
  FunctionProcessed = false;
  ST_DEBUG("end purgeFunction!\n");
}
 
/// getGlobalSlot - Get the slot number of a global value.
int SlotTracker::getGlobalSlot(const GlobalValue *V) {
  // Check for uninitialized state and do lazy initialization.
  initializeIfNeeded();
 
  // Find the value in the module map
  ValueMap::iterator MI = mMap.find(V);
  return MI == mMap.end() ? -1 : (int)MI->second;
}
 
void SlotTracker::setProcessHook(
    std::function<void(AbstractSlotTrackerStorage *, const Module *)> Fn) {
  ProcessModuleHookFn = std::move(Fn);
}
 
void SlotTracker::setProcessHook(
    std::function<void(AbstractSlotTrackerStorage *, const Function *)> Fn) {
  ProcessFunctionHookFn = std::move(Fn);
}
 
/// getMetadataSlot - Get the slot number of a MDNode.
void SlotTracker::createMetadataSlot(const MDNode *N) { CreateMetadataSlot(N); }
 
/// getMetadataSlot - Get the slot number of a MDNode.
int SlotTracker::getMetadataSlot(const MDNode *N) {
  // Check for uninitialized state and do lazy initialization.
  initializeIfNeeded();
 
  if (isa<DIExpression>(N))
    return -1;
  if (ShouldTrackMetadataDefinitions)
    CreateMetadataSlot(N);
  return N->getContext().pImpl->getMetadataPrintID(N);
}
 
/// getLocalSlot - Get the slot number for a value that is local to a function.
int SlotTracker::getLocalSlot(const Value *V) {
  assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
 
  // Check for uninitialized state and do lazy initialization.
  initializeIfNeeded();
 
  ValueMap::iterator FI = fMap.find(V);
  return FI == fMap.end() ? -1 : (int)FI->second;
}
 
int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
  // Check for uninitialized state and do lazy initialization.
  initializeIfNeeded();
 
  // Find the AttributeSet in the module map.
  as_iterator AI = asMap.find(AS);
  return AI == asMap.end() ? -1 : (int)AI->second;
}
 
int SlotTracker::getModulePathSlot(StringRef Path) {
  // Check for uninitialized state and do lazy initialization.
  initializeIndexIfNeeded();
 
  // Find the Module path in the map
  auto I = ModulePathMap.find(Path);
  return I == ModulePathMap.end() ? -1 : (int)I->second;
}
 
int SlotTracker::getGUIDSlot(GlobalValue::GUID GUID) {
  // Check for uninitialized state and do lazy initialization.
  initializeIndexIfNeeded();
 
  // Find the GUID in the map
  guid_iterator I = GUIDMap.find(GUID);
  return I == GUIDMap.end() ? -1 : (int)I->second;
}
 
int SlotTracker::getTypeIdSlot(StringRef Id) {
  // Check for uninitialized state and do lazy initialization.
  initializeIndexIfNeeded();
 
  // Find the TypeId string in the map
  auto I = TypeIdMap.find(Id);
  return I == TypeIdMap.end() ? -1 : (int)I->second;
}
 
int SlotTracker::getTypeIdCompatibleVtableSlot(StringRef Id) {
  // Check for uninitialized state and do lazy initialization.
  initializeIndexIfNeeded();
 
  // Find the TypeIdCompatibleVtable string in the map
  auto I = TypeIdCompatibleVtableMap.find(Id);
  return I == TypeIdCompatibleVtableMap.end() ? -1 : (int)I->second;
}
 
/// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
  assert(V && "Can't insert a null Value into SlotTracker!");
  assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
  assert(!V->hasName() && "Doesn't need a slot!");
 
  unsigned DestSlot = mNext++;
  mMap[V] = DestSlot;
 
  ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
           DestSlot << " [");
  // G = Global, F = Function, A = Alias, I = IFunc, o = other
  ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
            (isa<Function>(V) ? 'F' :
             (isa<GlobalAlias>(V) ? 'A' :
              (isa<GlobalIFunc>(V) ? 'I' : 'o')))) << "]\n");
}
 
/// CreateSlot - Create a new slot for the specified value if it has no name.
void SlotTracker::CreateFunctionSlot(const Value *V) {
  assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
 
  unsigned DestSlot = fNext++;
  fMap[V] = DestSlot;
 
  // G = Global, F = Function, o = other
  ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
           DestSlot << " [o]\n");
}
 
/// CreateModuleSlot - Insert the specified MDNode* into the slot table.
void SlotTracker::CreateMetadataSlot(const MDNode *N) {
  assert(N && "Can't insert a null Value into SlotTracker!");
 
  if (isa<DIExpression>(N))
    return;
 
  unsigned ID = N->getContext().pImpl->getMetadataPrintID(N);
  if (!mdnMap.try_emplace(N, ID).second)
    return;
 
  for (const MDOperand &Op : N->operands())
    if (const auto *OpNode = dyn_cast_or_null<MDNode>(Op.get()))
      CreateMetadataSlot(OpNode);
}
 
void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
  assert(AS.hasAttributes() && "Doesn't need a slot!");
 
  if (asMap.try_emplace(AS, asNext).second)
    ++asNext;
}
 
/// Create a new slot for the specified Module
void SlotTracker::CreateModulePathSlot(StringRef Path) {
  ModulePathMap[Path] = ModulePathNext++;
}
 
/// Create a new slot for the specified GUID
void SlotTracker::CreateGUIDSlot(GlobalValue::GUID GUID) {
  GUIDMap[GUID] = GUIDNext++;
}
 
/// Create a new slot for the specified Id
void SlotTracker::CreateTypeIdSlot(StringRef Id) {
  TypeIdMap[Id] = TypeIdNext++;
}
 
/// Create a new slot for the specified Id
void SlotTracker::CreateTypeIdCompatibleVtableSlot(StringRef Id) {
  TypeIdCompatibleVtableMap[Id] = TypeIdCompatibleVtableNext++;
}
 
namespace {
/// Common instances used by most of the printer functions.
struct AsmWriterContext {
  TypePrinting *TypePrinter = nullptr;
  SlotTracker *Machine = nullptr;
  const Module *Context = nullptr;
  const ModuleSlotTracker *MST = nullptr;
 
  AsmWriterContext(TypePrinting *TP, SlotTracker *ST, const Module *M = nullptr,
                   const ModuleSlotTracker *MST = nullptr)
      : TypePrinter(TP), Machine(ST), Context(M), MST(MST) {}
 
  static AsmWriterContext &getEmpty() {
    static AsmWriterContext EmptyCtx(nullptr, nullptr);
    return EmptyCtx;
  }
 
  /// A callback that will be triggered when the underlying printer
  /// prints a Metadata as operand.
  virtual void onWriteMetadataAsOperand(const Metadata *) {}
 
  virtual ~AsmWriterContext() = default;
};
} // end anonymous namespace
 
//===----------------------------------------------------------------------===//
// AsmWriter Implementation
//===----------------------------------------------------------------------===//
 
static void writeAsOperandInternal(raw_ostream &Out, const Value *V,
                                   AsmWriterContext &WriterCtx,
                                   bool PrintType = false);
 
static void writeAsOperandInternal(raw_ostream &Out, const Metadata *MD,
                                   AsmWriterContext &WriterCtx,
                                   bool FromValue = false);
 
static void writeOptimizationInfo(raw_ostream &Out, const User *U) {
  if (const auto *FPO = dyn_cast<const FPMathOperator>(U))
    Out << FPO->getFastMathFlags();
 
  if (const auto *OBO = dyn_cast<OverflowingBinaryOperator>(U)) {
    if (OBO->hasNoUnsignedWrap())
      Out << " nuw";
    if (OBO->hasNoSignedWrap())
      Out << " nsw";
  } else if (const auto *Div = dyn_cast<PossiblyExactOperator>(U)) {
    if (Div->isExact())
      Out << " exact";
  } else if (const auto *PDI = dyn_cast<PossiblyDisjointInst>(U)) {
    if (PDI->isDisjoint())
      Out << " disjoint";
  } else if (const auto *GEP = dyn_cast<GEPOperator>(U)) {
    if (GEP->isInBounds())
      Out << " inbounds";
    else if (GEP->hasNoUnsignedSignedWrap())
      Out << " nusw";
    if (GEP->hasNoUnsignedWrap())
      Out << " nuw";
    if (auto InRange = GEP->getInRange()) {
      Out << " inrange(" << InRange->getLower() << ", " << InRange->getUpper()
          << ")";
    }
  } else if (const auto *NNI = dyn_cast<PossiblyNonNegInst>(U)) {
    if (NNI->hasNonNeg())
      Out << " nneg";
  } else if (const auto *TI = dyn_cast<TruncInst>(U)) {
    if (TI->hasNoUnsignedWrap())
      Out << " nuw";
    if (TI->hasNoSignedWrap())
      Out << " nsw";
  } else if (const auto *ICmp = dyn_cast<ICmpInst>(U)) {
    if (ICmp->hasSameSign())
      Out << " samesign";
  } else if (const auto *ASC = dyn_cast<AddrSpaceCastInst>(U)) {
    if (ASC->hasNonNull())
      Out << " nonnull";
  }
}
 
static void WriteFullHexAPInt(raw_ostream &Out, const APInt &Val) {
  SmallVector<char, 32> Bits;
  Val.toStringUnsigned(Bits, 16);
  unsigned NumDigits = std::max((Val.getBitWidth() + 3) / 4, 1U);
  Out << "0x";
  for (unsigned i = 0; i < NumDigits - Bits.size(); i++)
    Out << '0';
  Out << Bits;
}
 
static void writeAPFloatInternal(raw_ostream &Out, const APFloat &APF) {
  bool ForceBitwiseOutput = false;
  if (&APF.getSemantics() == &APFloat::PPCDoubleDouble()) {
    // ppc_fp128 types are double-double. The special cases set the second
    // (high) double to +0.0, so if the high word is nonzero, force the use of
    // bitwise output.
    APInt HiWord = APF.bitcastToAPInt().lshr(64);
    ForceBitwiseOutput = !HiWord.isZero();
  }
 
  if (!ForceBitwiseOutput) {
    // Check for special values in APFloat.
    if (APF.isInfinity()) {
      Out << (APF.isNegative() ? '-' : '+') << "inf";
      return;
    }
 
    if (APF.isNaN()) {
      Out << (APF.isNegative() ? '-' : '+');
      APInt Payload = APF.getNaNPayload();
      // The quiet bit of a NaN is the highest bit of the payload, so the
      // preferred QNaN value happens to be the sign mask value.
      if (Payload.isSignMask()) {
        Out << "qnan";
      } else {
        if (APF.isSignaling())
          Out << 's';
        Out << "nan(";
        // Clear out the signaling/quiet bit of the payload for output.
        Payload.clearBit(Payload.getBitWidth() - 1);
        // Trim the string to exclude leading 0's.
        WriteFullHexAPInt(Out, Payload.trunc(Payload.getActiveBits()));
        Out << ')';
      }
      return;
    }
  }
 
  // Try for a decimal string output. If the value is convertible back to the
  // same APFloat value, then we know that it is safe to use it. Otherwise, fall
  // back onto the hexadecimal format.
  SmallString<128> StrVal;
  APF.toString(StrVal, 6, 0, false);
  if (APFloat(APF.getSemantics(), StrVal) == APF) {
    Out << StrVal;
    return;
  }
 
  // Fallback to the hexadecimal format representing the bit string exactly.
  Out << 'f';
  APInt API = APF.bitcastToAPInt();
  WriteFullHexAPInt(Out, API);
}
 
static void writeConstantInternal(raw_ostream &Out, const Constant *CV,
                                  AsmWriterContext &WriterCtx) {
  if (const auto *CI = dyn_cast<ConstantInt>(CV)) {
    Type *Ty = CI->getType();
 
    if (Ty->isVectorTy()) {
      Out << "splat (";
      WriterCtx.TypePrinter->print(Ty->getScalarType(), Out);
      Out << " ";
    }
 
    if (Ty->getScalarType()->isIntegerTy(1))
      Out << (CI->getZExtValue() ? "true" : "false");
    else
      Out << CI->getValue();
 
    if (Ty->isVectorTy())
      Out << ")";
 
    return;
  }
 
  if (const auto *CB = dyn_cast<ConstantByte>(CV)) {
    Type *Ty = CB->getType();
 
    if (Ty->isVectorTy()) {
      Out << "splat (";
      WriterCtx.TypePrinter->print(Ty->getScalarType(), Out);
      Out << " ";
    }
 
    Out << CB->getValue();
 
    if (Ty->isVectorTy())
      Out << ")";
 
    return;
  }
 
  if (const auto *CFP = dyn_cast<ConstantFP>(CV)) {
    Type *Ty = CFP->getType();
 
    if (Ty->isVectorTy()) {
      if (CFP->getValue().bitcastToAPInt().isZero()) {
        Out << "zeroinitializer";
        return;
      }
 
      Out << "splat (";
      WriterCtx.TypePrinter->print(Ty->getScalarType(), Out);
      Out << " ";
    }
 
    writeAPFloatInternal(Out, CFP->getValueAPF());
 
    if (Ty->isVectorTy())
      Out << ")";
 
    return;
  }
 
  if (isa<ConstantAggregateZero>(CV) || isa<ConstantTargetNone>(CV)) {
    Out << "zeroinitializer";
    return;
  }
 
  if (const auto *BA = dyn_cast<BlockAddress>(CV)) {
    Out << "blockaddress(";
    writeAsOperandInternal(Out, BA->getFunction(), WriterCtx);
    Out << ", ";
    writeAsOperandInternal(Out, BA->getBasicBlock(), WriterCtx);
    Out << ")";
    return;
  }
 
  if (const auto *Equiv = dyn_cast<DSOLocalEquivalent>(CV)) {
    Out << "dso_local_equivalent ";
    writeAsOperandInternal(Out, Equiv->getGlobalValue(), WriterCtx);
    return;
  }
 
  if (const auto *NC = dyn_cast<NoCFIValue>(CV)) {
    Out << "no_cfi ";
    writeAsOperandInternal(Out, NC->getGlobalValue(), WriterCtx);
    return;
  }
 
  if (const auto *CPA = dyn_cast<ConstantPtrAuth>(CV)) {
    Out << "ptrauth (";
 
    // ptrauth (ptr CST, i32 KEY[, i64 DISC[, ptr ADDRDISC[, ptr DS]?]?]?)
    unsigned NumOpsToWrite = 2;
    if (!CPA->getOperand(2)->isNullValue())
      NumOpsToWrite = 3;
    if (!isa<ConstantPointerNull>(CPA->getOperand(3)))
      NumOpsToWrite = 4;
    if (!isa<ConstantPointerNull>(CPA->getOperand(4)))
      NumOpsToWrite = 5;
 
    ListSeparator LS;
    for (unsigned i = 0, e = NumOpsToWrite; i != e; ++i) {
      Out << LS;
      writeAsOperandInternal(Out, CPA->getOperand(i), WriterCtx,
                             /*PrintType=*/true);
    }
    Out << ')';
    return;
  }
 
  if (const auto *CA = dyn_cast<ConstantArray>(CV)) {
    Out << '[';
    ListSeparator LS;
    for (const Value *Op : CA->operands()) {
      Out << LS;
      writeAsOperandInternal(Out, Op, WriterCtx, /*PrintType=*/true);
    }
    Out << ']';
    return;
  }
 
  if (const auto *CA = dyn_cast<ConstantDataArray>(CV)) {
    // As a special case, print the array as a string if it is an array of
    // i8 with ConstantInt values.
    if (CA->isString()) {
      Out << "c\"";
      printEscapedString(CA->getAsString(), Out);
      Out << '"';
      return;
    }
 
    Out << '[';
    ListSeparator LS;
    for (uint64_t i = 0, e = CA->getNumElements(); i != e; ++i) {
      Out << LS;
      writeAsOperandInternal(Out, CA->getElementAsConstant(i), WriterCtx,
                             /*PrintType=*/true);
    }
    Out << ']';
    return;
  }
 
  if (const auto *CS = dyn_cast<ConstantStruct>(CV)) {
    if (CS->getType()->isPacked())
      Out << '<';
    Out << '{';
    if (CS->getNumOperands() != 0) {
      Out << ' ';
      ListSeparator LS;
      for (const Value *Op : CS->operands()) {
        Out << LS;
        writeAsOperandInternal(Out, Op, WriterCtx, /*PrintType=*/true);
      }
      Out << ' ';
    }
    Out << '}';
    if (CS->getType()->isPacked())
      Out << '>';
    return;
  }
 
  if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
    auto *CVVTy = cast<FixedVectorType>(CV->getType());
 
    // Use the same shorthand for splat vector (i.e. "splat(Ty val)") as is
    // permitted on IR input to reduce the output changes when enabling
    // UseConstant{Int,FP}ForFixedLengthSplat.
    // TODO: Remove this block when the UseConstant{Int,FP}ForFixedLengthSplat
    // options are removed.
    if (auto *SplatVal = CV->getSplatValue()) {
      if (isa<ConstantInt>(SplatVal) || isa<ConstantFP>(SplatVal) ||
          isa<ConstantByte>(SplatVal)) {
        Out << "splat (";
        writeAsOperandInternal(Out, SplatVal, WriterCtx, /*PrintType=*/true);
        Out << ')';
        return;
      }
    }
 
    Out << '<';
    ListSeparator LS;
    for (unsigned i = 0, e = CVVTy->getNumElements(); i != e; ++i) {
      Out << LS;
      writeAsOperandInternal(Out, CV->getAggregateElement(i), WriterCtx,
                             /*PrintType=*/true);
    }
    Out << '>';
    return;
  }
 
  if (const auto *CPN = dyn_cast<ConstantPointerNull>(CV)) {
    if (auto *VT = dyn_cast<VectorType>(CPN->getType())) {
      Out << "splat (";
      writeAsOperandInternal(Out,
                             ConstantPointerNull::get(VT->getElementType()),
                             WriterCtx, /*PrintType=*/true);
      Out << ')';
      return;
    }
 
    Out << "null";
    return;
  }
 
  if (isa<ConstantTokenNone>(CV)) {
    Out << "none";
    return;
  }
 
  if (isa<PoisonValue>(CV)) {
    Out << "poison";
    return;
  }
 
  if (isa<UndefValue>(CV)) {
    Out << "undef";
    return;
  }
 
  if (const auto *CE = dyn_cast<ConstantExpr>(CV)) {
    // Use the same shorthand for splat vector (i.e. "splat(Ty val)") as is
    // permitted on IR input to reduce the output changes when enabling
    // UseConstant{Int,FP}ForScalableSplat.
    // TODO: Remove this block when the UseConstant{Int,FP}ForScalableSplat
    // options are removed.
    if (CE->getOpcode() == Instruction::ShuffleVector) {
      if (auto *SplatVal = CE->getSplatValue()) {
        if (isa<ConstantInt>(SplatVal) || isa<ConstantFP>(SplatVal) ||
            isa<ConstantByte>(SplatVal)) {
          Out << "splat (";
          writeAsOperandInternal(Out, SplatVal, WriterCtx, /*PrintType=*/true);
          Out << ')';
          return;
        }
      }
    }
 
    Out << CE->getOpcodeName();
    writeOptimizationInfo(Out, CE);
    Out << " (";
 
    if (const auto *GEP = dyn_cast<GEPOperator>(CE)) {
      WriterCtx.TypePrinter->print(GEP->getSourceElementType(), Out);
      Out << ", ";
    }
 
    ListSeparator LS;
    for (const Value *Op : CE->operands()) {
      Out << LS;
      writeAsOperandInternal(Out, Op, WriterCtx, /*PrintType=*/true);
    }
 
    if (CE->isCast()) {
      Out << " to ";
      WriterCtx.TypePrinter->print(CE->getType(), Out);
    }
 
    if (CE->getOpcode() == Instruction::ShuffleVector)
      printShuffleMask(Out, CE->getType(), CE->getShuffleMask());
 
    Out << ')';
    return;
  }
 
  Out << "<placeholder or erroneous Constant>";
}
 
static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
                         AsmWriterContext &WriterCtx) {
  Out << "!{";
  ListSeparator LS;
  for (const Metadata *MD : Node->operands()) {
    Out << LS;
    if (!MD) {
      Out << "null";
    } else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
      Value *V = MDV->getValue();
      writeAsOperandInternal(Out, V, WriterCtx, /*PrintType=*/true);
    } else {
      writeAsOperandInternal(Out, MD, WriterCtx);
      WriterCtx.onWriteMetadataAsOperand(MD);
    }
  }
 
  Out << "}";
}
 
namespace {
 
struct MDFieldPrinter {
  raw_ostream &Out;
  ListSeparator FS;
  AsmWriterContext &WriterCtx;
 
  explicit MDFieldPrinter(raw_ostream &Out)
      : Out(Out), WriterCtx(AsmWriterContext::getEmpty()) {}
  MDFieldPrinter(raw_ostream &Out, AsmWriterContext &Ctx)
      : Out(Out), WriterCtx(Ctx) {}
 
  void printTag(const DINode *N);
  void printMacinfoType(const DIMacroNode *N);
  void printChecksum(const DIFile::ChecksumInfo<StringRef> &N);
  void printString(StringRef Name, StringRef Value,
                   bool ShouldSkipEmpty = true);
  void printMetadata(StringRef Name, const Metadata *MD,
                     bool ShouldSkipNull = true);
  void printMetadataOrInt(StringRef Name, const Metadata *MD, bool IsUnsigned,
                          bool ShouldSkipZero = true);
  template <class IntTy>
  void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
  void printAPInt(StringRef Name, const APInt &Int, bool IsUnsigned,
                  bool ShouldSkipZero);
  void printBool(StringRef Name, bool Value,
                 std::optional<bool> Default = std::nullopt);
  void printDIFlags(StringRef Name, DINode::DIFlags Flags);
  void printDISPFlags(StringRef Name, DISubprogram::DISPFlags Flags);
  template <class IntTy, class Stringifier>
  void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
                      bool ShouldSkipZero = true);
  void printEmissionKind(StringRef Name, DICompileUnit::DebugEmissionKind EK);
  void printNameTableKind(StringRef Name,
                          DICompileUnit::DebugNameTableKind NTK);
  void printFixedPointKind(StringRef Name, DIFixedPointType::FixedPointKind V);
};
 
} // end anonymous namespace
 
void MDFieldPrinter::printTag(const DINode *N) {
  Out << FS << "tag: ";
  auto Tag = dwarf::TagString(N->getTag());
  if (!Tag.empty())
    Out << Tag;
  else
    Out << N->getTag();
}
 
void MDFieldPrinter::printMacinfoType(const DIMacroNode *N) {
  Out << FS << "type: ";
  auto Type = dwarf::MacinfoString(N->getMacinfoType());
  if (!Type.empty())
    Out << Type;
  else
    Out << N->getMacinfoType();
}
 
void MDFieldPrinter::printChecksum(
    const DIFile::ChecksumInfo<StringRef> &Checksum) {
  Out << FS << "checksumkind: " << Checksum.getKindAsString();
  printString("checksum", Checksum.Value, /* ShouldSkipEmpty */ false);
}
 
void MDFieldPrinter::printString(StringRef Name, StringRef Value,
                                 bool ShouldSkipEmpty) {
  if (ShouldSkipEmpty && Value.empty())
    return;
 
  Out << FS << Name << ": \"";
  printEscapedString(Value, Out);
  Out << "\"";
}
 
static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
                                   AsmWriterContext &WriterCtx) {
  if (!MD) {
    Out << "null";
    return;
  }
  writeAsOperandInternal(Out, MD, WriterCtx);
  WriterCtx.onWriteMetadataAsOperand(MD);
}
 
void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
                                   bool ShouldSkipNull) {
  if (ShouldSkipNull && !MD)
    return;
 
  Out << FS << Name << ": ";
  writeMetadataAsOperand(Out, MD, WriterCtx);
}
 
void MDFieldPrinter::printMetadataOrInt(StringRef Name, const Metadata *MD,
                                        bool IsUnsigned, bool ShouldSkipZero) {
  if (!MD)
    return;
 
  if (auto *CI = dyn_cast<ConstantAsMetadata>(MD)) {
    auto *CV = cast<ConstantInt>(CI->getValue());
    if (IsUnsigned)
      printInt(Name, CV->getZExtValue(), ShouldSkipZero);
    else
      printInt(Name, CV->getSExtValue(), ShouldSkipZero);
  } else
    printMetadata(Name, MD);
}
 
template <class IntTy>
void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
  if (ShouldSkipZero && !Int)
    return;
 
  Out << FS << Name << ": " << Int;
}
 
void MDFieldPrinter::printAPInt(StringRef Name, const APInt &Int,
                                bool IsUnsigned, bool ShouldSkipZero) {
  if (ShouldSkipZero && Int.isZero())
    return;
 
  Out << FS << Name << ": ";
  Int.print(Out, !IsUnsigned);
}
 
void MDFieldPrinter::printBool(StringRef Name, bool Value,
                               std::optional<bool> Default) {
  if (Default && Value == *Default)
    return;
  Out << FS << Name << ": " << (Value ? "true" : "false");
}
 
void MDFieldPrinter::printDIFlags(StringRef Name, DINode::DIFlags Flags) {
  if (!Flags)
    return;
 
  Out << FS << Name << ": ";
 
  SmallVector<DINode::DIFlags, 8> SplitFlags;
  auto Extra = DINode::splitFlags(Flags, SplitFlags);
 
  ListSeparator FlagsFS(" | ");
  for (auto F : SplitFlags) {
    auto StringF = DINode::getFlagString(F);
    assert(!StringF.empty() && "Expected valid flag");
    Out << FlagsFS << StringF;
  }
  if (Extra || SplitFlags.empty())
    Out << FlagsFS << Extra;
}
 
void MDFieldPrinter::printDISPFlags(StringRef Name,
                                    DISubprogram::DISPFlags Flags) {
  // Always print this field, because no flags in the IR at all will be
  // interpreted as old-style isDefinition: true.
  Out << FS << Name << ": ";
 
  if (!Flags) {
    Out << 0;
    return;
  }
 
  SmallVector<DISubprogram::DISPFlags, 8> SplitFlags;
  auto Extra = DISubprogram::splitFlags(Flags, SplitFlags);
 
  ListSeparator FlagsFS(" | ");
  for (auto F : SplitFlags) {
    auto StringF = DISubprogram::getFlagString(F);
    assert(!StringF.empty() && "Expected valid flag");
    Out << FlagsFS << StringF;
  }
  if (Extra || SplitFlags.empty())
    Out << FlagsFS << Extra;
}
 
void MDFieldPrinter::printEmissionKind(StringRef Name,
                                       DICompileUnit::DebugEmissionKind EK) {
  Out << FS << Name << ": " << DICompileUnit::emissionKindString(EK);
}
 
void MDFieldPrinter::printNameTableKind(StringRef Name,
                                        DICompileUnit::DebugNameTableKind NTK) {
  if (NTK == DICompileUnit::DebugNameTableKind::Default)
    return;
  Out << FS << Name << ": " << DICompileUnit::nameTableKindString(NTK);
}
 
void MDFieldPrinter::printFixedPointKind(StringRef Name,
                                         DIFixedPointType::FixedPointKind V) {
  Out << FS << Name << ": " << DIFixedPointType::fixedPointKindString(V);
}
 
template <class IntTy, class Stringifier>
void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
                                    Stringifier toString, bool ShouldSkipZero) {
  if (ShouldSkipZero && !Value)
    return;
 
  Out << FS << Name << ": ";
  auto S = toString(Value);
  if (!S.empty())
    Out << S;
  else
    Out << Value;
}
 
static void writeGenericDINode(raw_ostream &Out, const GenericDINode *N,
                               AsmWriterContext &WriterCtx) {
  Out << "!GenericDINode(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printTag(N);
  Printer.printString("header", N->getHeader());
  if (N->getNumDwarfOperands()) {
    Out << Printer.FS << "operands: {";
    ListSeparator IFS;
    for (auto &I : N->dwarf_operands()) {
      Out << IFS;
      writeMetadataAsOperand(Out, I, WriterCtx);
    }
    Out << "}";
  }
  Out << ")";
}
 
static void writeDILocation(raw_ostream &Out, const DILocation *DL,
                            AsmWriterContext &WriterCtx) {
  Out << "!DILocation(";
  MDFieldPrinter Printer(Out, WriterCtx);
  // Always output the line, since 0 is a relevant and important value for it.
  Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
  Printer.printInt("column", DL->getColumn());
  Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
  Printer.printBool("isImplicitCode", DL->isImplicitCode(),
                    /* Default */ false);
  Printer.printInt("atomGroup", DL->getAtomGroup());
  Printer.printInt<unsigned>("atomRank", DL->getAtomRank());
  Printer.printMetadata("irlayers", DL->getRawIRLayers());
  Out << ")";
}
 
static void writeDILayerLoc(raw_ostream &Out, const DILayerLoc *N,
                            AsmWriterContext &WriterCtx) {
  Out << "!DILayerLoc(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printInt("line", N->getLine(), /* ShouldSkipZero */ false);
  Printer.printInt("column", N->getColumn());
  Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
  Printer.printString("kind", N->getKind(), /* ShouldSkipEmpty */ false);
  Out << ")";
}
 
static void writeDILayerLocList(raw_ostream &Out, const DILayerLocList *N,
                                AsmWriterContext &WriterCtx) {
  Out << "!DILayerLocList(";
  ListSeparator FS;
  for (const MDOperand &Op : N->operands()) {
    Out << FS;
    writeMetadataAsOperand(Out, Op, WriterCtx);
  }
  Out << ")";
}
 
static void writeDIAssignID(raw_ostream &Out, const DIAssignID *DL,
                            AsmWriterContext &WriterCtx) {
  Out << "!DIAssignID()";
  MDFieldPrinter Printer(Out, WriterCtx);
}
 
static void writeDISubrange(raw_ostream &Out, const DISubrange *N,
                            AsmWriterContext &WriterCtx) {
  Out << "!DISubrange(";
  MDFieldPrinter Printer(Out, WriterCtx);
 
  Printer.printMetadataOrInt("count", N->getRawCountNode(),
                             /* IsUnsigned */ false,
                             /* ShouldSkipZero */ false);
 
  // A lowerBound of constant 0 should not be skipped, since it is different
  // from an unspecified lower bound (= nullptr).
  Printer.printMetadataOrInt("lowerBound", N->getRawLowerBound(),
                             /* IsUnsigned */ false,
                             /* ShouldSkipZero */ false);
  Printer.printMetadataOrInt("upperBound", N->getRawUpperBound(),
                             /* IsUnsigned */ false,
                             /* ShouldSkipZero */ false);
  Printer.printMetadataOrInt("stride", N->getRawStride(),
                             /* IsUnsigned */ false,
                             /* ShouldSkipZero */ false);
 
  Out << ")";
}
 
static void writeDIGenericSubrange(raw_ostream &Out, const DIGenericSubrange *N,
                                   AsmWriterContext &WriterCtx) {
  Out << "!DIGenericSubrange(";
  MDFieldPrinter Printer(Out, WriterCtx);
 
  auto GetConstant = [&](Metadata *Bound) -> std::optional<int64_t> {
    auto *BE = dyn_cast_or_null<DIExpression>(Bound);
    if (!BE)
      return std::nullopt;
    if (BE->isConstant() &&
        DIExpression::SignedOrUnsignedConstant::SignedConstant ==
            *BE->isConstant()) {
      return static_cast<int64_t>(BE->getElement(1));
    }
    return std::nullopt;
  };
 
  auto *Count = N->getRawCountNode();
  if (auto ConstantCount = GetConstant(Count))
    Printer.printInt("count", *ConstantCount,
                     /* ShouldSkipZero */ false);
  else
    Printer.printMetadata("count", Count, /*ShouldSkipNull */ true);
 
  auto *LBound = N->getRawLowerBound();
  if (auto ConstantLBound = GetConstant(LBound))
    Printer.printInt("lowerBound", *ConstantLBound,
                     /* ShouldSkipZero */ false);
  else
    Printer.printMetadata("lowerBound", LBound, /*ShouldSkipNull */ true);
 
  auto *UBound = N->getRawUpperBound();
  if (auto ConstantUBound = GetConstant(UBound))
    Printer.printInt("upperBound", *ConstantUBound,
                     /* ShouldSkipZero */ false);
  else
    Printer.printMetadata("upperBound", UBound, /*ShouldSkipNull */ true);
 
  auto *Stride = N->getRawStride();
  if (auto ConstantStride = GetConstant(Stride))
    Printer.printInt("stride", *ConstantStride,
                     /* ShouldSkipZero */ false);
  else
    Printer.printMetadata("stride", Stride, /*ShouldSkipNull */ true);
 
  Out << ")";
}
 
static void writeDIEnumerator(raw_ostream &Out, const DIEnumerator *N,
                              AsmWriterContext &) {
  Out << "!DIEnumerator(";
  MDFieldPrinter Printer(Out);
  Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
  Printer.printAPInt("value", N->getValue(), N->isUnsigned(),
                     /*ShouldSkipZero=*/false);
  if (N->isUnsigned())
    Printer.printBool("isUnsigned", true);
  Out << ")";
}
 
static void writeDIBasicType(raw_ostream &Out, const DIBasicType *N,
                             AsmWriterContext &WriterCtx) {
  Out << "!DIBasicType(";
  MDFieldPrinter Printer(Out, WriterCtx);
  if (N->getTag() != dwarf::DW_TAG_base_type)
    Printer.printTag(N);
  Printer.printString("name", N->getName());
  Printer.printMetadata("scope", N->getRawScope());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadataOrInt("size", N->getRawSizeInBits(), true);
  Printer.printInt("align", N->getAlignInBits());
  Printer.printInt("dataSize", N->getDataSizeInBits());
  Printer.printDwarfEnum("encoding", N->getEncoding(),
                         dwarf::AttributeEncodingString);
  Printer.printInt("num_extra_inhabitants", N->getNumExtraInhabitants());
  Printer.printDIFlags("flags", N->getFlags());
  Out << ")";
}
 
static void writeDIFixedPointType(raw_ostream &Out, const DIFixedPointType *N,
                                  AsmWriterContext &WriterCtx) {
  Out << "!DIFixedPointType(";
  MDFieldPrinter Printer(Out, WriterCtx);
  if (N->getTag() != dwarf::DW_TAG_base_type)
    Printer.printTag(N);
  Printer.printString("name", N->getName());
  Printer.printMetadata("scope", N->getRawScope());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadataOrInt("size", N->getRawSizeInBits(), true);
  Printer.printInt("align", N->getAlignInBits());
  Printer.printDwarfEnum("encoding", N->getEncoding(),
                         dwarf::AttributeEncodingString);
  Printer.printDIFlags("flags", N->getFlags());
  Printer.printFixedPointKind("kind", N->getKind());
  if (N->isRational()) {
    bool IsUnsigned = !N->isSigned();
    Printer.printAPInt("numerator", N->getNumerator(), IsUnsigned, false);
    Printer.printAPInt("denominator", N->getDenominator(), IsUnsigned, false);
  } else {
    Printer.printInt("factor", N->getFactor());
  }
  Out << ")";
}
 
static void writeDIStringType(raw_ostream &Out, const DIStringType *N,
                              AsmWriterContext &WriterCtx) {
  Out << "!DIStringType(";
  MDFieldPrinter Printer(Out, WriterCtx);
  if (N->getTag() != dwarf::DW_TAG_string_type)
    Printer.printTag(N);
  Printer.printString("name", N->getName());
  Printer.printMetadata("stringLength", N->getRawStringLength());
  Printer.printMetadata("stringLengthExpression", N->getRawStringLengthExp());
  Printer.printMetadata("stringLocationExpression",
                        N->getRawStringLocationExp());
  Printer.printMetadataOrInt("size", N->getRawSizeInBits(), true);
  Printer.printInt("align", N->getAlignInBits());
  Printer.printDwarfEnum("encoding", N->getEncoding(),
                         dwarf::AttributeEncodingString);
  Printer.printMetadata("charType", N->getRawCharType());
  Out << ")";
}
 
static void writeDIDerivedType(raw_ostream &Out, const DIDerivedType *N,
                               AsmWriterContext &WriterCtx) {
  Out << "!DIDerivedType(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printTag(N);
  Printer.printString("name", N->getName());
  Printer.printMetadata("scope", N->getRawScope());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadata("baseType", N->getRawBaseType(),
                        /* ShouldSkipNull */ false);
  Printer.printMetadataOrInt("size", N->getRawSizeInBits(), true);
  Printer.printInt("align", N->getAlignInBits());
  Printer.printMetadataOrInt("offset", N->getRawOffsetInBits(), true);
  Printer.printDIFlags("flags", N->getFlags());
  Printer.printMetadata("extraData", N->getRawExtraData());
  if (const auto &DWARFAddressSpace = N->getDWARFAddressSpace())
    Printer.printInt("dwarfAddressSpace", *DWARFAddressSpace,
                     /* ShouldSkipZero */ false);
  Printer.printMetadata("annotations", N->getRawAnnotations());
  if (auto PtrAuthData = N->getPtrAuthData()) {
    Printer.printInt("ptrAuthKey", PtrAuthData->key());
    Printer.printBool("ptrAuthIsAddressDiscriminated",
                      PtrAuthData->isAddressDiscriminated());
    Printer.printInt("ptrAuthExtraDiscriminator",
                     PtrAuthData->extraDiscriminator());
    Printer.printBool("ptrAuthIsaPointer", PtrAuthData->isaPointer());
    Printer.printBool("ptrAuthAuthenticatesNullValues",
                      PtrAuthData->authenticatesNullValues());
  }
  Out << ")";
}
 
static void writeDISubrangeType(raw_ostream &Out, const DISubrangeType *N,
                                AsmWriterContext &WriterCtx) {
  Out << "!DISubrangeType(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printString("name", N->getName());
  Printer.printMetadata("scope", N->getRawScope());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadataOrInt("size", N->getRawSizeInBits(), true);
  Printer.printInt("align", N->getAlignInBits());
  Printer.printDIFlags("flags", N->getFlags());
  Printer.printMetadata("baseType", N->getRawBaseType(),
                        /* ShouldSkipNull */ false);
  Printer.printMetadata("lowerBound", N->getRawLowerBound());
  Printer.printMetadata("upperBound", N->getRawUpperBound());
  Printer.printMetadata("stride", N->getRawStride());
  Printer.printMetadata("bias", N->getRawBias());
  Out << ")";
}
 
static void writeDICompositeType(raw_ostream &Out, const DICompositeType *N,
                                 AsmWriterContext &WriterCtx) {
  Out << "!DICompositeType(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printTag(N);
  Printer.printString("name", N->getName());
  Printer.printMetadata("scope", N->getRawScope());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadata("baseType", N->getRawBaseType());
  Printer.printMetadataOrInt("size", N->getRawSizeInBits(), true);
  Printer.printInt("align", N->getAlignInBits());
  Printer.printMetadataOrInt("offset", N->getRawOffsetInBits(), true);
  Printer.printInt("num_extra_inhabitants", N->getNumExtraInhabitants());
  Printer.printDIFlags("flags", N->getFlags());
  Printer.printMetadata("elements", N->getRawElements());
  Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
                         dwarf::LanguageString);
  Printer.printMetadata("vtableHolder", N->getRawVTableHolder());
  Printer.printMetadata("templateParams", N->getRawTemplateParams());
  Printer.printString("identifier", N->getIdentifier());
  Printer.printMetadata("discriminator", N->getRawDiscriminator());
  Printer.printMetadata("dataLocation", N->getRawDataLocation());
  Printer.printMetadata("associated", N->getRawAssociated());
  Printer.printMetadata("allocated", N->getRawAllocated());
  if (auto *RankConst = N->getRankConst())
    Printer.printInt("rank", RankConst->getSExtValue(),
                     /* ShouldSkipZero */ false);
  else
    Printer.printMetadata("rank", N->getRawRank(), /*ShouldSkipNull */ true);
  Printer.printMetadata("annotations", N->getRawAnnotations());
  if (auto *Specification = N->getRawSpecification())
    Printer.printMetadata("specification", Specification);
 
  if (auto EnumKind = N->getEnumKind())
    Printer.printDwarfEnum("enumKind", *EnumKind, dwarf::EnumKindString,
                           /*ShouldSkipZero=*/false);
 
  Printer.printMetadata("bitStride", N->getRawBitStride());
  Out << ")";
}
 
static void writeDISubroutineType(raw_ostream &Out, const DISubroutineType *N,
                                  AsmWriterContext &WriterCtx) {
  Out << "!DISubroutineType(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printDIFlags("flags", N->getFlags());
  Printer.printDwarfEnum("cc", N->getCC(), dwarf::ConventionString);
  Printer.printMetadata("types", N->getRawTypeArray(),
                        /* ShouldSkipNull */ false);
  Out << ")";
}
 
static void writeDIFile(raw_ostream &Out, const DIFile *N, AsmWriterContext &) {
  Out << "!DIFile(";
  MDFieldPrinter Printer(Out);
  Printer.printString("filename", N->getFilename(),
                      /* ShouldSkipEmpty */ false);
  Printer.printString("directory", N->getDirectory(),
                      /* ShouldSkipEmpty */ false);
  // Print all values for checksum together, or not at all.
  if (N->getChecksum())
    Printer.printChecksum(*N->getChecksum());
  if (N->getSource())
    Printer.printString("source", *N->getSource(),
                        /* ShouldSkipEmpty */ false);
  Out << ")";
}
 
static void writeDICompileUnit(raw_ostream &Out, const DICompileUnit *N,
                               AsmWriterContext &WriterCtx) {
  Out << "!DICompileUnit(";
  MDFieldPrinter Printer(Out, WriterCtx);
 
  DISourceLanguageName Lang = N->getSourceLanguage();
 
  if (Lang.hasVersionedName()) {
    Printer.printDwarfEnum(
        "sourceLanguageName",
        static_cast<llvm::dwarf::SourceLanguageName>(Lang.getName()),
        dwarf::SourceLanguageNameString,
        /* ShouldSkipZero */ false);
 
    Printer.printInt("sourceLanguageVersion", Lang.getVersion(),
                     /*ShouldSkipZero=*/true);
  } else {
    Printer.printDwarfEnum("language", Lang.getName(), dwarf::LanguageString,
                           /* ShouldSkipZero */ false);
  }
 
  Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
  Printer.printString("producer", N->getProducer());
  Printer.printBool("isOptimized", N->isOptimized());
  Printer.printString("flags", N->getFlags());
  Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
                   /* ShouldSkipZero */ false);
  Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
  Printer.printEmissionKind("emissionKind", N->getEmissionKind());
  Printer.printMetadata("enums", N->getRawEnumTypes());
  Printer.printMetadata("retainedTypes", N->getRawRetainedTypes());
  Printer.printMetadata("globals", N->getRawGlobalVariables());
  Printer.printMetadata("imports", N->getRawImportedEntities());
  Printer.printMetadata("macros", N->getRawMacros());
  Printer.printInt("dwoId", N->getDWOId());
  Printer.printBool("splitDebugInlining", N->getSplitDebugInlining(), true);
  Printer.printBool("debugInfoForProfiling", N->getDebugInfoForProfiling(),
                    false);
  Printer.printNameTableKind("nameTableKind", N->getNameTableKind());
  Printer.printBool("rangesBaseAddress", N->getRangesBaseAddress(), false);
  Printer.printString("sysroot", N->getSysRoot());
  Printer.printString("sdk", N->getSDK());
  Printer.printDwarfEnum("dialect", Lang.getDialect(),
                         dwarf::LanguageDialectString);
  Out << ")";
}
 
static void writeDISubprogram(raw_ostream &Out, const DISubprogram *N,
                              AsmWriterContext &WriterCtx) {
  Out << "!DISubprogram(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printString("name", N->getName());
  Printer.printString("linkageName", N->getLinkageName());
  Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadata("type", N->getRawType());
  Printer.printInt("scopeLine", N->getScopeLine());
  Printer.printMetadata("containingType", N->getRawContainingType());
  if (N->getVirtuality() != dwarf::DW_VIRTUALITY_none ||
      N->getVirtualIndex() != 0)
    Printer.printInt("virtualIndex", N->getVirtualIndex(), false);
  Printer.printInt("thisAdjustment", N->getThisAdjustment());
  Printer.printDIFlags("flags", N->getFlags());
  Printer.printDISPFlags("spFlags", N->getSPFlags());
  Printer.printMetadata("unit", N->getRawUnit());
  Printer.printMetadata("templateParams", N->getRawTemplateParams());
  Printer.printMetadata("declaration", N->getRawDeclaration());
  Printer.printMetadata("retainedNodes", N->getRawRetainedNodes());
  Printer.printMetadata("thrownTypes", N->getRawThrownTypes());
  Printer.printMetadata("annotations", N->getRawAnnotations());
  Printer.printString("targetFuncName", N->getTargetFuncName());
  Printer.printBool("keyInstructions", N->getKeyInstructionsEnabled(), false);
  Out << ")";
}
 
static void writeDILexicalBlock(raw_ostream &Out, const DILexicalBlock *N,
                                AsmWriterContext &WriterCtx) {
  Out << "!DILexicalBlock(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printInt("column", N->getColumn());
  Out << ")";
}
 
static void writeDILexicalBlockFile(raw_ostream &Out,
                                    const DILexicalBlockFile *N,
                                    AsmWriterContext &WriterCtx) {
  Out << "!DILexicalBlockFile(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("discriminator", N->getDiscriminator(),
                   /* ShouldSkipZero */ false);
  Out << ")";
}
 
static void writeDINamespace(raw_ostream &Out, const DINamespace *N,
                             AsmWriterContext &WriterCtx) {
  Out << "!DINamespace(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printString("name", N->getName());
  Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printBool("exportSymbols", N->getExportSymbols(), false);
  Out << ")";
}
 
static void writeDICommonBlock(raw_ostream &Out, const DICommonBlock *N,
                               AsmWriterContext &WriterCtx) {
  Out << "!DICommonBlock(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printMetadata("scope", N->getRawScope(), false);
  Printer.printMetadata("declaration", N->getRawDecl(), false);
  Printer.printString("name", N->getName());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLineNo());
  Out << ")";
}
 
static void writeDIMacro(raw_ostream &Out, const DIMacro *N,
                         AsmWriterContext &WriterCtx) {
  Out << "!DIMacro(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printMacinfoType(N);
  Printer.printInt("line", N->getLine());
  Printer.printString("name", N->getName());
  Printer.printString("value", N->getValue());
  Out << ")";
}
 
static void writeDIMacroFile(raw_ostream &Out, const DIMacroFile *N,
                             AsmWriterContext &WriterCtx) {
  Out << "!DIMacroFile(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printInt("line", N->getLine());
  Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
  Printer.printMetadata("nodes", N->getRawElements());
  Out << ")";
}
 
static void writeDIModule(raw_ostream &Out, const DIModule *N,
                          AsmWriterContext &WriterCtx) {
  Out << "!DIModule(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printString("name", N->getName());
  Printer.printString("configMacros", N->getConfigurationMacros());
  Printer.printString("includePath", N->getIncludePath());
  Printer.printString("apinotes", N->getAPINotesFile());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLineNo());
  Printer.printBool("isDecl", N->getIsDecl(), /* Default */ false);
  Out << ")";
}
 
static void writeDITemplateTypeParameter(raw_ostream &Out,
                                         const DITemplateTypeParameter *N,
                                         AsmWriterContext &WriterCtx) {
  Out << "!DITemplateTypeParameter(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printString("name", N->getName());
  Printer.printMetadata("type", N->getRawType(), /* ShouldSkipNull */ false);
  Printer.printBool("defaulted", N->isDefault(), /* Default= */ false);
  Out << ")";
}
 
static void writeDITemplateValueParameter(raw_ostream &Out,
                                          const DITemplateValueParameter *N,
                                          AsmWriterContext &WriterCtx) {
  Out << "!DITemplateValueParameter(";
  MDFieldPrinter Printer(Out, WriterCtx);
  if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
    Printer.printTag(N);
  Printer.printString("name", N->getName());
  Printer.printMetadata("type", N->getRawType());
  Printer.printBool("defaulted", N->isDefault(), /* Default= */ false);
  Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
  Out << ")";
}
 
static void writeDIGlobalVariable(raw_ostream &Out, const DIGlobalVariable *N,
                                  AsmWriterContext &WriterCtx) {
  Out << "!DIGlobalVariable(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printString("name", N->getName());
  Printer.printString("linkageName", N->getLinkageName());
  Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadata("type", N->getRawType());
  Printer.printBool("isLocal", N->isLocalToUnit());
  Printer.printBool("isDefinition", N->isDefinition());
  Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
  Printer.printMetadata("templateParams", N->getRawTemplateParams());
  Printer.printInt("align", N->getAlignInBits());
  Printer.printMetadata("annotations", N->getRawAnnotations());
  Out << ")";
}
 
static void writeDILocalVariable(raw_ostream &Out, const DILocalVariable *N,
                                 AsmWriterContext &WriterCtx) {
  Out << "!DILocalVariable(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printString("name", N->getName());
  Printer.printInt("arg", N->getArg());
  Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadata("type", N->getRawType());
  Printer.printDIFlags("flags", N->getFlags());
  Printer.printInt("align", N->getAlignInBits());
  Printer.printMetadata("annotations", N->getRawAnnotations());
  Out << ")";
}
 
static void writeDILabel(raw_ostream &Out, const DILabel *N,
                         AsmWriterContext &WriterCtx) {
  Out << "!DILabel(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printString("name", N->getName());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine(), /* ShouldSkipZero */ false);
  Printer.printInt("column", N->getColumn());
  Printer.printBool("isArtificial", N->isArtificial(), false);
  if (N->getCoroSuspendIdx())
    Printer.printInt("coroSuspendIdx", *N->getCoroSuspendIdx(),
                     /* ShouldSkipZero */ false);
  Out << ")";
}
 
static void writeDIExpression(raw_ostream &Out, const DIExpression *N,
                              AsmWriterContext &WriterCtx) {
  Out << "!DIExpression(";
  ListSeparator FS;
  if (N->isValid()) {
    for (const DIExpression::ExprOperand &Op : N->expr_ops()) {
      auto OpStr = dwarf::OperationEncodingString(Op.getOp());
      assert(!OpStr.empty() && "Expected valid opcode");
 
      Out << FS << OpStr;
      if (auto Convert = dyn_cast<DIExpression::ConvertOp>(Op)) {
        Out << FS << Convert.getBitSize();
        Out << FS << dwarf::AttributeEncodingString(Convert.getEncoding());
      } else {
        for (unsigned A = 0, AE = Op.getNumArgs(); A != AE; ++A)
          Out << FS << Op.getArg(A);
      }
    }
  } else {
    for (const auto &I : N->getElements())
      Out << FS << I;
  }
  Out << ")";
}
 
static void writeDIArgList(raw_ostream &Out, const DIArgList *N,
                           AsmWriterContext &WriterCtx,
                           bool FromValue = false) {
  assert(FromValue &&
         "Unexpected DIArgList metadata outside of value argument");
  Out << "!DIArgList(";
  ListSeparator FS;
  MDFieldPrinter Printer(Out, WriterCtx);
  for (const Metadata *Arg : N->getArgs()) {
    Out << FS;
    writeAsOperandInternal(Out, Arg, WriterCtx, true);
  }
  Out << ")";
}
 
static void writeDIGlobalVariableExpression(raw_ostream &Out,
                                            const DIGlobalVariableExpression *N,
                                            AsmWriterContext &WriterCtx) {
  Out << "!DIGlobalVariableExpression(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printMetadata("var", N->getVariable());
  Printer.printMetadata("expr", N->getExpression());
  Out << ")";
}
 
static void writeDIObjCProperty(raw_ostream &Out, const DIObjCProperty *N,
                                AsmWriterContext &WriterCtx) {
  Out << "!DIObjCProperty(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printString("name", N->getName());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printString("setter", N->getSetterName());
  Printer.printString("getter", N->getGetterName());
  Printer.printInt("attributes", N->getAttributes());
  Printer.printMetadata("type", N->getRawType());
  Out << ")";
}
 
static void writeDIProperty(raw_ostream &Out, const DIProperty *N,
                            AsmWriterContext &WriterCtx) {
  Out << "!DIProperty(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printString("name", N->getName());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadata("type", N->getRawType());
  Printer.printMetadata("backing_storage", N->getRawBackingStorage());
  Out << ")";
}
 
static void writeDIImportedEntity(raw_ostream &Out, const DIImportedEntity *N,
                                  AsmWriterContext &WriterCtx) {
  Out << "!DIImportedEntity(";
  MDFieldPrinter Printer(Out, WriterCtx);
  Printer.printTag(N);
  Printer.printString("name", N->getName());
  Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
  Printer.printMetadata("entity", N->getRawEntity());
  Printer.printMetadata("file", N->getRawFile());
  Printer.printInt("line", N->getLine());
  Printer.printMetadata("elements", N->getRawElements());
  Out << ")";
}
 
static void writeMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
                                    AsmWriterContext &Ctx) {
  if (Node->isDistinct())
    Out << "distinct ";
  else if (Node->isTemporary())
    Out << "<temporary!> "; // Handle broken code.
 
  switch (Node->getMetadataID()) {
  default:
    llvm_unreachable("Expected uniquable MDNode");
#define HANDLE_MDNODE_LEAF(CLASS)                                              \
  case Metadata::CLASS##Kind:                                                  \
    write##CLASS(Out, cast<CLASS>(Node), Ctx);                                 \
    break;
#include "llvm/IR/Metadata.def"
  }
}
 
// Full implementation of printing a Value as an operand with support for
// TypePrinting, etc.
static void writeAsOperandInternal(raw_ostream &Out, const Value *V,
                                   AsmWriterContext &WriterCtx,
                                   bool PrintType) {
  if (PrintType) {
    WriterCtx.TypePrinter->print(V->getType(), Out);
    Out << ' ';
  }
 
  if (V->hasName()) {
    printLLVMName(Out, V);
    return;
  }
 
  const auto *CV = dyn_cast<Constant>(V);
  if (CV && !isa<GlobalValue>(CV)) {
    assert(WriterCtx.TypePrinter && "Constants require TypePrinting!");
    writeConstantInternal(Out, CV, WriterCtx);
    return;
  }
 
  if (const auto *IA = dyn_cast<InlineAsm>(V)) {
    Out << "asm ";
    if (IA->hasSideEffects())
      Out << "sideeffect ";
    if (IA->isAlignStack())
      Out << "alignstack ";
    // We don't emit the AD_ATT dialect as it's the assumed default.
    if (IA->getDialect() == InlineAsm::AD_Intel)
      Out << "inteldialect ";
    if (IA->canThrow())
      Out << "unwind ";
    Out << '"';
    printEscapedString(IA->getAsmString(), Out);
    Out << "\", \"";
    printEscapedString(IA->getConstraintString(), Out);
    Out << '"';
    return;
  }
 
  if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
    writeAsOperandInternal(Out, MD->getMetadata(), WriterCtx,
                           /* FromValue */ true);
    return;
  }
 
  char Prefix = '%';
  int Slot;
  auto *Machine = WriterCtx.Machine;
  // If we have a SlotTracker, use it.
  if (Machine) {
    if (const auto *GV = dyn_cast<GlobalValue>(V)) {
      Slot = Machine->getGlobalSlot(GV);
      Prefix = '@';
    } else {
      Slot = Machine->getLocalSlot(V);
 
      // If the local value didn't succeed, then we may be referring to a value
      // from a different function.  Translate it, as this can happen when using
      // address of blocks.
      if (Slot == -1)
        if ((Machine = createSlotTracker(V))) {
          Slot = Machine->getLocalSlot(V);
          delete Machine;
        }
    }
  } else if ((Machine = createSlotTracker(V))) {
    // Otherwise, create one to get the # and then destroy it.
    if (const auto *GV = dyn_cast<GlobalValue>(V)) {
      Slot = Machine->getGlobalSlot(GV);
      Prefix = '@';
    } else {
      Slot = Machine->getLocalSlot(V);
    }
    delete Machine;
    Machine = nullptr;
  } else {
    Slot = -1;
  }
 
  if (Slot != -1)
    Out << Prefix << Slot;
  else
    Out << "<badref>";
}
 
static void writeAsOperandInternal(raw_ostream &Out, const Metadata *MD,
                                   AsmWriterContext &WriterCtx,
                                   bool FromValue) {
  // Write DIExpressions and DIArgLists inline when used as a value. Improves
  // readability of debug info intrinsics.
  if (const auto *Expr = dyn_cast<DIExpression>(MD)) {
    writeDIExpression(Out, Expr, WriterCtx);
    return;
  }
  if (const auto *ArgList = dyn_cast<DIArgList>(MD)) {
    writeDIArgList(Out, ArgList, WriterCtx, FromValue);
    return;
  }
 
  if (const auto *N = dyn_cast<MDNode>(MD)) {
    if (const auto *Loc = dyn_cast<DILocation>(N);
        Loc && WriterCtx.MST &&
        WriterCtx.MST->shouldPrintDebugLocationInline(Loc)) {
      writeDILocation(Out, Loc, WriterCtx);
      return;
    }
 
    std::unique_ptr<SlotTracker> MachineStorage;
    SaveAndRestore SARMachine(WriterCtx.Machine);
    if (!WriterCtx.Machine) {
      MachineStorage = std::make_unique<SlotTracker>(WriterCtx.Context);
      WriterCtx.Machine = MachineStorage.get();
    }
    int Slot = WriterCtx.Machine->getMetadataSlot(N);
    if (Slot == -1) {
      if (const auto *Loc = dyn_cast<DILocation>(N)) {
        writeDILocation(Out, Loc, WriterCtx);
        return;
      }
      // Give the pointer value instead of "badref", since this comes up all
      // the time when debugging.
      Out << "<" << N << ">";
    } else
      Out << '!' << Slot;
    return;
  }
 
  if (const auto *MDS = dyn_cast<MDString>(MD)) {
    Out << "!\"";
    printEscapedString(MDS->getString(), Out);
    Out << '"';
    return;
  }
 
  auto *V = cast<ValueAsMetadata>(MD);
  assert(WriterCtx.TypePrinter && "TypePrinter required for metadata values");
  assert((FromValue || !isa<LocalAsMetadata>(V)) &&
         "Unexpected function-local metadata outside of value argument");
 
  writeAsOperandInternal(Out, V->getValue(), WriterCtx, /*PrintType=*/true);
}
 
namespace {
 
class AssemblyWriter {
  formatted_raw_ostream &Out;
  const Module *TheModule = nullptr;
  const ModuleSummaryIndex *TheIndex = nullptr;
  std::unique_ptr<SlotTracker> SlotTrackerStorage;
  SlotTracker &Machine;
  TypePrinting TypePrinter;
  AssemblyAnnotationWriter *AnnotationWriter = nullptr;
  bool IsForDebug;
  bool ShouldPreserveUseListOrder;
  UseListOrderMap UseListOrders;
  SmallVector<StringRef, 8> MDNames;
  /// Synchronization scope names registered with LLVMContext.
  SmallVector<StringRef, 8> SSNs;
  DenseMap<const GlobalValueSummary *, GlobalValue::GUID> SummaryToGUIDMap;
 
public:
  /// Construct an AssemblyWriter with an external SlotTracker
  AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
                 AssemblyAnnotationWriter *AAW, bool IsForDebug,
                 bool ShouldPreserveUseListOrder = false);
 
  AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
                 const ModuleSummaryIndex *Index, bool IsForDebug);
 
  AsmWriterContext getContext() {
    return AsmWriterContext(&TypePrinter, &Machine, TheModule);
  }
 
  void printMDNodeBody(const MDNode *MD);
  void printNamedMDNode(const NamedMDNode *NMD);
 
  void printModule(const Module *M);
 
  void writeOperand(const Value *Op, bool PrintType);
  void writeParamOperand(const Value *Operand, AttributeSet Attrs);
  void writeOperandBundles(const CallBase *Call);
  void writeSyncScope(const LLVMContext &Context,
                      SyncScope::ID SSID);
  void writeAtomic(const LLVMContext &Context,
                   AtomicOrdering Ordering,
                   SyncScope::ID SSID);
  void writeAtomicCmpXchg(const LLVMContext &Context,
                          AtomicOrdering SuccessOrdering,
                          AtomicOrdering FailureOrdering,
                          SyncScope::ID SSID);
 
  void writeAllMDNodes();
  void writeMDNode(unsigned Slot, const MDNode *Node);
  void writeAttribute(const Attribute &Attr, bool InAttrGroup = false);
  void writeAttributeSet(const AttributeSet &AttrSet, bool InAttrGroup = false);
  void writeAllAttributeGroups();
 
  void printTypeIdentities();
  void printGlobal(const GlobalVariable *GV);
  void printAlias(const GlobalAlias *GA);
  void printIFunc(const GlobalIFunc *GI);
  void printComdat(const Comdat *C);
  void printFunction(const Function *F);
  void printArgument(const Argument *FA, AttributeSet Attrs);
  void printBasicBlock(const BasicBlock *BB);
  void printInstructionLine(const Instruction &I);
  void printInstruction(const Instruction &I);
  void printDbgMarker(const DbgMarker &DPI);
  void printDbgVariableRecord(const DbgVariableRecord &DVR);
  void printDbgLabelRecord(const DbgLabelRecord &DLR);
  void printDbgRecord(const DbgRecord &DR);
  void printDbgRecordLine(const DbgRecord &DR);
 
  void printUseListOrder(const Value *V, ArrayRef<unsigned> Shuffle);
  void printUseLists(const Function *F);
 
  void printModuleSummaryIndex();
  void printSummaryInfo(unsigned Slot, const ValueInfo &VI);
  void printSummary(const GlobalValueSummary &Summary);
  void printAliasSummary(const AliasSummary *AS);
  void printGlobalVarSummary(const GlobalVarSummary *GS);
  void printFunctionSummary(const FunctionSummary *FS);
  void printTypeIdSummary(const TypeIdSummary &TIS);
  void printTypeIdCompatibleVtableSummary(const TypeIdCompatibleVtableInfo &TI);
  void printTypeTestResolution(const TypeTestResolution &TTRes);
  void printArgs(ArrayRef<uint64_t> Args);
  void printWPDRes(const WholeProgramDevirtResolution &WPDRes);
  void printTypeIdInfo(const FunctionSummary::TypeIdInfo &TIDInfo);
  void printVFuncId(const FunctionSummary::VFuncId VFId);
  void printNonConstVCalls(ArrayRef<FunctionSummary::VFuncId> VCallList,
                           const char *Tag);
  void printConstVCalls(ArrayRef<FunctionSummary::ConstVCall> VCallList,
                        const char *Tag);
 
private:
  /// Print out metadata attachments.
  void printMetadataAttachments(
      const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
      StringRef Separator);
 
  // printInfoComment - Print a little comment after the instruction indicating
  // which slot it occupies.
  void printInfoComment(const Value &V, bool isMaterializable = false);
 
  // printGCRelocateComment - print comment after call to the gc.relocate
  // intrinsic indicating base and derived pointer names.
  void printGCRelocateComment(const GCRelocateInst &Relocate);
};
 
} // end anonymous namespace
 
AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
                               const Module *M, AssemblyAnnotationWriter *AAW,
                               bool IsForDebug, bool ShouldPreserveUseListOrder)
    : Out(o), TheModule(M), Machine(Mac), TypePrinter(M), AnnotationWriter(AAW),
      IsForDebug(IsForDebug),
      ShouldPreserveUseListOrder(
          PreserveAssemblyUseListOrder.getNumOccurrences()
              ? PreserveAssemblyUseListOrder
              : ShouldPreserveUseListOrder) {}
 
AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
                               const ModuleSummaryIndex *Index, bool IsForDebug)
    : Out(o), TheIndex(Index), Machine(Mac), TypePrinter(/*Module=*/nullptr),
      IsForDebug(IsForDebug),
      ShouldPreserveUseListOrder(PreserveAssemblyUseListOrder) {}
 
void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
  if (!Operand) {
    Out << "<null operand!>";
    return;
  }
  auto WriteCtx = getContext();
  writeAsOperandInternal(Out, Operand, WriteCtx, PrintType);
}
 
void AssemblyWriter::writeSyncScope(const LLVMContext &Context,
                                    SyncScope::ID SSID) {
  switch (SSID) {
  case SyncScope::System: {
    break;
  }
  default: {
    if (SSNs.empty())
      Context.getSyncScopeNames(SSNs);
 
    Out << " syncscope(\"";
    printEscapedString(SSNs[SSID], Out);
    Out << "\")";
    break;
  }
  }
}
 
void AssemblyWriter::writeAtomic(const LLVMContext &Context,
                                 AtomicOrdering Ordering,
                                 SyncScope::ID SSID) {
  if (Ordering == AtomicOrdering::NotAtomic)
    return;
 
  writeSyncScope(Context, SSID);
  Out << " " << toIRString(Ordering);
}
 
void AssemblyWriter::writeAtomicCmpXchg(const LLVMContext &Context,
                                        AtomicOrdering SuccessOrdering,
                                        AtomicOrdering FailureOrdering,
                                        SyncScope::ID SSID) {
  assert(SuccessOrdering != AtomicOrdering::NotAtomic &&
         FailureOrdering != AtomicOrdering::NotAtomic);
 
  writeSyncScope(Context, SSID);
  Out << " " << toIRString(SuccessOrdering);
  Out << " " << toIRString(FailureOrdering);
}
 
void AssemblyWriter::writeParamOperand(const Value *Operand,
                                       AttributeSet Attrs) {
  if (!Operand) {
    Out << "<null operand!>";
    return;
  }
 
  // Print the type
  TypePrinter.print(Operand->getType(), Out);
  // Print parameter attributes list
  if (Attrs.hasAttributes()) {
    Out << ' ';
    writeAttributeSet(Attrs);
  }
  Out << ' ';
  // Print the operand
  auto WriterCtx = getContext();
  writeAsOperandInternal(Out, Operand, WriterCtx);
}
 
void AssemblyWriter::writeOperandBundles(const CallBase *Call) {
  if (!Call->hasOperandBundles())
    return;
 
  Out << " [ ";
 
  ListSeparator LS;
  for (unsigned i = 0, e = Call->getNumOperandBundles(); i != e; ++i) {
    OperandBundleUse BU = Call->getOperandBundleAt(i);
 
    Out << LS << '"';
    printEscapedString(BU.getTagName(), Out);
    Out << '"';
 
    Out << '(';
 
    ListSeparator InnerLS;
    auto WriterCtx = getContext();
    for (const auto &Input : BU.Inputs) {
      Out << InnerLS;
      if (Input == nullptr)
        Out << "<null operand bundle!>";
      else
        writeAsOperandInternal(Out, Input, WriterCtx, /*PrintType=*/true);
    }
 
    Out << ')';
  }
 
  Out << " ]";
}
 
void AssemblyWriter::printModule(const Module *M) {
  Machine.initializeIfNeeded();
 
  if (ShouldPreserveUseListOrder)
    UseListOrders = predictUseListOrder(M);
 
  if (!M->getModuleIdentifier().empty() &&
      // Don't print the ID if it will start a new line (which would
      // require a comment char before it).
      M->getModuleIdentifier().find('\n') == std::string::npos)
    Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
 
  if (!M->getSourceFileName().empty()) {
    Out << "source_filename = \"";
    printEscapedString(M->getSourceFileName(), Out);
    Out << "\"\n";
  }
 
  const std::string &DL = M->getDataLayoutStr();
  if (!DL.empty())
    Out << "target datalayout = \"" << DL << "\"\n";
  if (!M->getTargetTriple().empty())
    Out << "target triple = \"" << M->getTargetTriple().str() << "\"\n";
 
  if (M->hasModuleInlineAsm()) {
    Out << '\n';
 
    for (const Module::GlobalAsmFragment &Frag : M->getModuleInlineAsm()) {
      Out << "module asm";
      SmallVector<std::pair<StringRef, StringRef>> Props =
          Frag.Props.getAsStrings();
      if (!Props.empty()) {
        ListSeparator LS;
        Out << "(";
        for (auto [Key, Value] : Props) {
          Out << LS;
          Out << Key << ": \"";
          printEscapedString(Value, Out);
          Out << "\"";
        }
        Out << ")";
      }
      Out << "\n";
      // Split the string into lines, to make it easier to read the .ll file.
      StringRef Asm = Frag.Asm;
      do {
        StringRef Front;
        std::tie(Front, Asm) = Asm.split('\n');
 
        // We found a newline, print the portion of the asm string from the
        // last newline up to this newline.
        Out << "    \"";
        printEscapedString(Front, Out);
        Out << "\"\n";
      } while (!Asm.empty());
    }
  }
 
  printTypeIdentities();
 
  {
    // Output each used comdat at its first global object.
    SmallPtrSet<const Comdat *, 8> PrintedComdats;
    for (const GlobalObject &GO : M->global_objects()) {
      const Comdat *C = GO.getComdat();
      if (!C || !PrintedComdats.insert(C).second)
        continue;
      Out << '\n';
      printComdat(C);
    }
  }
 
  // Output all globals.
  if (!M->global_empty()) Out << '\n';
  for (const GlobalVariable &GV : M->globals()) {
    printGlobal(&GV); Out << '\n';
  }
 
  // Output all aliases.
  if (!M->alias_empty()) Out << "\n";
  for (const GlobalAlias &GA : M->aliases())
    printAlias(&GA);
 
  // Output all ifuncs.
  if (!M->ifunc_empty()) Out << "\n";
  for (const GlobalIFunc &GI : M->ifuncs())
    printIFunc(&GI);
 
  // Output all of the functions.
  for (const Function &F : *M) {
    Out << '\n';
    printFunction(&F);
  }
 
  // Output global use-lists.
  printUseLists(nullptr);
 
  // Output all attribute groups.
  if (!Machine.as_empty()) {
    Out << '\n';
    writeAllAttributeGroups();
  }
 
  // Output named metadata.
  if (!M->named_metadata_empty()) Out << '\n';
 
  for (const NamedMDNode &Node : M->named_metadata())
    printNamedMDNode(&Node);
 
  // Output metadata.
  if (!Machine.mdn_empty()) {
    Out << '\n';
    writeAllMDNodes();
  }
}
 
void AssemblyWriter::printModuleSummaryIndex() {
  assert(TheIndex);
  int NumSlots = Machine.initializeIndexIfNeeded();
 
  Out << "\n";
 
  // Print module path entries. To print in order, add paths to a vector
  // indexed by module slot.
  std::vector<std::pair<std::string, ModuleHash>> moduleVec;
  std::string RegularLTOModuleName =
      ModuleSummaryIndex::getRegularLTOModuleName();
  moduleVec.resize(TheIndex->modulePaths().size());
  for (auto &[ModPath, ModHash] : TheIndex->modulePaths())
    moduleVec[Machine.getModulePathSlot(ModPath)] = std::make_pair(
        // An empty module path is a special entry for a regular LTO module
        // created during the thin link.
        ModPath.empty() ? RegularLTOModuleName : std::string(ModPath), ModHash);
 
  unsigned i = 0;
  for (auto &ModPair : moduleVec) {
    Out << "^" << i++ << " = module: (";
    Out << "path: \"";
    printEscapedString(ModPair.first, Out);
    Out << "\", hash: (";
    ListSeparator FS;
    for (auto Hash : ModPair.second)
      Out << FS << Hash;
    Out << "))\n";
  }
 
  // FIXME: Change AliasSummary to hold a ValueInfo instead of summary pointer
  // for aliasee (then update BitcodeWriter.cpp and remove get/setAliaseeGUID).
  // Sort by GUID for deterministic output matching slot assignment order.
  auto SortedGVS = TheIndex->sortedGlobalValueSummariesRange();
 
  for (const auto &GlobalList : SortedGVS) {
    auto GUID = GlobalList.first;
    for (auto &Summary : GlobalList.second.getSummaryList())
      SummaryToGUIDMap[Summary.get()] = GUID;
  }
 
  // Print the global value summary entries.
  for (const auto &GlobalList : SortedGVS) {
    auto GUID = GlobalList.first;
    auto VI = TheIndex->getValueInfo(GlobalList);
    printSummaryInfo(Machine.getGUIDSlot(GUID), VI);
  }
 
  // Print the TypeIdMap entries.
  for (const auto &TID : TheIndex->typeIds()) {
    Out << "^" << Machine.getTypeIdSlot(TID.second.first)
        << " = typeid: (name: \"" << TID.second.first << "\"";
    printTypeIdSummary(TID.second.second);
    Out << ") ; guid = " << TID.first << "\n";
  }
 
  // Print the TypeIdCompatibleVtableMap entries.
  for (auto &TId : TheIndex->typeIdCompatibleVtableMap()) {
    auto GUID = GlobalValue::getGUIDAssumingExternalLinkage(TId.first);
    Out << "^" << Machine.getTypeIdCompatibleVtableSlot(TId.first)
        << " = typeidCompatibleVTable: (name: \"" << TId.first << "\"";
    printTypeIdCompatibleVtableSummary(TId.second);
    Out << ") ; guid = " << GUID << "\n";
  }
 
  // Don't emit flags when it's not really needed (value is zero by default).
  if (TheIndex->getFlags()) {
    Out << "^" << NumSlots << " = flags: " << TheIndex->getFlags() << "\n";
    ++NumSlots;
  }
 
  Out << "^" << NumSlots << " = blockcount: " << TheIndex->getBlockCount()
      << "\n";
}
 
static const char *
getWholeProgDevirtResKindName(WholeProgramDevirtResolution::Kind K) {
  switch (K) {
  case WholeProgramDevirtResolution::Indir:
    return "indir";
  case WholeProgramDevirtResolution::SingleImpl:
    return "singleImpl";
  case WholeProgramDevirtResolution::BranchFunnel:
    return "branchFunnel";
  }
  llvm_unreachable("invalid WholeProgramDevirtResolution kind");
}
 
static const char *getWholeProgDevirtResByArgKindName(
    WholeProgramDevirtResolution::ByArg::Kind K) {
  switch (K) {
  case WholeProgramDevirtResolution::ByArg::Indir:
    return "indir";
  case WholeProgramDevirtResolution::ByArg::UniformRetVal:
    return "uniformRetVal";
  case WholeProgramDevirtResolution::ByArg::UniqueRetVal:
    return "uniqueRetVal";
  case WholeProgramDevirtResolution::ByArg::VirtualConstProp:
    return "virtualConstProp";
  }
  llvm_unreachable("invalid WholeProgramDevirtResolution::ByArg kind");
}
 
static const char *getTTResKindName(TypeTestResolution::Kind K) {
  switch (K) {
  case TypeTestResolution::Unknown:
    return "unknown";
  case TypeTestResolution::Unsat:
    return "unsat";
  case TypeTestResolution::ByteArray:
    return "byteArray";
  case TypeTestResolution::Inline:
    return "inline";
  case TypeTestResolution::Single:
    return "single";
  case TypeTestResolution::AllOnes:
    return "allOnes";
  }
  llvm_unreachable("invalid TypeTestResolution kind");
}
 
void AssemblyWriter::printTypeTestResolution(const TypeTestResolution &TTRes) {
  Out << "typeTestRes: (kind: " << getTTResKindName(TTRes.TheKind)
      << ", sizeM1BitWidth: " << TTRes.SizeM1BitWidth;
 
  // The following fields are only used if the target does not support the use
  // of absolute symbols to store constants. Print only if non-zero.
  if (TTRes.AlignLog2)
    Out << ", alignLog2: " << TTRes.AlignLog2;
  if (TTRes.SizeM1)
    Out << ", sizeM1: " << TTRes.SizeM1;
  if (TTRes.BitMask)
    // BitMask is uint8_t which causes it to print the corresponding char.
    Out << ", bitMask: " << (unsigned)TTRes.BitMask;
  if (TTRes.InlineBits)
    Out << ", inlineBits: " << TTRes.InlineBits;
 
  Out << ")";
}
 
void AssemblyWriter::printTypeIdSummary(const TypeIdSummary &TIS) {
  Out << ", summary: (";
  printTypeTestResolution(TIS.TTRes);
  if (!TIS.WPDRes.empty()) {
    Out << ", wpdResolutions: (";
    ListSeparator FS;
    for (auto &WPDRes : TIS.WPDRes) {
      Out << FS;
      Out << "(offset: " << WPDRes.first << ", ";
      printWPDRes(WPDRes.second);
      Out << ")";
    }
    Out << ")";
  }
  Out << ")";
}
 
void AssemblyWriter::printTypeIdCompatibleVtableSummary(
    const TypeIdCompatibleVtableInfo &TI) {
  Out << ", summary: (";
  ListSeparator FS;
  for (auto &P : TI) {
    Out << FS;
    Out << "(offset: " << P.AddressPointOffset << ", ";
    Out << "^" << Machine.getGUIDSlot(P.VTableVI.getGUID());
    Out << ")";
  }
  Out << ")";
}
 
void AssemblyWriter::printArgs(ArrayRef<uint64_t> Args) {
  Out << "args: (" << llvm::interleaved(Args) << ')';
}
 
void AssemblyWriter::printWPDRes(const WholeProgramDevirtResolution &WPDRes) {
  Out << "wpdRes: (kind: ";
  Out << getWholeProgDevirtResKindName(WPDRes.TheKind);
 
  if (WPDRes.TheKind == WholeProgramDevirtResolution::SingleImpl)
    Out << ", singleImplName: \"" << WPDRes.SingleImplName << "\"";
 
  if (!WPDRes.ResByArg.empty()) {
    Out << ", resByArg: (";
    ListSeparator FS;
    for (auto &ResByArg : WPDRes.ResByArg) {
      Out << FS;
      printArgs(ResByArg.first);
      Out << ", byArg: (kind: ";
      Out << getWholeProgDevirtResByArgKindName(ResByArg.second.TheKind);
      if (ResByArg.second.TheKind ==
              WholeProgramDevirtResolution::ByArg::UniformRetVal ||
          ResByArg.second.TheKind ==
              WholeProgramDevirtResolution::ByArg::UniqueRetVal)
        Out << ", info: " << ResByArg.second.Info;
 
      // The following fields are only used if the target does not support the
      // use of absolute symbols to store constants. Print only if non-zero.
      if (ResByArg.second.Byte || ResByArg.second.Bit)
        Out << ", byte: " << ResByArg.second.Byte
            << ", bit: " << ResByArg.second.Bit;
 
      Out << ")";
    }
    Out << ")";
  }
  Out << ")";
}
 
static const char *getSummaryKindName(GlobalValueSummary::SummaryKind SK) {
  switch (SK) {
  case GlobalValueSummary::AliasKind:
    return "alias";
  case GlobalValueSummary::FunctionKind:
    return "function";
  case GlobalValueSummary::GlobalVarKind:
    return "variable";
  }
  llvm_unreachable("invalid summary kind");
}
 
void AssemblyWriter::printAliasSummary(const AliasSummary *AS) {
  Out << ", aliasee: ";
  // The indexes emitted for distributed backends may not include the
  // aliasee summary (only if it is being imported directly). Handle
  // that case by just emitting "null" as the aliasee.
  if (AS->hasAliasee())
    Out << "^" << Machine.getGUIDSlot(SummaryToGUIDMap[&AS->getAliasee()]);
  else
    Out << "null";
}
 
void AssemblyWriter::printGlobalVarSummary(const GlobalVarSummary *GS) {
  auto VTableFuncs = GS->vTableFuncs();
  Out << ", varFlags: (readonly: " << GS->VarFlags.MaybeReadOnly << ", "
      << "writeonly: " << GS->VarFlags.MaybeWriteOnly << ", "
      << "constant: " << GS->VarFlags.Constant;
  if (!VTableFuncs.empty())
    Out << ", "
        << "vcall_visibility: " << GS->VarFlags.VCallVisibility;
  Out << ")";
 
  if (!VTableFuncs.empty()) {
    Out << ", vTableFuncs: (";
    ListSeparator FS;
    for (auto &P : VTableFuncs) {
      Out << FS;
      Out << "(virtFunc: ^" << Machine.getGUIDSlot(P.FuncVI.getGUID())
          << ", offset: " << P.VTableOffset;
      Out << ")";
    }
    Out << ")";
  }
}
 
static std::string getLinkageName(GlobalValue::LinkageTypes LT) {
  switch (LT) {
  case GlobalValue::ExternalLinkage:
    return "external";
  case GlobalValue::PrivateLinkage:
    return "private";
  case GlobalValue::InternalLinkage:
    return "internal";
  case GlobalValue::LinkOnceAnyLinkage:
    return "linkonce";
  case GlobalValue::LinkOnceODRLinkage:
    return "linkonce_odr";
  case GlobalValue::WeakAnyLinkage:
    return "weak";
  case GlobalValue::WeakODRLinkage:
    return "weak_odr";
  case GlobalValue::CommonLinkage:
    return "common";
  case GlobalValue::AppendingLinkage:
    return "appending";
  case GlobalValue::ExternalWeakLinkage:
    return "extern_weak";
  case GlobalValue::AvailableExternallyLinkage:
    return "available_externally";
  }
  llvm_unreachable("invalid linkage");
}
 
// When printing the linkage types in IR where the ExternalLinkage is
// not printed, and other linkage types are expected to be printed with
// a space after the name.
static std::string getLinkageNameWithSpace(GlobalValue::LinkageTypes LT) {
  if (LT == GlobalValue::ExternalLinkage)
    return "";
  return getLinkageName(LT) + " ";
}
 
static const char *getVisibilityName(GlobalValue::VisibilityTypes Vis) {
  switch (Vis) {
  case GlobalValue::DefaultVisibility:
    return "default";
  case GlobalValue::HiddenVisibility:
    return "hidden";
  case GlobalValue::ProtectedVisibility:
    return "protected";
  }
  llvm_unreachable("invalid visibility");
}
 
static const char *getImportTypeName(GlobalValueSummary::ImportKind IK) {
  switch (IK) {
  case GlobalValueSummary::Definition:
    return "definition";
  case GlobalValueSummary::Declaration:
    return "declaration";
  }
  llvm_unreachable("invalid import kind");
}
 
void AssemblyWriter::printFunctionSummary(const FunctionSummary *FS) {
  Out << ", insts: " << FS->instCount();
  if (FS->fflags().anyFlagSet())
    Out << ", " << FS->fflags();
 
  if (!FS->calls().empty()) {
    Out << ", calls: (";
    ListSeparator IFS;
    for (auto &Call : FS->calls()) {
      Out << IFS;
      Out << "(callee: ^" << Machine.getGUIDSlot(Call.first.getGUID());
      if (Call.second.getHotness() != CalleeInfo::HotnessType::Unknown)
        Out << ", hotness: " << getHotnessName(Call.second.getHotness());
      // Follow the convention of emitting flags as a boolean value, but only
      // emit if true to avoid unnecessary verbosity and test churn.
      if (Call.second.HasTailCall)
        Out << ", tail: 1";
      Out << ")";
    }
    Out << ")";
  }
 
  if (const auto *TIdInfo = FS->getTypeIdInfo())
    printTypeIdInfo(*TIdInfo);
 
  // The AllocationType identifiers capture the profiled context behavior
  // reaching a specific static allocation site (possibly cloned).
  auto AllocTypeName = [](uint8_t Type) -> const char * {
    switch (Type) {
    case (uint8_t)AllocationType::None:
      return "none";
    case (uint8_t)AllocationType::NotCold:
      return "notcold";
    case (uint8_t)AllocationType::Cold:
      return "cold";
    case (uint8_t)AllocationType::Hot:
      return "hot";
    }
    llvm_unreachable("Unexpected alloc type");
  };
 
  if (!FS->allocs().empty()) {
    Out << ", allocs: (";
    ListSeparator AFS;
    for (auto &AI : FS->allocs()) {
      Out << AFS;
      Out << "(versions: (";
      ListSeparator VFS;
      for (auto V : AI.Versions) {
        Out << VFS;
        Out << AllocTypeName(V);
      }
      Out << "), memProf: (";
      ListSeparator MIBFS;
      for (auto &MIB : AI.MIBs) {
        Out << MIBFS;
        Out << "(type: " << AllocTypeName((uint8_t)MIB.AllocType);
        Out << ", stackIds: (";
        ListSeparator SIDFS;
        for (auto Id : MIB.StackIdIndices) {
          Out << SIDFS;
          Out << TheIndex->getStackIdAtIndex(Id);
        }
        Out << "))";
      }
      Out << "))";
    }
    Out << ")";
  }
 
  if (!FS->callsites().empty()) {
    Out << ", callsites: (";
    ListSeparator SNFS;
    for (auto &CI : FS->callsites()) {
      Out << SNFS;
      if (CI.Callee)
        Out << "(callee: ^" << Machine.getGUIDSlot(CI.Callee.getGUID());
      else
        Out << "(callee: null";
      Out << ", clones: (";
      ListSeparator VFS;
      for (auto V : CI.Clones) {
        Out << VFS;
        Out << V;
      }
      Out << "), stackIds: (";
      ListSeparator SIDFS;
      for (auto Id : CI.StackIdIndices) {
        Out << SIDFS;
        Out << TheIndex->getStackIdAtIndex(Id);
      }
      Out << "))";
    }
    Out << ")";
  }
 
  auto PrintRange = [&](const ConstantRange &Range) {
    Out << "[" << Range.getSignedMin() << ", " << Range.getSignedMax() << "]";
  };
 
  if (!FS->paramAccesses().empty()) {
    Out << ", params: (";
    ListSeparator IFS;
    for (auto &PS : FS->paramAccesses()) {
      Out << IFS;
      Out << "(param: " << PS.ParamNo;
      Out << ", offset: ";
      PrintRange(PS.Use);
      if (!PS.Calls.empty()) {
        Out << ", calls: (";
        ListSeparator IFS;
        for (auto &Call : PS.Calls) {
          Out << IFS;
          Out << "(callee: ^" << Machine.getGUIDSlot(Call.Callee.getGUID());
          Out << ", param: " << Call.ParamNo;
          Out << ", offset: ";
          PrintRange(Call.Offsets);
          Out << ")";
        }
        Out << ")";
      }
      Out << ")";
    }
    Out << ")";
  }
}
 
void AssemblyWriter::printTypeIdInfo(
    const FunctionSummary::TypeIdInfo &TIDInfo) {
  Out << ", typeIdInfo: (";
  ListSeparator TIDFS;
  if (!TIDInfo.TypeTests.empty()) {
    Out << TIDFS;
    Out << "typeTests: (";
    ListSeparator FS;
    for (auto &GUID : TIDInfo.TypeTests) {
      auto TidIter = TheIndex->typeIds().equal_range(GUID);
      if (TidIter.first == TidIter.second) {
        Out << FS;
        Out << GUID;
        continue;
      }
      // Print all type id that correspond to this GUID.
      for (const auto &[GUID, TypeIdPair] : make_range(TidIter)) {
        Out << FS;
        auto Slot = Machine.getTypeIdSlot(TypeIdPair.first);
        assert(Slot != -1);
        Out << "^" << Slot;
      }
    }
    Out << ")";
  }
  if (!TIDInfo.TypeTestAssumeVCalls.empty()) {
    Out << TIDFS;
    printNonConstVCalls(TIDInfo.TypeTestAssumeVCalls, "typeTestAssumeVCalls");
  }
  if (!TIDInfo.TypeCheckedLoadVCalls.empty()) {
    Out << TIDFS;
    printNonConstVCalls(TIDInfo.TypeCheckedLoadVCalls, "typeCheckedLoadVCalls");
  }
  if (!TIDInfo.TypeTestAssumeConstVCalls.empty()) {
    Out << TIDFS;
    printConstVCalls(TIDInfo.TypeTestAssumeConstVCalls,
                     "typeTestAssumeConstVCalls");
  }
  if (!TIDInfo.TypeCheckedLoadConstVCalls.empty()) {
    Out << TIDFS;
    printConstVCalls(TIDInfo.TypeCheckedLoadConstVCalls,
                     "typeCheckedLoadConstVCalls");
  }
  Out << ")";
}
 
void AssemblyWriter::printVFuncId(const FunctionSummary::VFuncId VFId) {
  auto TidIter = TheIndex->typeIds().equal_range(VFId.GUID);
  if (TidIter.first == TidIter.second) {
    Out << "vFuncId: (";
    Out << "guid: " << VFId.GUID;
    Out << ", offset: " << VFId.Offset;
    Out << ")";
    return;
  }
  // Print all type id that correspond to this GUID.
  ListSeparator FS;
  for (const auto &[GUID, TypeIdPair] : make_range(TidIter)) {
    Out << FS;
    Out << "vFuncId: (";
    auto Slot = Machine.getTypeIdSlot(TypeIdPair.first);
    assert(Slot != -1);
    Out << "^" << Slot;
    Out << ", offset: " << VFId.Offset;
    Out << ")";
  }
}
 
void AssemblyWriter::printNonConstVCalls(
    ArrayRef<FunctionSummary::VFuncId> VCallList, const char *Tag) {
  Out << Tag << ": (";
  ListSeparator FS;
  for (auto &VFuncId : VCallList) {
    Out << FS;
    printVFuncId(VFuncId);
  }
  Out << ")";
}
 
void AssemblyWriter::printConstVCalls(
    ArrayRef<FunctionSummary::ConstVCall> VCallList, const char *Tag) {
  Out << Tag << ": (";
  ListSeparator FS;
  for (auto &ConstVCall : VCallList) {
    Out << FS;
    Out << "(";
    printVFuncId(ConstVCall.VFunc);
    if (!ConstVCall.Args.empty()) {
      Out << ", ";
      printArgs(ConstVCall.Args);
    }
    Out << ")";
  }
  Out << ")";
}
 
void AssemblyWriter::printSummary(const GlobalValueSummary &Summary) {
  GlobalValueSummary::GVFlags GVFlags = Summary.flags();
  GlobalValue::LinkageTypes LT = (GlobalValue::LinkageTypes)GVFlags.Linkage;
  Out << getSummaryKindName(Summary.getSummaryKind()) << ": ";
  Out << "(module: ^" << Machine.getModulePathSlot(Summary.modulePath())
      << ", flags: (";
  Out << "linkage: " << getLinkageName(LT);
  Out << ", visibility: "
      << getVisibilityName((GlobalValue::VisibilityTypes)GVFlags.Visibility);
  Out << ", notEligibleToImport: " << GVFlags.NotEligibleToImport;
  Out << ", live: " << GVFlags.Live;
  Out << ", dsoLocal: " << GVFlags.DSOLocal;
  Out << ", canAutoHide: " << GVFlags.CanAutoHide;
  Out << ", importType: "
      << getImportTypeName(GlobalValueSummary::ImportKind(GVFlags.ImportType));
  Out << ", noRenameOnPromotion: " << GVFlags.NoRenameOnPromotion;
  Out << ")";
 
  if (Summary.getSummaryKind() == GlobalValueSummary::AliasKind)
    printAliasSummary(cast<AliasSummary>(&Summary));
  else if (Summary.getSummaryKind() == GlobalValueSummary::FunctionKind)
    printFunctionSummary(cast<FunctionSummary>(&Summary));
  else
    printGlobalVarSummary(cast<GlobalVarSummary>(&Summary));
 
  auto RefList = Summary.refs();
  if (!RefList.empty()) {
    Out << ", refs: (";
    ListSeparator FS;
    for (auto &Ref : RefList) {
      Out << FS;
      if (Ref.isReadOnly())
        Out << "readonly ";
      else if (Ref.isWriteOnly())
        Out << "writeonly ";
      Out << "^" << Machine.getGUIDSlot(Ref.getGUID());
    }
    Out << ")";
  }
 
  Out << ")";
}
 
void AssemblyWriter::printSummaryInfo(unsigned Slot, const ValueInfo &VI) {
  Out << "^" << Slot << " = gv: (";
  if (VI.hasName() && !VI.name().empty())
    Out << "name: \"" << VI.name() << "\"";
  else
    Out << "guid: " << VI.getGUID();
  if (!VI.getSummaryList().empty()) {
    Out << ", summaries: (";
    ListSeparator FS;
    for (auto &Summary : VI.getSummaryList()) {
      Out << FS;
      printSummary(*Summary);
    }
    Out << ")";
  }
  Out << ")";
  if (VI.hasName() && !VI.name().empty())
    Out << " ; guid = " << VI.getGUID();
  Out << "\n";
}
 
static void printMetadataIdentifier(StringRef Name,
                                    formatted_raw_ostream &Out) {
  if (Name.empty()) {
    Out << "<empty name> ";
  } else {
    unsigned char FirstC = static_cast<unsigned char>(Name[0]);
    if (isalpha(FirstC) || FirstC == '-' || FirstC == '$' || FirstC == '.' ||
        FirstC == '_')
      Out << FirstC;
    else
      Out << '\\' << hexdigit(FirstC >> 4) << hexdigit(FirstC & 0x0F);
    for (unsigned i = 1, e = Name.size(); i != e; ++i) {
      unsigned char C = Name[i];
      if (isalnum(C) || C == '-' || C == '$' || C == '.' || C == '_')
        Out << C;
      else
        Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
    }
  }
}
 
void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
  Out << '!';
  printMetadataIdentifier(NMD->getName(), Out);
  Out << " = !{";
  ListSeparator LS;
  for (const MDNode *Op : NMD->operands()) {
    Out << LS;
    // Write DIExpressions inline.
    // FIXME: Ban DIExpressions in NamedMDNodes, they will serve no purpose.
    if (auto *Expr = dyn_cast<DIExpression>(Op)) {
      writeDIExpression(Out, Expr, AsmWriterContext::getEmpty());
      continue;
    }
 
    int Slot = Machine.getMetadataSlot(Op);
    if (Slot == -1)
      Out << "<badref>";
    else
      Out << '!' << Slot;
  }
  Out << "}\n";
}
 
static void printVisibility(GlobalValue::VisibilityTypes Vis,
                            formatted_raw_ostream &Out) {
  switch (Vis) {
  case GlobalValue::DefaultVisibility: break;
  case GlobalValue::HiddenVisibility:    Out << "hidden "; break;
  case GlobalValue::ProtectedVisibility: Out << "protected "; break;
  }
}
 
static void printDSOLocation(const GlobalValue &GV,
                             formatted_raw_ostream &Out) {
  if (GV.isDSOLocal() && !GV.isImplicitDSOLocal())
    Out << "dso_local ";
}
 
static void printDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
                                 formatted_raw_ostream &Out) {
  switch (SCT) {
  case GlobalValue::DefaultStorageClass: break;
  case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
  case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
  }
}
 
static void printThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
                                  formatted_raw_ostream &Out) {
  switch (TLM) {
    case GlobalVariable::NotThreadLocal:
      break;
    case GlobalVariable::GeneralDynamicTLSModel:
      Out << "thread_local ";
      break;
    case GlobalVariable::LocalDynamicTLSModel:
      Out << "thread_local(localdynamic) ";
      break;
    case GlobalVariable::InitialExecTLSModel:
      Out << "thread_local(initialexec) ";
      break;
    case GlobalVariable::LocalExecTLSModel:
      Out << "thread_local(localexec) ";
      break;
  }
}
 
static StringRef getUnnamedAddrEncoding(GlobalVariable::UnnamedAddr UA) {
  switch (UA) {
  case GlobalVariable::UnnamedAddr::None:
    return "";
  case GlobalVariable::UnnamedAddr::Local:
    return "local_unnamed_addr";
  case GlobalVariable::UnnamedAddr::Global:
    return "unnamed_addr";
  }
  llvm_unreachable("Unknown UnnamedAddr");
}
 
static void maybePrintComdat(formatted_raw_ostream &Out,
                             const GlobalObject &GO) {
  const Comdat *C = GO.getComdat();
  if (!C)
    return;
 
  if (isa<GlobalVariable>(GO))
    Out << ',';
  Out << " comdat";
 
  if (GO.getName() == C->getName())
    return;
 
  Out << '(';
  printLLVMName(Out, C->getName(), ComdatPrefix);
  Out << ')';
}
 
void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
  if (GV->isMaterializable())
    Out << "; Materializable\n";
 
  AsmWriterContext WriterCtx(&TypePrinter, &Machine, GV->getParent());
  writeAsOperandInternal(Out, GV, WriterCtx);
  Out << " = ";
 
  if (!GV->hasInitializer() && GV->hasExternalLinkage())
    Out << "external ";
 
  Out << getLinkageNameWithSpace(GV->getLinkage());
  printDSOLocation(*GV, Out);
  printVisibility(GV->getVisibility(), Out);
  printDLLStorageClass(GV->getDLLStorageClass(), Out);
  printThreadLocalModel(GV->getThreadLocalMode(), Out);
  StringRef UA = getUnnamedAddrEncoding(GV->getUnnamedAddr());
  if (!UA.empty())
    Out << UA << ' ';
 
  printAddressSpace(GV->getParent(), GV->getType()->getAddressSpace(), Out,
                    /*Prefix=*/"", /*Suffix=*/" ");
  if (GV->isExternallyInitialized()) Out << "externally_initialized ";
  Out << (GV->isConstant() ? "constant " : "global ");
  TypePrinter.print(GV->getValueType(), Out);
 
  if (GV->hasInitializer()) {
    Out << ' ';
    writeOperand(GV->getInitializer(), false);
  }
 
  if (GV->hasSection()) {
    Out << ", section \"";
    printEscapedString(GV->getSection(), Out);
    Out << '"';
  }
  if (GV->hasPartition()) {
    Out << ", partition \"";
    printEscapedString(GV->getPartition(), Out);
    Out << '"';
  }
  if (auto CM = GV->getCodeModel()) {
    Out << ", code_model \"";
    switch (*CM) {
    case CodeModel::Tiny:
      Out << "tiny";
      break;
    case CodeModel::Small:
      Out << "small";
      break;
    case CodeModel::Kernel:
      Out << "kernel";
      break;
    case CodeModel::Medium:
      Out << "medium";
      break;
    case CodeModel::Large:
      Out << "large";
      break;
    }
    Out << '"';
  }
 
  using SanitizerMetadata = llvm::GlobalValue::SanitizerMetadata;
  if (GV->hasSanitizerMetadata()) {
    SanitizerMetadata MD = GV->getSanitizerMetadata();
    if (MD.NoAddress)
      Out << ", no_sanitize_address";
    if (MD.NoHWAddress)
      Out << ", no_sanitize_hwaddress";
    if (MD.Memtag)
      Out << ", sanitize_memtag";
    if (MD.IsDynInit)
      Out << ", sanitize_address_dyninit";
  }
 
  maybePrintComdat(Out, *GV);
  if (MaybeAlign A = GV->getAlign())
    Out << ", align " << A->value();
 
  SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
  GV->getAllMetadata(MDs);
  printMetadataAttachments(MDs, ", ");
 
  auto Attrs = GV->getAttributes();
  if (Attrs.hasAttributes())
    Out << " #" << Machine.getAttributeGroupSlot(Attrs);
 
  printInfoComment(*GV, GV->isMaterializable());
}
 
void AssemblyWriter::printAlias(const GlobalAlias *GA) {
  if (GA->isMaterializable())
    Out << "; Materializable\n";
 
  AsmWriterContext WriterCtx(&TypePrinter, &Machine, GA->getParent());
  writeAsOperandInternal(Out, GA, WriterCtx);
  Out << " = ";
 
  Out << getLinkageNameWithSpace(GA->getLinkage());
  printDSOLocation(*GA, Out);
  printVisibility(GA->getVisibility(), Out);
  printDLLStorageClass(GA->getDLLStorageClass(), Out);
  printThreadLocalModel(GA->getThreadLocalMode(), Out);
  StringRef UA = getUnnamedAddrEncoding(GA->getUnnamedAddr());
  if (!UA.empty())
      Out << UA << ' ';
 
  Out << "alias ";
 
  TypePrinter.print(GA->getValueType(), Out);
  Out << ", ";
 
  if (const Constant *Aliasee = GA->getAliasee()) {
    writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
  } else {
    TypePrinter.print(GA->getType(), Out);
    Out << " <<NULL ALIASEE>>";
  }
 
  if (GA->hasPartition()) {
    Out << ", partition \"";
    printEscapedString(GA->getPartition(), Out);
    Out << '"';
  }
 
  printInfoComment(*GA, GA->isMaterializable());
  Out << '\n';
}
 
void AssemblyWriter::printIFunc(const GlobalIFunc *GI) {
  if (GI->isMaterializable())
    Out << "; Materializable\n";
 
  AsmWriterContext WriterCtx(&TypePrinter, &Machine, GI->getParent());
  writeAsOperandInternal(Out, GI, WriterCtx);
  Out << " = ";
 
  Out << getLinkageNameWithSpace(GI->getLinkage());
  printDSOLocation(*GI, Out);
  printVisibility(GI->getVisibility(), Out);
 
  Out << "ifunc ";
 
  TypePrinter.print(GI->getValueType(), Out);
  Out << ", ";
 
  if (const Constant *Resolver = GI->getResolver()) {
    writeOperand(Resolver, !isa<ConstantExpr>(Resolver));
  } else {
    TypePrinter.print(GI->getType(), Out);
    Out << " <<NULL RESOLVER>>";
  }
 
  if (GI->hasPartition()) {
    Out << ", partition \"";
    printEscapedString(GI->getPartition(), Out);
    Out << '"';
  }
  SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
  GI->getAllMetadata(MDs);
  if (!MDs.empty()) {
    printMetadataAttachments(MDs, ", ");
  }
 
  printInfoComment(*GI, GI->isMaterializable());
  Out << '\n';
}
 
void AssemblyWriter::printComdat(const Comdat *C) {
  C->print(Out);
}
 
void AssemblyWriter::printTypeIdentities() {
  if (TypePrinter.empty())
    return;
 
  Out << '\n';
 
  // Emit all numbered types.
  auto &NumberedTypes = TypePrinter.getNumberedTypes();
  for (unsigned I = 0, E = NumberedTypes.size(); I != E; ++I) {
    Out << '%' << I << " = type ";
 
    // Make sure we print out at least one level of the type structure, so
    // that we do not get %2 = type %2
    TypePrinter.printStructBody(NumberedTypes[I], Out);
    Out << '\n';
  }
 
  auto &NamedTypes = TypePrinter.getNamedTypes();
  for (StructType *NamedType : NamedTypes) {
    printLLVMName(Out, NamedType->getName(), LocalPrefix);
    Out << " = type ";
 
    // Make sure we print out at least one level of the type structure, so
    // that we do not get %FILE = type %FILE
    TypePrinter.printStructBody(NamedType, Out);
    Out << '\n';
  }
}
 
/// printFunction - Print all aspects of a function.
void AssemblyWriter::printFunction(const Function *F) {
  if (F->isMaterializable())
    Out << "; Materializable\n";
  else if (AnnotationWriter)
    AnnotationWriter->emitFunctionAnnot(F, Out);
 
  const AttributeList &Attrs = F->getAttributes();
  if (Attrs.hasFnAttrs()) {
    AttributeSet AS = Attrs.getFnAttrs();
    std::string AttrStr;
 
    for (const Attribute &Attr : AS) {
      if (!Attr.isStringAttribute()) {
        if (!AttrStr.empty()) AttrStr += ' ';
        AttrStr += Attr.getAsString();
      }
    }
 
    if (!AttrStr.empty())
      Out << "; Function Attrs: " << AttrStr << '\n';
  }
 
  if (F->isIntrinsic() && F->getIntrinsicID() == Intrinsic::not_intrinsic)
    Out << "; Unknown intrinsic\n";
 
  Machine.incorporateFunction(F);
 
  if (F->isDeclaration()) {
    Out << "declare";
    SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
    F->getAllMetadata(MDs);
    printMetadataAttachments(MDs, " ");
    Out << ' ';
  } else
    Out << "define ";
 
  Out << getLinkageNameWithSpace(F->getLinkage());
  printDSOLocation(*F, Out);
  printVisibility(F->getVisibility(), Out);
  printDLLStorageClass(F->getDLLStorageClass(), Out);
 
  // Print the calling convention.
  if (F->getCallingConv() != CallingConv::C) {
    printCallingConv(F->getCallingConv(), Out);
    Out << " ";
  }
 
  FunctionType *FT = F->getFunctionType();
  if (Attrs.hasRetAttrs())
    Out << Attrs.getAsString(AttributeList::ReturnIndex) << ' ';
  TypePrinter.print(F->getReturnType(), Out);
  AsmWriterContext WriterCtx(&TypePrinter, &Machine, F->getParent());
  Out << ' ';
  writeAsOperandInternal(Out, F, WriterCtx);
  Out << '(';
 
  // Loop over the arguments, printing them...
  if (F->isDeclaration() && !IsForDebug) {
    // We're only interested in the type here - don't print argument names.
    ListSeparator LS;
    for (unsigned I = 0, E = FT->getNumParams(); I != E; ++I) {
      Out << LS;
      // Output type.
      TypePrinter.print(FT->getParamType(I), Out);
 
      AttributeSet ArgAttrs = Attrs.getParamAttrs(I);
      if (ArgAttrs.hasAttributes()) {
        Out << ' ';
        writeAttributeSet(ArgAttrs);
      }
    }
  } else {
    // The arguments are meaningful here, print them in detail.
    ListSeparator LS;
    for (const Argument &Arg : F->args()) {
      Out << LS;
      printArgument(&Arg, Attrs.getParamAttrs(Arg.getArgNo()));
    }
  }
 
  // Finish printing arguments...
  if (FT->isVarArg()) {
    if (FT->getNumParams()) Out << ", ";
    Out << "...";  // Output varargs portion of signature!
  }
  Out << ')';
  StringRef UA = getUnnamedAddrEncoding(F->getUnnamedAddr());
  if (!UA.empty())
    Out << ' ' << UA;
  // We print the function address space if it is non-zero or if we are writing
  // a module with a non-zero program address space or if there is no valid
  // Module* so that the file can be parsed without the datalayout string.
  const Module *Mod = F->getParent();
  bool ForcePrintAddressSpace =
      !Mod || Mod->getDataLayout().getProgramAddressSpace() != 0;
  printAddressSpace(Mod, F->getAddressSpace(), Out, /*Prefix=*/" ",
                    /*Suffix=*/"", ForcePrintAddressSpace);
  if (Attrs.hasFnAttrs())
    Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttrs());
  if (F->hasSection()) {
    Out << " section \"";
    printEscapedString(F->getSection(), Out);
    Out << '"';
  }
  if (F->hasPartition()) {
    Out << " partition \"";
    printEscapedString(F->getPartition(), Out);
    Out << '"';
  }
  maybePrintComdat(Out, *F);
  if (MaybeAlign A = F->getAlign())
    Out << " align " << A->value();
  if (MaybeAlign A = F->getPreferredAlignment())
    Out << " prefalign(" << A->value() << ')';
  if (F->hasGC())
    Out << " gc \"" << F->getGC() << '"';
  if (F->hasPrefixData()) {
    Out << " prefix ";
    writeOperand(F->getPrefixData(), true);
  }
  if (F->hasPrologueData()) {
    Out << " prologue ";
    writeOperand(F->getPrologueData(), true);
  }
  if (F->hasPersonalityFn()) {
    Out << " personality ";
    writeOperand(F->getPersonalityFn(), /*PrintType=*/true);
  }
 
  if (PrintProfData) {
    if (auto *MDProf = F->getMetadata(LLVMContext::MD_prof)) {
      Out << " ";
      MDProf->print(Out, TheModule, /*IsForDebug=*/true);
    }
  }
 
  if (F->isDeclaration()) {
    Out << '\n';
  } else {
    SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
    F->getAllMetadata(MDs);
    printMetadataAttachments(MDs, " ");
 
    Out << " {";
    // Output all of the function's basic blocks.
    for (const BasicBlock &BB : *F)
      printBasicBlock(&BB);
 
    // Output the function's use-lists.
    printUseLists(F);
 
    Out << "}\n";
  }
 
  Machine.purgeFunction();
}
 
/// printArgument - This member is called for every argument that is passed into
/// the function.  Simply print it out
void AssemblyWriter::printArgument(const Argument *Arg, AttributeSet Attrs) {
  // Output type...
  TypePrinter.print(Arg->getType(), Out);
 
  // Output parameter attributes list
  if (Attrs.hasAttributes()) {
    Out << ' ';
    writeAttributeSet(Attrs);
  }
 
  // Output name, if available...
  if (Arg->hasName()) {
    Out << ' ';
    printLLVMName(Out, Arg);
  } else {
    int Slot = Machine.getLocalSlot(Arg);
    assert(Slot != -1 && "expect argument in function here");
    Out << " %" << Slot;
  }
}
 
/// printBasicBlock - This member is called for each basic block in a method.
void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
  bool IsEntryBlock = BB->getParent() && BB->isEntryBlock();
  if (BB->hasName()) {              // Print out the label if it exists...
    Out << "\n";
    printLLVMName(Out, BB->getName(), LabelPrefix);
    Out << ':';
  } else if (!IsEntryBlock) {
    Out << "\n";
    int Slot = Machine.getLocalSlot(BB);
    if (Slot != -1)
      Out << Slot << ":";
    else
      Out << "<badref>:";
  }
 
  if (!IsEntryBlock) {
    // Output predecessors for the block.
    Out.PadToColumn(50);
    Out << ";";
    if (pred_empty(BB)) {
      Out << " No predecessors!";
    } else {
      Out << " preds = ";
      ListSeparator LS;
      for (const BasicBlock *Pred : predecessors(BB)) {
        Out << LS;
        writeOperand(Pred, false);
      }
    }
  }
 
  Out << "\n";
 
  if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
 
  // Output all of the instructions in the basic block...
  for (const Instruction &I : *BB) {
    for (const DbgRecord &DR : I.getDbgRecordRange())
      printDbgRecordLine(DR);
    printInstructionLine(I);
  }
 
  if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
}
 
/// printInstructionLine - Print an instruction and a newline character.
void AssemblyWriter::printInstructionLine(const Instruction &I) {
  printInstruction(I);
  Out << '\n';
}
 
/// printGCRelocateComment - print comment after call to the gc.relocate
/// intrinsic indicating base and derived pointer names.
void AssemblyWriter::printGCRelocateComment(const GCRelocateInst &Relocate) {
  Out << " ; (";
  if (Value *BasePtr = Relocate.getBasePtr())
    writeOperand(BasePtr, false);
  else
    Out << "invalid";
  Out << ", ";
  if (Value *DerivedPtr = Relocate.getDerivedPtr())
    writeOperand(DerivedPtr, false);
  else
    Out << "invalid";
  Out << ")";
}
 
/// printInfoComment - Print a little comment after the instruction indicating
/// which slot it occupies.
void AssemblyWriter::printInfoComment(const Value &V, bool isMaterializable) {
  if (const auto *Relocate = dyn_cast<GCRelocateInst>(&V))
    printGCRelocateComment(*Relocate);
 
  if (AnnotationWriter && !isMaterializable)
    AnnotationWriter->printInfoComment(V, Out);
 
  if (PrintInstDebugLocs) {
    if (auto *I = dyn_cast<Instruction>(&V)) {
      if (I->getDebugLoc()) {
        Out << " ; ";
        I->getDebugLoc().print(Out);
      }
    }
  }
  if (PrintProfData) {
    if (auto *I = dyn_cast<Instruction>(&V)) {
      if (auto *MD = I->getMetadata(LLVMContext::MD_prof)) {
        Out << " ; ";
        MD->print(Out, TheModule, /*IsForDebug=*/true);
      }
    }
  }
 
  if (PrintInstAddrs)
    Out << " ; " << &V;
}
 
static void maybePrintCallAddrSpace(const Value *Operand, const Instruction *I,
                                    raw_ostream &Out) {
  if (Operand == nullptr) {
    Out << " <cannot get addrspace!>";
    return;
  }
 
  // We print the address space of the call if it is non-zero.
  // We also print it if it is zero but not equal to the program address space
  // or if we can't find a valid Module* to make it possible to parse
  // the resulting file even without a datalayout string.
  unsigned CallAddrSpace = Operand->getType()->getPointerAddressSpace();
  const Module *Mod = getModuleFromVal(I);
  bool ForcePrintAddrSpace =
      !Mod || Mod->getDataLayout().getProgramAddressSpace() != 0;
  printAddressSpace(Mod, CallAddrSpace, Out, /*Prefix=*/" ", /*Suffix=*/"",
                    ForcePrintAddrSpace);
}
 
// This member is called for each Instruction in a function..
void AssemblyWriter::printInstruction(const Instruction &I) {
  if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
 
  // Print out indentation for an instruction.
  Out << "  ";
 
  // Print out name if it exists...
  if (I.hasName()) {
    printLLVMName(Out, &I);
    Out << " = ";
  } else if (!I.getType()->isVoidTy()) {
    // Print out the def slot taken.
    int SlotNum = Machine.getLocalSlot(&I);
    if (SlotNum == -1)
      Out << "<badref> = ";
    else
      Out << '%' << SlotNum << " = ";
  }
 
  if (const auto *CI = dyn_cast<CallInst>(&I)) {
    if (CI->isMustTailCall())
      Out << "musttail ";
    else if (CI->isTailCall())
      Out << "tail ";
    else if (CI->isNoTailCall())
      Out << "notail ";
  }
 
  // Print out the opcode...
  Out << I.getOpcodeName();
 
  // If this is an atomic load or store, print out the atomic marker.
  if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isAtomic()) ||
      (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
    Out << " atomic";
 
  if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
    Out << " weak";
 
  // If this is a volatile operation, print out the volatile marker.
  if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
      (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
      (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
      (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
    Out << " volatile";
 
  // Print the elementwise marker for atomic loads and stores.
  if ((isa<LoadInst>(I) && cast<LoadInst>(I).isElementwise()) ||
      (isa<StoreInst>(I) && cast<StoreInst>(I).isElementwise()))
    Out << " elementwise";
 
  // Print out optimization information.
  writeOptimizationInfo(Out, &I);
 
  // Print out the compare instruction predicates
  if (const auto *CI = dyn_cast<CmpInst>(&I))
    Out << ' ' << CI->getPredicate();
 
  // Print out the atomicrmw operation
  if (const auto *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
    if (RMWI->isElementwise())
      Out << " elementwise";
    Out << ' ' << AtomicRMWInst::getOperationName(RMWI->getOperation());
  }
 
  // Print out the type of the operands...
  const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
 
  // Special case conditional branches to swizzle the condition out to the front
  if (const auto *BI = dyn_cast<CondBrInst>(&I)) {
    Out << ' ';
    writeOperand(BI->getCondition(), true);
    Out << ", ";
    writeOperand(BI->getSuccessor(0), true);
    Out << ", ";
    writeOperand(BI->getSuccessor(1), true);
  } else if (isa<SwitchInst>(I)) {
    const SwitchInst& SI(cast<SwitchInst>(I));
    // Special case switch instruction to get formatting nice and correct.
    Out << ' ';
    writeOperand(SI.getCondition(), true);
    Out << ", ";
    writeOperand(SI.getDefaultDest(), true);
    Out << " [";
    for (auto Case : SI.cases()) {
      Out << "\n    ";
      writeOperand(Case.getCaseValue(), true);
      Out << ", ";
      writeOperand(Case.getCaseSuccessor(), true);
    }
    Out << "\n  ]";
  } else if (isa<IndirectBrInst>(I)) {
    // Special case indirectbr instruction to get formatting nice and correct.
    Out << ' ';
    writeOperand(Operand, true);
    Out << ", [";
 
    ListSeparator LS;
    for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
      Out << LS;
      writeOperand(I.getOperand(i), true);
    }
    Out << ']';
  } else if (const auto *PN = dyn_cast<PHINode>(&I)) {
    Out << ' ';
    TypePrinter.print(I.getType(), Out);
    Out << ' ';
 
    ListSeparator LS;
    for (const auto &[V, Block] :
         zip_equal(PN->incoming_values(), PN->blocks())) {
      Out << LS << "[ ";
      writeOperand(V, false);
      Out << ", ";
      writeOperand(Block, false);
      Out << " ]";
    }
  } else if (const auto *EVI = dyn_cast<ExtractValueInst>(&I)) {
    Out << ' ';
    writeOperand(I.getOperand(0), true);
    Out << ", ";
    Out << llvm::interleaved(EVI->indices());
  } else if (const auto *IVI = dyn_cast<InsertValueInst>(&I)) {
    Out << ' ';
    writeOperand(I.getOperand(0), true); Out << ", ";
    writeOperand(I.getOperand(1), true);
    Out << ", ";
    Out << llvm::interleaved(IVI->indices());
  } else if (const auto *LPI = dyn_cast<LandingPadInst>(&I)) {
    Out << ' ';
    TypePrinter.print(I.getType(), Out);
    if (LPI->isCleanup() || LPI->getNumClauses() != 0)
      Out << '\n';
 
    if (LPI->isCleanup())
      Out << "          cleanup";
 
    for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
      if (i != 0 || LPI->isCleanup()) Out << "\n";
      if (LPI->isCatch(i))
        Out << "          catch ";
      else
        Out << "          filter ";
 
      writeOperand(LPI->getClause(i), true);
    }
  } else if (const auto *CatchSwitch = dyn_cast<CatchSwitchInst>(&I)) {
    Out << " within ";
    writeOperand(CatchSwitch->getParentPad(), /*PrintType=*/false);
    Out << " [";
    ListSeparator LS;
    for (const BasicBlock *PadBB : CatchSwitch->handlers()) {
      Out << LS;
      writeOperand(PadBB, /*PrintType=*/true);
    }
    Out << "] unwind ";
    if (const BasicBlock *UnwindDest = CatchSwitch->getUnwindDest())
      writeOperand(UnwindDest, /*PrintType=*/true);
    else
      Out << "to caller";
  } else if (const auto *FPI = dyn_cast<FuncletPadInst>(&I)) {
    Out << " within ";
    writeOperand(FPI->getParentPad(), /*PrintType=*/false);
    Out << " [";
    ListSeparator LS;
    for (const Value *Op : FPI->arg_operands()) {
      Out << LS;
      writeOperand(Op, /*PrintType=*/true);
    }
    Out << ']';
  } else if (isa<ReturnInst>(I) && !Operand) {
    Out << " void";
  } else if (const auto *CRI = dyn_cast<CatchReturnInst>(&I)) {
    Out << " from ";
    writeOperand(CRI->getOperand(0), /*PrintType=*/false);
 
    Out << " to ";
    writeOperand(CRI->getOperand(1), /*PrintType=*/true);
  } else if (const auto *CRI = dyn_cast<CleanupReturnInst>(&I)) {
    Out << " from ";
    writeOperand(CRI->getOperand(0), /*PrintType=*/false);
 
    Out << " unwind ";
    if (CRI->hasUnwindDest())
      writeOperand(CRI->getOperand(1), /*PrintType=*/true);
    else
      Out << "to caller";
  } else if (const auto *CI = dyn_cast<CallInst>(&I)) {
    // Print the calling convention being used.
    if (CI->getCallingConv() != CallingConv::C) {
      Out << " ";
      printCallingConv(CI->getCallingConv(), Out);
    }
 
    Operand = CI->getCalledOperand();
    FunctionType *FTy = CI->getFunctionType();
    Type *RetTy = FTy->getReturnType();
    const AttributeList &PAL = CI->getAttributes();
 
    if (PAL.hasRetAttrs())
      Out << ' ' << PAL.getAsString(AttributeList::ReturnIndex);
 
    // Only print addrspace(N) if necessary:
    maybePrintCallAddrSpace(Operand, &I, Out);
 
    // If possible, print out the short form of the call instruction.  We can
    // only do this if the first argument is a pointer to a nonvararg function,
    // and if the return type is not a pointer to a function.
    Out << ' ';
    TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
    Out << ' ';
    writeOperand(Operand, false);
    Out << '(';
    bool HasPrettyPrintedArgs =
        isa<IntrinsicInst>(CI) &&
        Intrinsic::hasPrettyPrintedArgs(CI->getIntrinsicID());
 
    ListSeparator LS;
    Function *CalledFunc = CI->getCalledFunction();
    auto PrintArgComment = [&](unsigned ArgNo) {
      const auto *ConstArg = dyn_cast<Constant>(CI->getArgOperand(ArgNo));
      if (!ConstArg || !CalledFunc)
        return;
      std::string ArgComment;
      raw_string_ostream ArgCommentStream(ArgComment);
      Intrinsic::ID IID = CalledFunc->getIntrinsicID();
      Intrinsic::printImmArg(IID, ArgNo, ArgCommentStream, ConstArg);
      if (ArgComment.empty())
        return;
      Out << "/* " << ArgComment << " */ ";
    };
    if (HasPrettyPrintedArgs) {
      for (unsigned ArgNo = 0, NumArgs = CI->arg_size(); ArgNo < NumArgs;
           ++ArgNo) {
        Out << LS;
        PrintArgComment(ArgNo);
        writeParamOperand(CI->getArgOperand(ArgNo), PAL.getParamAttrs(ArgNo));
      }
    } else {
      for (unsigned ArgNo = 0, NumArgs = CI->arg_size(); ArgNo < NumArgs;
           ++ArgNo) {
        Out << LS;
        writeParamOperand(CI->getArgOperand(ArgNo), PAL.getParamAttrs(ArgNo));
      }
    }
    // Emit an ellipsis if this is a musttail call in a vararg function.  This
    // is only to aid readability, musttail calls forward varargs by default.
    if (CI->isMustTailCall() && CI->getParent() &&
        CI->getParent()->getParent() &&
        CI->getParent()->getParent()->isVarArg()) {
      if (CI->arg_size() > 0)
        Out << ", ";
      Out << "...";
    }
 
    Out << ')';
    if (PAL.hasFnAttrs())
      Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttrs());
 
    writeOperandBundles(CI);
  } else if (const auto *II = dyn_cast<InvokeInst>(&I)) {
    Operand = II->getCalledOperand();
    FunctionType *FTy = II->getFunctionType();
    Type *RetTy = FTy->getReturnType();
    const AttributeList &PAL = II->getAttributes();
 
    // Print the calling convention being used.
    if (II->getCallingConv() != CallingConv::C) {
      Out << " ";
      printCallingConv(II->getCallingConv(), Out);
    }
 
    if (PAL.hasRetAttrs())
      Out << ' ' << PAL.getAsString(AttributeList::ReturnIndex);
 
    // Only print addrspace(N) if necessary:
    maybePrintCallAddrSpace(Operand, &I, Out);
 
    // If possible, print out the short form of the invoke instruction. We can
    // only do this if the first argument is a pointer to a nonvararg function,
    // and if the return type is not a pointer to a function.
    //
    Out << ' ';
    TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
    Out << ' ';
    writeOperand(Operand, false);
    Out << '(';
    ListSeparator LS;
    for (unsigned op = 0, Eop = II->arg_size(); op < Eop; ++op) {
      Out << LS;
      writeParamOperand(II->getArgOperand(op), PAL.getParamAttrs(op));
    }
 
    Out << ')';
    if (PAL.hasFnAttrs())
      Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttrs());
 
    writeOperandBundles(II);
 
    Out << "\n          to ";
    writeOperand(II->getNormalDest(), true);
    Out << " unwind ";
    writeOperand(II->getUnwindDest(), true);
  } else if (const auto *CBI = dyn_cast<CallBrInst>(&I)) {
    Operand = CBI->getCalledOperand();
    FunctionType *FTy = CBI->getFunctionType();
    Type *RetTy = FTy->getReturnType();
    const AttributeList &PAL = CBI->getAttributes();
 
    // Print the calling convention being used.
    if (CBI->getCallingConv() != CallingConv::C) {
      Out << " ";
      printCallingConv(CBI->getCallingConv(), Out);
    }
 
    if (PAL.hasRetAttrs())
      Out << ' ' << PAL.getAsString(AttributeList::ReturnIndex);
 
    // If possible, print out the short form of the callbr instruction. We can
    // only do this if the first argument is a pointer to a nonvararg function,
    // and if the return type is not a pointer to a function.
    //
    Out << ' ';
    TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
    Out << ' ';
    writeOperand(Operand, false);
    Out << '(';
    ListSeparator ArgLS;
    for (unsigned op = 0, Eop = CBI->arg_size(); op < Eop; ++op) {
      Out << ArgLS;
      writeParamOperand(CBI->getArgOperand(op), PAL.getParamAttrs(op));
    }
 
    Out << ')';
    if (PAL.hasFnAttrs())
      Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttrs());
 
    writeOperandBundles(CBI);
 
    Out << "\n          to ";
    writeOperand(CBI->getDefaultDest(), true);
    Out << " [";
    ListSeparator DestLS;
    for (const BasicBlock *Dest : CBI->getIndirectDests()) {
      Out << DestLS;
      writeOperand(Dest, true);
    }
    Out << ']';
  } else if (const auto *AI = dyn_cast<AllocaInst>(&I)) {
    Out << ' ';
    if (AI->isUsedWithInAlloca())
      Out << "inalloca ";
    if (AI->isSwiftError())
      Out << "swifterror ";
    TypePrinter.print(AI->getAllocatedType(), Out);
 
    // Explicitly write the array size if the code is broken, if it's an array
    // allocation, or if the type is not canonical for scalar allocations.  The
    // latter case prevents the type from mutating when round-tripping through
    // assembly.
    if (!AI->getArraySize() || AI->isArrayAllocation() ||
        !AI->getArraySize()->getType()->isIntegerTy(32)) {
      Out << ", ";
      writeOperand(AI->getArraySize(), true);
    }
    if (MaybeAlign A = AI->getAlign()) {
      Out << ", align " << A->value();
    }
 
    printAddressSpace(AI->getModule(), AI->getAddressSpace(), Out,
                      /*Prefix=*/", ");
  } else if (isa<CastInst>(I)) {
    if (Operand) {
      Out << ' ';
      writeOperand(Operand, true);   // Work with broken code
    }
    Out << " to ";
    TypePrinter.print(I.getType(), Out);
  } else if (isa<VAArgInst>(I)) {
    if (Operand) {
      Out << ' ';
      writeOperand(Operand, true);   // Work with broken code
    }
    Out << ", ";
    TypePrinter.print(I.getType(), Out);
  } else if (Operand) { // Print the normal way.
    if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
      Out << ' ';
      TypePrinter.print(GEP->getSourceElementType(), Out);
      Out << ',';
    } else if (isa<BitExtractInst>(I) || isa<LoadInst>(I)) {
      Out << ' ';
      TypePrinter.print(I.getType(), Out);
      Out << ',';
    }
 
    // PrintAllTypes - Instructions who have operands of all the same type
    // omit the type from all but the first operand.  If the instruction has
    // different type operands (for example br), then they are all printed.
    bool PrintAllTypes = false;
    Type *TheType = Operand->getType();
 
    // Select, Store, ShuffleVector, CmpXchg and AtomicRMW always print all
    // types.
    if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I) ||
        isa<ReturnInst>(I) || isa<AtomicCmpXchgInst>(I) ||
        isa<AtomicRMWInst>(I)) {
      PrintAllTypes = true;
    } else {
      for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
        Operand = I.getOperand(i);
        // note that Operand shouldn't be null, but the test helps make dump()
        // more tolerant of malformed IR
        if (Operand && Operand->getType() != TheType) {
          PrintAllTypes = true;    // We have differing types!  Print them all!
          break;
        }
      }
    }
 
    if (!PrintAllTypes) {
      Out << ' ';
      TypePrinter.print(TheType, Out);
    }
 
    Out << ' ';
    ListSeparator LS;
    for (const Value *Op : I.operands()) {
      Out << LS;
      writeOperand(Op, PrintAllTypes);
    }
  }
 
  // Print atomic ordering/alignment for memory operations
  if (const auto *LI = dyn_cast<LoadInst>(&I)) {
    if (LI->isAtomic())
      writeAtomic(LI->getContext(), LI->getOrdering(), LI->getSyncScopeID());
    if (MaybeAlign A = LI->getAlign())
      Out << ", align " << A->value();
  } else if (const auto *SI = dyn_cast<StoreInst>(&I)) {
    if (SI->isAtomic())
      writeAtomic(SI->getContext(), SI->getOrdering(), SI->getSyncScopeID());
    if (MaybeAlign A = SI->getAlign())
      Out << ", align " << A->value();
  } else if (const auto *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
    writeAtomicCmpXchg(CXI->getContext(), CXI->getSuccessOrdering(),
                       CXI->getFailureOrdering(), CXI->getSyncScopeID());
    Out << ", align " << CXI->getAlign().value();
  } else if (const auto *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
    writeAtomic(RMWI->getContext(), RMWI->getOrdering(),
                RMWI->getSyncScopeID());
    Out << ", align " << RMWI->getAlign().value();
  } else if (const auto *FI = dyn_cast<FenceInst>(&I)) {
    writeAtomic(FI->getContext(), FI->getOrdering(), FI->getSyncScopeID());
  } else if (const auto *SVI = dyn_cast<ShuffleVectorInst>(&I)) {
    printShuffleMask(Out, SVI->getType(), SVI->getShuffleMask());
  }
 
  // Print Metadata info.
  SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
  I.getAllMetadata(InstMD);
  printMetadataAttachments(InstMD, ", ");
 
  // Print a nice comment.
  printInfoComment(I);
}
 
void AssemblyWriter::printDbgMarker(const DbgMarker &Marker) {
  // There's no formal representation of a DbgMarker -- print purely as a
  // debugging aid.
  for (const DbgRecord &DPR : Marker.StoredDbgRecords) {
    printDbgRecord(DPR);
    Out << "\n";
  }
 
  Out << "  DbgMarker -> { ";
  printInstruction(*Marker.MarkedInstr);
  Out << " }";
}
 
void AssemblyWriter::printDbgRecord(const DbgRecord &DR) {
  if (auto *DVR = dyn_cast<DbgVariableRecord>(&DR))
    printDbgVariableRecord(*DVR);
  else if (auto *DLR = dyn_cast<DbgLabelRecord>(&DR))
    printDbgLabelRecord(*DLR);
  else
    llvm_unreachable("Unexpected DbgRecord kind");
}
 
void AssemblyWriter::printDbgVariableRecord(const DbgVariableRecord &DVR) {
  auto WriterCtx = getContext();
  Out << "#dbg_";
  switch (DVR.getType()) {
  case DbgVariableRecord::LocationType::Value:
    Out << "value";
    break;
  case DbgVariableRecord::LocationType::Declare:
    Out << "declare";
    break;
  case DbgVariableRecord::LocationType::DeclareValue:
    Out << "declare_value";
    break;
  case DbgVariableRecord::LocationType::Assign:
    Out << "assign";
    break;
  default:
    llvm_unreachable(
        "Tried to print a DbgVariableRecord with an invalid LocationType!");
  }
 
  auto PrintOrNull = [&](Metadata *M) {
    if (!M)
      Out << "(null)";
    else
      writeAsOperandInternal(Out, M, WriterCtx, true);
  };
 
  Out << "(";
  PrintOrNull(DVR.getRawLocation());
  Out << ", ";
  PrintOrNull(DVR.getRawVariable());
  Out << ", ";
  PrintOrNull(DVR.getRawExpression());
  Out << ", ";
  if (DVR.isDbgAssign()) {
    PrintOrNull(DVR.getRawAssignID());
    Out << ", ";
    PrintOrNull(DVR.getRawAddress());
    Out << ", ";
    PrintOrNull(DVR.getRawAddressExpression());
    Out << ", ";
  }
  PrintOrNull(DVR.getDebugLoc().getAsMDNode());
  Out << ")";
}
 
/// printDbgRecordLine - Print a DbgRecord with indentation and a newline
/// character.
void AssemblyWriter::printDbgRecordLine(const DbgRecord &DR) {
  // Print lengthier indentation to bring out-of-line with instructions.
  Out << "    ";
  printDbgRecord(DR);
  Out << '\n';
}
 
void AssemblyWriter::printDbgLabelRecord(const DbgLabelRecord &Label) {
  auto WriterCtx = getContext();
  Out << "#dbg_label(";
  writeAsOperandInternal(Out, Label.getRawLabel(), WriterCtx, true);
  Out << ", ";
  writeAsOperandInternal(Out, Label.getDebugLoc(), WriterCtx, true);
  Out << ")";
}
 
void AssemblyWriter::printMetadataAttachments(
    const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
    StringRef Separator) {
  if (MDs.empty())
    return;
 
  if (MDNames.empty())
    MDs[0].second->getContext().getMDKindNames(MDNames);
 
  auto WriterCtx = getContext();
  for (const auto &I : MDs) {
    unsigned Kind = I.first;
    Out << Separator;
    if (Kind < MDNames.size()) {
      Out << "!";
      printMetadataIdentifier(MDNames[Kind], Out);
    } else
      Out << "!<unknown kind #" << Kind << ">";
    Out << ' ';
    writeAsOperandInternal(Out, I.second, WriterCtx);
  }
}
 
void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
  if (AnnotationWriter)
    AnnotationWriter->emitMDNodeAnnot(Node, Out);
 
  Out << '!' << Slot << " = ";
  printMDNodeBody(Node);
  Out << "\n";
}
 
void AssemblyWriter::writeAllMDNodes() {
  SmallVector<std::pair<unsigned, const MDNode *>, 16> Nodes;
  Nodes.reserve(Machine.mdn_size());
  for (auto &I : llvm::make_range(Machine.mdn_begin(), Machine.mdn_end()))
    Nodes.emplace_back(I.second, cast<MDNode>(I.first));
  llvm::sort(Nodes);
 
  for (auto [Slot, Node] : Nodes)
    writeMDNode(Slot, Node);
}
 
void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
  auto WriterCtx = getContext();
  writeMDNodeBodyInternal(Out, Node, WriterCtx);
}
 
void AssemblyWriter::writeAttribute(const Attribute &Attr, bool InAttrGroup) {
  if (!Attr.isTypeAttribute()) {
    Out << Attr.getAsString(InAttrGroup);
    return;
  }
 
  Out << Attribute::getNameFromAttrKind(Attr.getKindAsEnum());
  if (Type *Ty = Attr.getValueAsType()) {
    Out << '(';
    TypePrinter.print(Ty, Out);
    Out << ')';
  }
}
 
void AssemblyWriter::writeAttributeSet(const AttributeSet &AttrSet,
                                       bool InAttrGroup) {
  ListSeparator LS(" ");
  for (const auto &Attr : AttrSet) {
    Out << LS;
    writeAttribute(Attr, InAttrGroup);
  }
}
 
void AssemblyWriter::writeAllAttributeGroups() {
  std::vector<std::pair<AttributeSet, unsigned>> asVec;
  asVec.resize(Machine.as_size());
 
  for (auto &I : llvm::make_range(Machine.as_begin(), Machine.as_end()))
    asVec[I.second] = I;
 
  for (const auto &I : asVec)
    Out << "attributes #" << I.second << " = { "
        << I.first.getAsString(true) << " }\n";
}
 
void AssemblyWriter::printUseListOrder(const Value *V,
                                       ArrayRef<unsigned> Shuffle) {
  if (Machine.getFunction())
    Out << "  ";
 
  Out << "uselistorder ";
  writeOperand(V, true);
 
  assert(Shuffle.size() >= 2 && "Shuffle too small");
  Out << ", { " << llvm::interleaved(Shuffle) << " }\n";
}
 
void AssemblyWriter::printUseLists(const Function *F) {
  auto It = UseListOrders.find(F);
  if (It == UseListOrders.end())
    return;
 
  Out << "\n; uselistorder directives\n";
  for (const auto &Pair : It->second)
    printUseListOrder(Pair.first, Pair.second);
}
 
//===----------------------------------------------------------------------===//
//                       External Interface declarations
//===----------------------------------------------------------------------===//
 
void Function::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
                     bool ShouldPreserveUseListOrder, bool IsForDebug) const {
  SlotTracker SlotTable(this);
  formatted_raw_ostream OS(ROS);
  AssemblyWriter W(OS, SlotTable, this->getParent(), AAW, IsForDebug,
                   ShouldPreserveUseListOrder);
  W.printFunction(this);
}
 
void BasicBlock::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
                     bool ShouldPreserveUseListOrder,
                     bool IsForDebug) const {
  SlotTracker SlotTable(this->getParent());
  formatted_raw_ostream OS(ROS);
  AssemblyWriter W(OS, SlotTable, this->getModule(), AAW, IsForDebug,
                   ShouldPreserveUseListOrder);
  W.printBasicBlock(this);
}
 
void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
                   bool ShouldPreserveUseListOrder, bool IsForDebug) const {
  SlotTracker SlotTable(this, /*ShouldTrackMetadataDefinitions=*/true);
  formatted_raw_ostream OS(ROS);
  AssemblyWriter W(OS, SlotTable, this, AAW, IsForDebug,
                   ShouldPreserveUseListOrder);
  W.printModule(this);
}
 
void NamedMDNode::print(raw_ostream &ROS, bool IsForDebug) const {
  SlotTracker SlotTable(getParent());
  formatted_raw_ostream OS(ROS);
  AssemblyWriter W(OS, SlotTable, getParent(), nullptr, IsForDebug);
  W.printNamedMDNode(this);
}
 
void NamedMDNode::print(raw_ostream &ROS, ModuleSlotTracker &MST,
                        bool IsForDebug) const {
  std::optional<SlotTracker> LocalST;
  SlotTracker *SlotTable;
  if (auto *ST = MST.getMachine())
    SlotTable = ST;
  else {
    LocalST.emplace(getParent());
    SlotTable = &*LocalST;
  }
 
  formatted_raw_ostream OS(ROS);
  AssemblyWriter W(OS, *SlotTable, getParent(), nullptr, IsForDebug);
  W.printNamedMDNode(this);
}
 
void Comdat::print(raw_ostream &ROS, bool /*IsForDebug*/) const {
  printLLVMName(ROS, getName(), ComdatPrefix);
  ROS << " = comdat ";
 
  switch (getSelectionKind()) {
  case Comdat::Any:
    ROS << "any";
    break;
  case Comdat::ExactMatch:
    ROS << "exactmatch";
    break;
  case Comdat::Largest:
    ROS << "largest";
    break;
  case Comdat::NoDeduplicate:
    ROS << "nodeduplicate";
    break;
  case Comdat::SameSize:
    ROS << "samesize";
    break;
  }
 
  ROS << '\n';
}
 
void Type::print(raw_ostream &OS, bool /*IsForDebug*/, bool NoDetails) const {
  TypePrinting TP;
  TP.print(const_cast<Type*>(this), OS);
 
  if (NoDetails)
    return;
 
  // If the type is a named struct type, print the body as well.
  if (auto *STy = dyn_cast<StructType>(const_cast<Type *>(this)))
    if (!STy->isLiteral()) {
      OS << " = type ";
      TP.printStructBody(STy, OS);
    }
}
 
void DbgMarker::print(raw_ostream &ROS, bool IsForDebug) const {
 
  ModuleSlotTracker MST(getModuleFromDPI(this));
  print(ROS, MST, IsForDebug);
}
 
void DbgVariableRecord::print(raw_ostream &ROS, bool IsForDebug) const {
 
  ModuleSlotTracker MST(getModuleFromDPI(this));
  print(ROS, MST, IsForDebug);
}
 
void DbgMarker::print(raw_ostream &ROS, ModuleSlotTracker &MST,
                      bool IsForDebug) const {
  formatted_raw_ostream OS(ROS);
  SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
  SlotTracker &SlotTable =
      MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
  const Function *F = getParent() ? getParent()->getParent() : nullptr;
  if (F)
    MST.incorporateFunction(*F);
  AssemblyWriter W(OS, SlotTable, getModuleFromDPI(this), nullptr, IsForDebug);
  W.printDbgMarker(*this);
}
 
void DbgLabelRecord::print(raw_ostream &ROS, bool IsForDebug) const {
 
  ModuleSlotTracker MST(getModuleFromDPI(this));
  print(ROS, MST, IsForDebug);
}
 
void DbgVariableRecord::print(raw_ostream &ROS, ModuleSlotTracker &MST,
                              bool IsForDebug) const {
  formatted_raw_ostream OS(ROS);
  SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
  SlotTracker &SlotTable =
      MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
  const Function *F = Marker && Marker->getParent()
                          ? Marker->getParent()->getParent()
                          : nullptr;
  if (F)
    MST.incorporateFunction(*F);
  AssemblyWriter W(OS, SlotTable, getModuleFromDPI(this), nullptr, IsForDebug);
  W.printDbgVariableRecord(*this);
}
 
void DbgLabelRecord::print(raw_ostream &ROS, ModuleSlotTracker &MST,
                           bool IsForDebug) const {
  formatted_raw_ostream OS(ROS);
  SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
  SlotTracker &SlotTable =
      MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
  const Function *F =
      Marker->getParent() ? Marker->getParent()->getParent() : nullptr;
  if (F)
    MST.incorporateFunction(*F);
 
  AssemblyWriter W(OS, SlotTable, getModuleFromDPI(this), nullptr, IsForDebug);
  W.printDbgLabelRecord(*this);
}
 
void Value::print(raw_ostream &ROS, bool IsForDebug) const {
  if (const auto *F = dyn_cast<Function>(this)) {
    F->print(ROS, nullptr, /*ShouldPreserveUseListOrder=*/false, IsForDebug);
    return;
  }
  if (const auto *BB = dyn_cast<BasicBlock>(this)) {
    BB->print(ROS, nullptr, /*ShouldPreserveUseListOrder=*/false, IsForDebug);
    return;
  }
 
  ModuleSlotTracker MST(getModuleFromVal(this));
  print(ROS, MST, IsForDebug);
}
 
void Value::print(raw_ostream &ROS, ModuleSlotTracker &MST,
                  bool IsForDebug) const {
  formatted_raw_ostream OS(ROS);
  SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
  SlotTracker &SlotTable =
      MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
  auto IncorporateFunction = [&](const Function *F) {
    if (F)
      MST.incorporateFunction(*F);
  };
 
  if (const auto *I = dyn_cast<Instruction>(this)) {
    IncorporateFunction(I->getParent() ? I->getParent()->getParent() : nullptr);
    AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr, IsForDebug);
    W.printInstruction(*I);
  } else if (const auto *BB = dyn_cast<BasicBlock>(this)) {
    IncorporateFunction(BB->getParent());
    AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr, IsForDebug);
    W.printBasicBlock(BB);
  } else if (const auto *GV = dyn_cast<GlobalValue>(this)) {
    AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr, IsForDebug);
    if (const auto *V = dyn_cast<GlobalVariable>(GV))
      W.printGlobal(V);
    else if (const auto *F = dyn_cast<Function>(GV))
      W.printFunction(F);
    else if (const auto *A = dyn_cast<GlobalAlias>(GV))
      W.printAlias(A);
    else if (const auto *I = dyn_cast<GlobalIFunc>(GV))
      W.printIFunc(I);
    else
      llvm_unreachable("Unknown GlobalValue to print out!");
  } else if (const auto *V = dyn_cast<MetadataAsValue>(this)) {
    V->getMetadata()->print(ROS, MST, getModuleFromVal(V));
  } else if (const auto *C = dyn_cast<Constant>(this)) {
    TypePrinting TypePrinter;
    TypePrinter.print(C->getType(), OS);
    OS << ' ';
    AsmWriterContext WriterCtx(&TypePrinter, MST.getMachine());
    writeConstantInternal(OS, C, WriterCtx);
  } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
    this->printAsOperand(OS, /* PrintType */ true, MST);
  } else {
    llvm_unreachable("Unknown value to print out!");
  }
}
 
/// Print without a type, skipping the TypePrinting object.
///
/// \return \c true iff printing was successful.
static bool printWithoutType(const Value &V, raw_ostream &O,
                             SlotTracker *Machine, const Module *M) {
  if (V.hasName() || isa<GlobalValue>(V) ||
      (!isa<Constant>(V) && !isa<MetadataAsValue>(V))) {
    AsmWriterContext WriterCtx(nullptr, Machine, M);
    writeAsOperandInternal(O, &V, WriterCtx);
    return true;
  }
  return false;
}
 
static void printAsOperandImpl(const Value &V, raw_ostream &O, bool PrintType,
                               ModuleSlotTracker &MST) {
  TypePrinting TypePrinter(MST.getModule());
  AsmWriterContext WriterCtx(&TypePrinter, MST.getMachine(), MST.getModule());
  writeAsOperandInternal(O, &V, WriterCtx, PrintType);
}
 
void Value::printAsOperand(raw_ostream &O, bool PrintType,
                           const Module *M) const {
  if (!M)
    M = getModuleFromVal(this);
 
  if (!PrintType)
    if (printWithoutType(*this, O, nullptr, M))
      return;
 
  SlotTracker Machine(M);
  ModuleSlotTracker MST(Machine, M);
  printAsOperandImpl(*this, O, PrintType, MST);
}
 
void Value::printAsOperand(raw_ostream &O, bool PrintType,
                           ModuleSlotTracker &MST) const {
  if (!PrintType)
    if (printWithoutType(*this, O, MST.getMachine(), MST.getModule()))
      return;
 
  printAsOperandImpl(*this, O, PrintType, MST);
}
 
/// Recursive version of printMetadataImpl.
static void printMetadataImplRec(raw_ostream &ROS, const Metadata &MD,
                                 AsmWriterContext &WriterCtx) {
  formatted_raw_ostream OS(ROS);
  writeAsOperandInternal(OS, &MD, WriterCtx, /* FromValue */ true);
 
  auto *N = dyn_cast<MDNode>(&MD);
  if (!N || isa<DIExpression>(MD))
    return;
 
  OS << " = ";
  writeMDNodeBodyInternal(OS, N, WriterCtx);
}
 
namespace {
struct MDTreeAsmWriterContext : public AsmWriterContext {
  unsigned Level;
  // {Level, Printed string}
  using EntryTy = std::pair<unsigned, std::string>;
  SmallVector<EntryTy, 4> Buffer;
 
  // Used to break the cycle in case there is any.
  SmallPtrSet<const Metadata *, 4> Visited;
 
  raw_ostream &MainOS;
 
  MDTreeAsmWriterContext(TypePrinting *TP, SlotTracker *ST, const Module *M,
                         const ModuleSlotTracker *MST, raw_ostream &OS,
                         const Metadata *InitMD)
      : AsmWriterContext(TP, ST, M, MST), Level(0U), Visited({InitMD}),
        MainOS(OS) {}
 
  void onWriteMetadataAsOperand(const Metadata *MD) override {
    if (!Visited.insert(MD).second)
      return;
 
    std::string Str;
    raw_string_ostream SS(Str);
    ++Level;
    // A placeholder entry to memorize the correct
    // position in buffer.
    Buffer.emplace_back(std::make_pair(Level, ""));
    unsigned InsertIdx = Buffer.size() - 1;
 
    printMetadataImplRec(SS, *MD, *this);
    Buffer[InsertIdx].second = std::move(SS.str());
    --Level;
  }
 
  ~MDTreeAsmWriterContext() override {
    for (const auto &Entry : Buffer) {
      MainOS << "\n";
      unsigned NumIndent = Entry.first * 2U;
      MainOS.indent(NumIndent) << Entry.second;
    }
  }
};
} // end anonymous namespace
 
static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
                              ModuleSlotTracker &MST, const Module *M,
                              bool OnlyAsOperand, bool PrintAsTree = false) {
  formatted_raw_ostream OS(ROS);
 
  TypePrinting TypePrinter(M);
 
  std::unique_ptr<AsmWriterContext> WriterCtx;
  if (PrintAsTree && !OnlyAsOperand)
    WriterCtx = std::make_unique<MDTreeAsmWriterContext>(
        &TypePrinter, MST.getMachine(), M, &MST, OS, &MD);
  else
    WriterCtx = std::make_unique<AsmWriterContext>(&TypePrinter,
                                                   MST.getMachine(), M, &MST);
 
  writeAsOperandInternal(OS, &MD, *WriterCtx, /* FromValue */ true);
 
  auto *N = dyn_cast<MDNode>(&MD);
  if (OnlyAsOperand || !N || isa<DIExpression>(MD))
    return;
 
  OS << " = ";
  writeMDNodeBodyInternal(OS, N, *WriterCtx);
}
 
void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
  ModuleSlotTracker MST(M);
  printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ true);
}
 
void Metadata::printAsOperand(raw_ostream &OS, ModuleSlotTracker &MST,
                              const Module *M) const {
  printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ true);
}
 
void Metadata::print(raw_ostream &OS, const Module *M,
                     bool /*IsForDebug*/) const {
  ModuleSlotTracker MST(M);
  printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false);
}
 
void Metadata::print(raw_ostream &OS, ModuleSlotTracker &MST,
                     const Module *M, bool /*IsForDebug*/) const {
  printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false);
}
 
void MDNode::printTree(raw_ostream &OS, const Module *M) const {
  ModuleSlotTracker MST(M);
  printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false,
                    /*PrintAsTree=*/true);
}
 
void MDNode::printTree(raw_ostream &OS, ModuleSlotTracker &MST,
                       const Module *M) const {
  printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false,
                    /*PrintAsTree=*/true);
}
 
void ModuleSummaryIndex::print(raw_ostream &ROS, bool IsForDebug) const {
  SlotTracker SlotTable(this);
  formatted_raw_ostream OS(ROS);
  AssemblyWriter W(OS, SlotTable, this, IsForDebug);
  W.printModuleSummaryIndex();
}
 
void ModuleSlotTracker::collectMDNodes(MachineMDNodeListType &L) const {
  SlotTracker *ST = MachineStorage.get();
  if (!ST)
    return;
 
  for (auto &I : llvm::make_range(ST->mdn_begin(), ST->mdn_end()))
    L.push_back(std::make_pair(I.second, I.first));
}
 
#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
// Value::dump - allow easy printing of Values from the debugger.
LLVM_DUMP_METHOD
void Value::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
 
// Value::dump - allow easy printing of Values from the debugger.
LLVM_DUMP_METHOD
void DbgMarker::dump() const {
  print(dbgs(), /*IsForDebug=*/true);
  dbgs() << '\n';
}
 
// Value::dump - allow easy printing of Values from the debugger.
LLVM_DUMP_METHOD
void DbgRecord::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
 
// Type::dump - allow easy printing of Types from the debugger.
LLVM_DUMP_METHOD
void Type::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
 
// Module::dump() - Allow printing of Modules from the debugger.
LLVM_DUMP_METHOD
void Module::dump() const {
  print(dbgs(), nullptr,
        /*ShouldPreserveUseListOrder=*/false, /*IsForDebug=*/true);
}
 
// Allow printing of Comdats from the debugger.
LLVM_DUMP_METHOD
void Comdat::dump() const { print(dbgs(), /*IsForDebug=*/true); }
 
// NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
LLVM_DUMP_METHOD
void NamedMDNode::dump() const { print(dbgs(), /*IsForDebug=*/true); }
 
LLVM_DUMP_METHOD
void Metadata::dump() const { dump(nullptr); }
 
LLVM_DUMP_METHOD
void Metadata::dump(const Module *M) const {
  print(dbgs(), M, /*IsForDebug=*/true);
  dbgs() << '\n';
}
 
LLVM_DUMP_METHOD
void MDNode::dumpTree() const { dumpTree(nullptr); }
 
LLVM_DUMP_METHOD
void MDNode::dumpTree(const Module *M) const {
  printTree(dbgs(), M);
  dbgs() << '\n';
}
 
// Allow printing of ModuleSummaryIndex from the debugger.
LLVM_DUMP_METHOD
void ModuleSummaryIndex::dump() const { print(dbgs(), /*IsForDebug=*/true); }
#endif