HLSLRootSignature.cpp

Go to the documentation of this file.

//===- HLSLRootSignature.cpp - HLSL Root Signature helpers ----------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
///
/// \file This file contains helpers for working with HLSL Root Signatures.
///
//===----------------------------------------------------------------------===//
 
#include "llvm/Frontend/HLSL/HLSLRootSignature.h"
#include "llvm/Support/DXILABI.h"
#include "llvm/Support/InterleavedRange.h"
#include "llvm/Support/ScopedPrinter.h"
 
namespace llvm {
namespace hlsl {
namespace rootsig {
 
template <typename T>
static raw_ostream &printFlags(raw_ostream &OS, const T Value,
                               EnumStrings<T> Flags) {
  bool FlagSet = false;
  unsigned Remaining = llvm::to_underlying(Value);
  while (Remaining) {
    unsigned Bit = 1u << llvm::countr_zero(Remaining);
    if (Remaining & Bit) {
      if (FlagSet)
        OS << " | ";
 
      StringRef MaybeFlag = Flags.toString(T(Bit));
      if (!MaybeFlag.empty())
        OS << MaybeFlag;
      else
        OS << "invalid: " << Bit;
 
      FlagSet = true;
    }
    Remaining &= ~Bit;
  }
 
  if (!FlagSet)
    OS << "None";
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS, const Register &Reg) {
  constexpr EnumStringDef<RegisterType> RegisterNameDefs[] = {
      {{"b"}, RegisterType::BReg},
      {{"t"}, RegisterType::TReg},
      {{"u"}, RegisterType::UReg},
      {{"s"}, RegisterType::SReg},
  };
  static constexpr auto RegisterNames = BUILD_ENUM_STRINGS(RegisterNameDefs);
  OS << EnumStrings(RegisterNames).toString(Reg.ViewType) << Reg.Number;
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS,
                               const llvm::dxbc::ShaderVisibility &Visibility) {
  OS << dxbc::getShaderVisibility().toString(Visibility);
 
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS,
                               const llvm::dxbc::SamplerFilter &Filter) {
  OS << dxbc::getSamplerFilters().toString(Filter);
 
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS,
                               const dxbc::TextureAddressMode &Address) {
  OS << dxbc::getTextureAddressModes().toString(Address);
 
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS,
                               const dxbc::ComparisonFunc &CompFunc) {
  OS << dxbc::getComparisonFuncs().toString(CompFunc);
 
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS,
                               const dxbc::StaticBorderColor &BorderColor) {
  OS << dxbc::getStaticBorderColors().toString(BorderColor);
 
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS,
                               const dxil::ResourceClass &Type) {
  OS << dxil::getResourceClassName(Type);
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS,
                               const dxbc::RootDescriptorFlags &Flags) {
  printFlags(OS, Flags, dxbc::getRootDescriptorFlags());
 
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS,
                               const llvm::dxbc::DescriptorRangeFlags &Flags) {
  printFlags(OS, Flags, dxbc::getDescriptorRangeFlags());
 
  return OS;
}
 
static raw_ostream &operator<<(raw_ostream &OS,
                               const llvm::dxbc::StaticSamplerFlags &Flags) {
  printFlags(OS, Flags, dxbc::getStaticSamplerFlags());
 
  return OS;
}
 
raw_ostream &operator<<(raw_ostream &OS, const dxbc::RootFlags &Flags) {
  OS << "RootFlags(";
  printFlags(OS, Flags, dxbc::getRootFlags());
  OS << ")";
 
  return OS;
}
 
raw_ostream &operator<<(raw_ostream &OS, const RootConstants &Constants) {
  OS << "RootConstants(num32BitConstants = " << Constants.Num32BitConstants
     << ", " << Constants.Reg << ", space = " << Constants.Space
     << ", visibility = " << Constants.Visibility << ")";
 
  return OS;
}
 
raw_ostream &operator<<(raw_ostream &OS, const DescriptorTable &Table) {
  OS << "DescriptorTable(numClauses = " << Table.NumClauses
     << ", visibility = " << Table.Visibility << ")";
 
  return OS;
}
 
raw_ostream &operator<<(raw_ostream &OS, const DescriptorTableClause &Clause) {
  OS << Clause.Type << "(" << Clause.Reg << ", numDescriptors = ";
  if (Clause.NumDescriptors == NumDescriptorsUnbounded)
    OS << "unbounded";
  else
    OS << Clause.NumDescriptors;
  OS << ", space = " << Clause.Space << ", offset = ";
  if (Clause.Offset == DescriptorTableOffsetAppend)
    OS << "DescriptorTableOffsetAppend";
  else
    OS << Clause.Offset;
  OS << ", flags = " << Clause.Flags << ")";
 
  return OS;
}
 
raw_ostream &operator<<(raw_ostream &OS, const RootDescriptor &Descriptor) {
  OS << "Root" << Descriptor.Type << "(" << Descriptor.Reg
     << ", space = " << Descriptor.Space
     << ", visibility = " << Descriptor.Visibility
     << ", flags = " << Descriptor.Flags << ")";
 
  return OS;
}
 
raw_ostream &operator<<(raw_ostream &OS, const StaticSampler &Sampler) {
  OS << "StaticSampler(" << Sampler.Reg << ", filter = " << Sampler.Filter
     << ", addressU = " << Sampler.AddressU
     << ", addressV = " << Sampler.AddressV
     << ", addressW = " << Sampler.AddressW
     << ", mipLODBias = " << Sampler.MipLODBias
     << ", maxAnisotropy = " << Sampler.MaxAnisotropy
     << ", comparisonFunc = " << Sampler.CompFunc
     << ", borderColor = " << Sampler.BorderColor
     << ", minLOD = " << Sampler.MinLOD << ", maxLOD = " << Sampler.MaxLOD
     << ", space = " << Sampler.Space << ", visibility = " << Sampler.Visibility
     << ", flags = " << Sampler.Flags << ")";
  return OS;
}
 
namespace {
 
// We use the OverloadVisit with std::visit to ensure the compiler catches if a
// new RootElement variant type is added but it's operator<< isn't handled.
template <class... Ts> struct OverloadedVisit : Ts... {
  using Ts::operator()...;
};
template <class... Ts> OverloadedVisit(Ts...) -> OverloadedVisit<Ts...>;
 
} // namespace
 
raw_ostream &operator<<(raw_ostream &OS, const RootElement &Element) {
  const auto Visitor = OverloadedVisit{
      [&OS](const dxbc::RootFlags &Flags) { OS << Flags; },
      [&OS](const RootConstants &Constants) { OS << Constants; },
      [&OS](const RootDescriptor &Descriptor) { OS << Descriptor; },
      [&OS](const DescriptorTableClause &Clause) { OS << Clause; },
      [&OS](const DescriptorTable &Table) { OS << Table; },
      [&OS](const StaticSampler &Sampler) { OS << Sampler; },
  };
  std::visit(Visitor, Element);
  return OS;
}
 
void dumpRootElements(raw_ostream &OS, ArrayRef<RootElement> Elements) {
  OS << " RootElements" << interleaved(Elements, ", ", "{", "}");
}
 
} // namespace rootsig
} // namespace hlsl
} // namespace llvm