removing binary format descriptor range dependency

This commit is contained in:
Joao Saffran 2025-08-20 11:55:38 -07:00
parent f3ecd8ae8c
commit 8c143ba0ce
12 changed files with 82 additions and 57 deletions

View File

@ -1268,11 +1268,34 @@ bool SemaHLSL::handleRootSignatureElements(
// value
ReportError(Loc, 1, 0xfffffffe);
}
switch (Clause->Type) {
if (!llvm::hlsl::rootsig::verifyDescriptorRangeFlag(
Version, llvm::to_underlying(Clause->Type),
llvm::to_underlying(Clause->Flags)))
ReportFlagError(Loc);
case llvm::dxil::ResourceClass::SRV:
if (!llvm::hlsl::rootsig::verifyDescriptorRangeFlag(
Version, llvm::dxbc::DescriptorRangeType::SRV,
llvm::to_underlying(Clause->Flags)))
ReportFlagError(Loc);
break;
case llvm::dxil::ResourceClass::UAV:
if (!llvm::hlsl::rootsig::verifyDescriptorRangeFlag(
Version, llvm::dxbc::DescriptorRangeType::UAV,
llvm::to_underlying(Clause->Flags)))
ReportFlagError(Loc);
break;
case llvm::dxil::ResourceClass::CBuffer:
if (!llvm::hlsl::rootsig::verifyDescriptorRangeFlag(
Version, llvm::dxbc::DescriptorRangeType::CBV,
llvm::to_underlying(Clause->Flags)))
ReportFlagError(Loc);
break;
case llvm::dxil::ResourceClass::Sampler:
if (!llvm::hlsl::rootsig::verifyDescriptorRangeFlag(
Version, llvm::dxbc::DescriptorRangeType::Sampler,
llvm::to_underlying(Clause->Flags)))
ReportFlagError(Loc);
break;
break;
}
}
}

View File

@ -209,6 +209,16 @@ inline bool isValidParameterType(uint32_t V) {
return false;
}
#define DESCRIPTOR_RANGE(Val, Enum) \
case Val: \
return true;
inline bool isValidRangeType(uint32_t V) {
switch (V) {
#include "DXContainerConstants.def"
}
return false;
}
#define SHADER_VISIBILITY(Val, Enum) Enum = Val,
enum class ShaderVisibility : uint32_t {
#include "DXContainerConstants.def"

View File

@ -30,7 +30,8 @@ LLVM_ABI bool verifyRegisterValue(uint32_t RegisterValue);
LLVM_ABI bool verifyRegisterSpace(uint32_t RegisterSpace);
LLVM_ABI bool verifyRootDescriptorFlag(uint32_t Version, uint32_t FlagsVal);
LLVM_ABI bool verifyRangeType(uint32_t Type);
LLVM_ABI bool verifyDescriptorRangeFlag(uint32_t Version, uint32_t Type,
LLVM_ABI bool verifyDescriptorRangeFlag(uint32_t Version,
dxbc::DescriptorRangeType Type,
uint32_t FlagsVal);
LLVM_ABI bool verifyNumDescriptors(uint32_t NumDescriptors);
LLVM_ABI bool verifySamplerFilter(uint32_t Value);

View File

@ -31,6 +31,15 @@ struct RootDescriptor {
uint32_t Flags;
};
struct DescriptorRange {
dxbc::DescriptorRangeType RangeType;
uint32_t NumDescriptors;
uint32_t BaseShaderRegister;
uint32_t RegisterSpace;
uint32_t Flags;
uint32_t OffsetInDescriptorsFromTableStart;
};
struct RootParameterInfo {
dxbc::RootParameterType Type;
dxbc::ShaderVisibility Visibility;
@ -42,11 +51,11 @@ struct RootParameterInfo {
};
struct DescriptorTable {
SmallVector<dxbc::RTS0::v2::DescriptorRange> Ranges;
SmallVector<dxbc::RTS0::v2::DescriptorRange>::const_iterator begin() const {
SmallVector<DescriptorRange> Ranges;
SmallVector<DescriptorRange>::const_iterator begin() const {
return Ranges.begin();
}
SmallVector<dxbc::RTS0::v2::DescriptorRange>::const_iterator end() const {
SmallVector<DescriptorRange>::const_iterator end() const {
return Ranges.end();
}
};

View File

@ -149,6 +149,16 @@ ArrayRef<EnumEntry<RootParameterType>> dxbc::getRootParameterTypes() {
return ArrayRef(RootParameterTypes);
}
#define DESCRIPTOR_RANGE(Val, Enum) {#Enum, DescriptorRangeType::Enum},
static const EnumEntry<DescriptorRangeType> DescriptorRangeTypes[] = {
#include "llvm/BinaryFormat/DXContainerConstants.def"
};
ArrayRef<EnumEntry<DescriptorRangeType>> dxbc::getDescriptorRangeTypes() {
return ArrayRef(DescriptorRangeTypes);
}
#define SEMANTIC_KIND(Val, Enum) {#Enum, PSV::SemanticKind::Enum},
static const EnumEntry<PSV::SemanticKind> SemanticKindNames[] = {

View File

@ -325,7 +325,7 @@ Error MetadataParser::parseDescriptorRange(mcdxbc::DescriptorTable &Table,
if (RangeDescriptorNode->getNumOperands() != 6)
return make_error<InvalidRSMetadataFormat>("Descriptor Range");
dxbc::RTS0::v2::DescriptorRange Range;
mcdxbc::DescriptorRange Range;
std::optional<StringRef> ElementText =
extractMdStringValue(RangeDescriptorNode, 0);
@ -333,17 +333,11 @@ Error MetadataParser::parseDescriptorRange(mcdxbc::DescriptorTable &Table,
if (!ElementText.has_value())
return make_error<InvalidRSMetadataFormat>("Descriptor Range");
Range.RangeType =
StringSwitch<uint32_t>(*ElementText)
.Case("CBV", to_underlying(dxbc::DescriptorRangeType::CBV))
.Case("SRV", to_underlying(dxbc::DescriptorRangeType::SRV))
.Case("UAV", to_underlying(dxbc::DescriptorRangeType::UAV))
.Case("Sampler", to_underlying(dxbc::DescriptorRangeType::Sampler))
.Default(~0U);
if (Range.RangeType == ~0U)
return make_error<GenericRSMetadataError>("Invalid Descriptor Range type.",
RangeDescriptorNode);
Range.RangeType = StringSwitch<dxbc::DescriptorRangeType>(*ElementText)
.Case("CBV", dxbc::DescriptorRangeType::CBV)
.Case("SRV", dxbc::DescriptorRangeType::SRV)
.Case("UAV", dxbc::DescriptorRangeType::UAV)
.Case("Sampler", dxbc::DescriptorRangeType::Sampler);
if (std::optional<uint32_t> Val = extractMdIntValue(RangeDescriptorNode, 1))
Range.NumDescriptors = *Val;
@ -571,12 +565,7 @@ Error MetadataParser::validateRootSignature(
case dxbc::RootParameterType::DescriptorTable: {
const mcdxbc::DescriptorTable &Table =
RSD.ParametersContainer.getDescriptorTable(Info.Location);
for (const dxbc::RTS0::v2::DescriptorRange &Range : Table) {
if (!hlsl::rootsig::verifyRangeType(Range.RangeType))
DeferredErrs =
joinErrors(std::move(DeferredErrs),
make_error<RootSignatureValidationError<uint32_t>>(
"RangeType", Range.RangeType));
for (const mcdxbc::DescriptorRange &Range : Table) {
if (!hlsl::rootsig::verifyRegisterSpace(Range.RegisterSpace))
DeferredErrs =

View File

@ -63,13 +63,12 @@ bool verifyRangeType(uint32_t Type) {
return false;
}
bool verifyDescriptorRangeFlag(uint32_t Version, uint32_t Type,
bool verifyDescriptorRangeFlag(uint32_t Version, dxbc::DescriptorRangeType Type,
uint32_t FlagsVal) {
using FlagT = dxbc::DescriptorRangeFlags;
FlagT Flags = FlagT(FlagsVal);
const bool IsSampler =
(Type == llvm::to_underlying(dxbc::DescriptorRangeType::Sampler));
const bool IsSampler = (Type == dxbc::DescriptorRangeType::Sampler);
if (Version == 1) {
// Since the metadata is unversioned, we expect to explicitly see the values

View File

@ -315,9 +315,10 @@ void DXContainerWriter::writeParts(raw_ostream &OS) {
P.RootSignature->Parameters.getOrInsertTable(L);
mcdxbc::DescriptorTable Table;
for (const auto &R : TableYaml.Ranges) {
dxbc::RTS0::v2::DescriptorRange Range;
Range.RangeType = R.RangeType;
assert(dxbc::isValidRangeType(R.RangeType) &&
"Invalid Descriptor Range Type");
mcdxbc::DescriptorRange Range;
Range.RangeType = dxbc::DescriptorRangeType(R.RangeType);
Range.NumDescriptors = R.NumDescriptors;
Range.BaseShaderRegister = R.BaseShaderRegister;
Range.RegisterSpace = R.RegisterSpace;

View File

@ -194,7 +194,7 @@ static void validateRootSignature(Module &M,
const mcdxbc::DescriptorTable &Table =
RSD.ParametersContainer.getDescriptorTable(ParamInfo.Location);
for (const dxbc::RTS0::v2::DescriptorRange &Range : Table.Ranges) {
for (const mcdxbc::DescriptorRange &Range : Table.Ranges) {
uint32_t UpperBound =
Range.NumDescriptors == ~0U
? Range.BaseShaderRegister

View File

@ -205,8 +205,11 @@ PreservedAnalyses RootSignatureAnalysisPrinter::run(Module &M,
RS.ParametersContainer.getDescriptorTable(Loc);
OS << " NumRanges: " << Table.Ranges.size() << "\n";
for (const dxbc::RTS0::v2::DescriptorRange Range : Table) {
OS << " - Range Type: " << Range.RangeType << "\n"
for (const mcdxbc::DescriptorRange Range : Table) {
OS << " - Range Type: "
<< enumToStringRef(Range.RangeType,
dxbc::getDescriptorRangeTypes())
<< "\n"
<< " Register Space: " << Range.RegisterSpace << "\n"
<< " Base Shader Register: " << Range.BaseShaderRegister << "\n"
<< " Num Descriptors: " << Range.NumDescriptors << "\n"

View File

@ -1,20 +0,0 @@
; RUN: not opt -passes='print<dxil-root-signature>' %s -S -o - 2>&1 | FileCheck %s
target triple = "dxil-unknown-shadermodel6.0-compute"
; CHECK: error: Invalid Descriptor Range type
; CHECK-NOT: Root Signature Definitions
define void @main() #0 {
entry:
ret void
}
attributes #0 = { "hlsl.numthreads"="1,1,1" "hlsl.shader"="compute" }
!dx.rootsignatures = !{!2} ; list of function/root signature pairs
!2 = !{ ptr @main, !3, i32 2 } ; function, root signature
!3 = !{ !5 } ; list of root signature elements
!5 = !{ !"DescriptorTable", i32 0, !6, !7 }
!6 = !{ !"Invalid", i32 1, i32 0, i32 -1, i32 -1, i32 4 }
!7 = !{ !"UAV", i32 5, i32 1, i32 10, i32 5, i32 2 }

View File

@ -38,13 +38,13 @@ attributes #0 = { "hlsl.numthreads"="1,1,1" "hlsl.shader"="compute" }
;CHECK-NEXT: - Parameter Type: DescriptorTable
;CHECK-NEXT: Shader Visibility: All
;CHECK-NEXT: NumRanges: 2
;CHECK-NEXT: - Range Type: 0
;CHECK-NEXT: - Range Type: SRV
;CHECK-NEXT: Register Space: 0
;CHECK-NEXT: Base Shader Register: 1
;CHECK-NEXT: Num Descriptors: 1
;CHECK-NEXT: Offset In Descriptors From Table Start: 4294967295
;CHECK-NEXT: Flags: 4
;CHECK-NEXT: - Range Type: 1
;CHECK-NEXT: - Range Type: UAV
;CHECK-NEXT: Register Space: 10
;CHECK-NEXT: Base Shader Register: 1
;CHECK-NEXT: Num Descriptors: 5