Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[DirectX] adding support to read/write descriptor table data using obj2yaml/yaml2obj #138315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 70 commits into from
May 29, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
70 commits
Select commit Hold shift + click to select a range
0abacfc
adding support for Root Descriptors
Apr 24, 2025
8b8c02a
clean up
Apr 24, 2025
7ac9641
addressing comments
Apr 25, 2025
c105458
formating
Apr 26, 2025
efe76aa
try fix test
Apr 26, 2025
a928e9d
addressing comments
Apr 26, 2025
a38f10b
refactoring mcdxbc struct to store root parameters out of order
Apr 25, 2025
9a7c359
changing name
Apr 28, 2025
d6c2b55
changing variant to host pointers
Apr 28, 2025
93e4cf2
clean up
Apr 28, 2025
b45b1b6
fix
Apr 28, 2025
f804a23
fix
Apr 28, 2025
44bd13a
making read work
Apr 29, 2025
ac51bf6
adding reading logic
May 2, 2025
97fb003
test pass locally
May 2, 2025
93e04bd
adding tests
May 2, 2025
2f6d579
adding more tests
May 2, 2025
76b1b75
clean up
May 2, 2025
b2bfb02
refactoring root signature dxcontainer yaml representation
May 2, 2025
9ee2964
clean up
May 2, 2025
2527580
fix test
May 2, 2025
c3a46da
copy test
May 2, 2025
15eb6f5
fix naming
May 5, 2025
3e26364
moving root signature binary representation to RTS0 namespace
May 5, 2025
b9d7f07
fix naming
May 5, 2025
46cc8c1
addressing comments
May 8, 2025
1b3e10a
addressing comments
May 8, 2025
1f31957
addressing comments
May 8, 2025
e8fbfce
clean up
May 8, 2025
a31e5a5
removing v parameter
May 9, 2025
a394ad0
Merge branch 'obj2yaml/root-descriptors' into refactoring/remove-union
May 9, 2025
ad415a7
clean up
May 9, 2025
8ff4845
Merge branch 'main' into refactoring/remove-union
May 9, 2025
98c6a5f
updating namespace naming
May 14, 2025
d67f7d3
addressing comment
May 14, 2025
5453ad0
clean up
May 14, 2025
836a8a8
format
May 14, 2025
5bd57a6
adding comment
May 14, 2025
960cb9c
adrresing comments
May 14, 2025
a60c7a3
clean up
May 14, 2025
2a4c2cb
formatting
May 15, 2025
c29d3f2
addressing comments
May 15, 2025
1513dab
Merge branch 'refactoring/remove-union' into obj2yaml/descriptor-table
May 16, 2025
95f3e99
Merge branch 'main' into obj2yaml/descriptor-table
May 16, 2025
eb97f1b
fixing test issues
May 16, 2025
a9b87c2
format
May 16, 2025
28be2f8
format
May 20, 2025
76a2b07
clean up
May 21, 2025
b891126
clean up
May 21, 2025
2a93252
fix formating issue
May 21, 2025
d616b65
fix formating issue
May 21, 2025
6eac7c4
making NumDescriptors uint32_t
May 22, 2025
df194b0
Merge branch 'main' into refactoring/dxcontainer-yaml
May 22, 2025
0136cfc
fix testing issues
May 22, 2025
b589d10
clean up
May 22, 2025
c7042b2
clean up
May 22, 2025
70a9b7f
addressing PR Comments
May 22, 2025
e3489a4
Merge branch 'refactoring/dxcontainer-yaml' into users/joaosaffran/13…
May 22, 2025
f1dd0ce
formating
May 22, 2025
6aa895e
Merge branch 'users/joaosaffran/138318' into obj2yaml/descriptor-table
May 22, 2025
f8080c4
fix tests
May 22, 2025
aabd424
addressing comments
May 23, 2025
e655315
move to namespace
May 23, 2025
3094a75
cleanup
May 23, 2025
984baf6
movin all to RTS0
May 23, 2025
3979151
clean up
May 23, 2025
e65f850
Merge branch 'main' into obj2yaml/descriptor-table
May 28, 2025
f5bffca
fix
May 28, 2025
a585134
adding check
May 28, 2025
08c5207
fix format?
May 29, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
making read work
  • Loading branch information
joaosaffran committed Apr 29, 2025
commit 44bd13abd1038aa43d66f4942d831a3b1c752b8c
35 changes: 35 additions & 0 deletions 35 llvm/include/llvm/BinaryFormat/DXContainer.h
Original file line number Diff line number Diff line change
Expand Up @@ -163,13 +163,25 @@ enum class RootDescriptorFlag : uint32_t {
#include "DXContainerConstants.def"
};

#define DESCRIPTOR_RANGE_FLAG(Num, Val) Val = 1ull << Num,
enum class DescriptorRangeFlag : uint32_t {
#include "DXContainerConstants.def"
};

#define ROOT_PARAMETER(Val, Enum) Enum = Val,
enum class RootParameterType : uint32_t {
#include "DXContainerConstants.def"
};

ArrayRef<EnumEntry<RootParameterType>> getRootParameterTypes();

#define DESCRIPTOR_RANGE(Val, Enum) Enum = Val,
enum class DescriptorRangeType : uint32_t {
#include "DXContainerConstants.def"
};

ArrayRef<EnumEntry<DescriptorRangeType>> getDescriptorRangeTypes();

#define ROOT_PARAMETER(Val, Enum) \
case Val: \
return true;
Expand Down Expand Up @@ -595,6 +607,21 @@ struct RootDescriptor {
sys::swapByteOrder(RegisterSpace);
}
};

struct DescriptorRange {
uint32_t RangeType;
uint32_t NumDescriptors;
uint32_t BaseShaderRegister;
uint32_t RegisterSpace;
int32_t OffsetInDescriptorsFromTableStart;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have expected this to also be uint32_t?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OffsetInDescriptorsFromTableStart, supports -1 to represent unbounded

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are other negative numbers (that is, unsigned values between 2147483648 and 4294967294) impossible / invalid, or do we need to treat them as large numbers?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just checked the spec, I made a mistake NumDescriptors allows -1 to describe unbounded UINT_MAX .

According to the spec: "Use -1 or UINT_MAX to specify an unbounded size.", my understanding is that only -1 is a valid here.

Since folks are annoyed with this I will make it uint32_t.

void swapBytes() {
sys::swapByteOrder(RangeType);
sys::swapByteOrder(NumDescriptors);
sys::swapByteOrder(BaseShaderRegister);
sys::swapByteOrder(RegisterSpace);
sys::swapByteOrder(OffsetInDescriptorsFromTableStart);
}
};
} // namespace v0

namespace v1 {
Expand All @@ -605,6 +632,14 @@ struct RootDescriptor : public v0::RootDescriptor {
sys::swapByteOrder(Flags);
}
};

struct DescriptorRange : public v0::DescriptorRange {
uint32_t Flags;
void swapBytes() {
v0::DescriptorRange::swapBytes();
sys::swapByteOrder(Flags);
}
};
} // namespace v1
} // namespace RST0
// following dx12 naming
Expand Down
25 changes: 24 additions & 1 deletion 25 llvm/include/llvm/BinaryFormat/DXContainerConstants.def
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ ROOT_ELEMENT_FLAG(11, SamplerHeapDirectlyIndexed)
#endif // ROOT_ELEMENT_FLAG


// ROOT_ELEMENT_FLAG(bit offset for the flag, name).
// ROOT_DESCRIPTOR_FLAG(bit offset for the flag, name).
#ifdef ROOT_DESCRIPTOR_FLAG

ROOT_DESCRIPTOR_FLAG(0, NONE)
Expand All @@ -84,15 +84,38 @@ ROOT_DESCRIPTOR_FLAG(3, DATA_STATIC)
#endif // ROOT_DESCRIPTOR_FLAG


// DESCRIPTOR_RANGE_FLAG(bit offset for the flag, name).
#ifdef DESCRIPTOR_RANGE_FLAG

DESCRIPTOR_RANGE_FLAG(0, NONE)
DESCRIPTOR_RANGE_FLAG(1, DESCRIPTORS_VOLATILE)
DESCRIPTOR_RANGE_FLAG(2, DATA_VOLATILE)
DESCRIPTOR_RANGE_FLAG(3, DATA_STATIC_WHILE_SET_AT_EXECUTE)
DESCRIPTOR_RANGE_FLAG(4, DATA_STATIC)
DESCRIPTOR_RANGE_FLAG(16, DESCRIPTORS_STATIC_KEEPING_BUFFER_BOUNDS_CHECKS)
Comment on lines +92 to +97
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These values are wrong - when we turn these into an enum in DXContainer.h, we do Val = 1ull << Num, so we get NONE equal to 1 and DESCRIPTORS_VOLATILE equal to 2, even though DESCRIPTORS_VOLATILE should be 1 AFAICT

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, will fix that

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted here: #143041 (review).

Maybe reusing the values will address this as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix PR: #143201

#undef DESCRIPTOR_RANGE_FLAG
#endif // DESCRIPTOR_RANGE_FLAG

#ifdef ROOT_PARAMETER

ROOT_PARAMETER(0, DescriptorTable)
ROOT_PARAMETER(1, Constants32Bit)
ROOT_PARAMETER(2, CBV)
ROOT_PARAMETER(3, SRV)
ROOT_PARAMETER(4, UAV)
#undef ROOT_PARAMETER
#endif // ROOT_PARAMETER


#ifdef DESCRIPTOR_RANGE

DESCRIPTOR_RANGE(0, SRV)
DESCRIPTOR_RANGE(1, UAV)
DESCRIPTOR_RANGE(2, CBV)
DESCRIPTOR_RANGE(3, Sampler)
#undef DESCRIPTOR_RANGE
#endif // DESCRIPTOR_RANGE

#ifdef SHADER_VISIBILITY

SHADER_VISIBILITY(0, All)
Expand Down
32 changes: 27 additions & 5 deletions 32 llvm/include/llvm/MC/DXContainerRootSignature.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
//===----------------------------------------------------------------------===//

#include "llvm/ADT/STLForwardCompat.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/BinaryFormat/DXContainer.h"
#include <cstddef>
#include <cstdint>
Expand All @@ -28,17 +29,30 @@ struct RootParameterInfo {
RootParameterInfo(dxbc::RootParameterHeader H, size_t L)
: Header(H), Location(L) {}
};
using DescriptorRanges = std::variant<dxbc::RST0::v0::DescriptorRange,
dxbc::RST0::v1::DescriptorRange>;
struct DescriptorTable {
SmallVector<DescriptorRanges> Ranges;

SmallVector<DescriptorRanges>::const_iterator begin() const {
return Ranges.begin();
}
SmallVector<DescriptorRanges>::const_iterator end() const {
return Ranges.end();
}
};

using RootDescriptor = std::variant<dxbc::RST0::v0::RootDescriptor,
dxbc::RST0::v1::RootDescriptor>;
using ParametersView = std::variant<const dxbc::RootConstants *,
const dxbc::RST0::v0::RootDescriptor *,
const dxbc::RST0::v1::RootDescriptor *>;

using ParametersView = std::variant<
const dxbc::RootConstants *, const dxbc::RST0::v0::RootDescriptor *,
const dxbc::RST0::v1::RootDescriptor *, const DescriptorTable *>;
struct RootParametersContainer {
SmallVector<RootParameterInfo> ParametersInfo;

SmallVector<dxbc::RootConstants> Constants;
SmallVector<RootDescriptor> Descriptors;
SmallVector<DescriptorTable> Tables;

void addInfo(dxbc::RootParameterHeader H, size_t L) {
ParametersInfo.push_back(RootParameterInfo(H, L));
Expand All @@ -61,20 +75,28 @@ struct RootParametersContainer {
Descriptors.push_back(D);
}

void addParameter(dxbc::RootParameterHeader H, DescriptorTable D) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
void addParameter(dxbc::RootParameterHeader H, DescriptorTable D) {
void addParameter(dxbc::RootParameterHeader Header, DescriptorTable Table) {

addInfo(H, Tables.size());
Tables.push_back(D);
}

std::optional<ParametersView> getParameter(const RootParameterInfo *H) const {
switch (H->Header.ParameterType) {
case llvm::to_underlying(dxbc::RootParameterType::Constants32Bit):
return &Constants[H->Location];
case llvm::to_underlying(dxbc::RootParameterType::CBV):
case llvm::to_underlying(dxbc::RootParameterType::SRV):
case llvm::to_underlying(dxbc::RootParameterType::UAV):
case llvm::to_underlying(dxbc::RootParameterType::UAV): {
const RootDescriptor &VersionedParam = Descriptors[H->Location];
if (std::holds_alternative<dxbc::RST0::v0::RootDescriptor>(
VersionedParam)) {
return &std::get<dxbc::RST0::v0::RootDescriptor>(VersionedParam);
}
return &std::get<dxbc::RST0::v1::RootDescriptor>(VersionedParam);
}
case llvm::to_underlying(dxbc::RootParameterType::DescriptorTable):
return &Tables[H->Location];
}

return std::nullopt;
}
Expand Down
98 changes: 98 additions & 0 deletions 98 llvm/include/llvm/ObjectYAML/DXContainerYAML.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
#ifndef LLVM_OBJECTYAML_DXCONTAINERYAML_H
#define LLVM_OBJECTYAML_DXCONTAINERYAML_H

#include "llvm/ADT/STLForwardCompat.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/BinaryFormat/DXContainer.h"
#include "llvm/Object/DXContainer.h"
Expand Down Expand Up @@ -91,6 +93,25 @@ struct RootDescriptorYaml {
#include "llvm/BinaryFormat/DXContainerConstants.def"
};

struct DescriptorRangeYaml {
uint32_t RangeType;
uint32_t NumDescriptors;
uint32_t BaseShaderRegister;
uint32_t RegisterSpace;
int32_t OffsetInDescriptorsFromTableStart;

uint32_t getEncodedFlags() const;

#define DESCRIPTOR_RANGE_FLAG(Num, Val) bool Val = false;
#include "llvm/BinaryFormat/DXContainerConstants.def"
};

struct DescriptorTableYaml {
uint32_t NumRanges;
uint32_t RangesOffset;
SmallVector<DescriptorRangeYaml> Ranges;
};

struct RootParameterYamlDesc {
uint32_t Type;
uint32_t Visibility;
Expand All @@ -107,12 +128,80 @@ struct RootParameterYamlDesc {
case llvm::to_underlying(dxbc::RootParameterType::UAV):
Descriptor = RootDescriptorYaml();
break;
case llvm::to_underlying(dxbc::RootParameterType::DescriptorTable):
Table = DescriptorTableYaml();
break;
}
}

~RootParameterYamlDesc() {
switch (Type) {

case llvm::to_underlying(dxbc::RootParameterType::Constants32Bit):
Constants.~RootConstantsYaml();
break;
case llvm::to_underlying(dxbc::RootParameterType::CBV):
case llvm::to_underlying(dxbc::RootParameterType::SRV):
case llvm::to_underlying(dxbc::RootParameterType::UAV):
Descriptor.~RootDescriptorYaml();
break;
case llvm::to_underlying(dxbc::RootParameterType::DescriptorTable):
Table.~DescriptorTableYaml();
break;
}
}

RootParameterYamlDesc(const RootParameterYamlDesc &Other)
: Type(Other.Type), Visibility(Other.Visibility), Offset(Other.Offset) {
// Initialize the appropriate union member based on Type
switch (Type) {
case llvm::to_underlying(dxbc::RootParameterType::Constants32Bit):
// Placement new to construct the union member
new (&Constants) RootConstantsYaml(Other.Constants);
break;
case llvm::to_underlying(dxbc::RootParameterType::CBV):
case llvm::to_underlying(dxbc::RootParameterType::SRV):
case llvm::to_underlying(dxbc::RootParameterType::UAV):
new (&Descriptor) RootDescriptorYaml(Other.Descriptor);
break;
case llvm::to_underlying(dxbc::RootParameterType::DescriptorTable):
new (&Table) DescriptorTableYaml(Other.Table);
break;
}
}

RootParameterYamlDesc &operator=(const RootParameterYamlDesc &other) {
if (this != &other) {
// First, destroy the current union member
this->~RootParameterYamlDesc();

// Copy the basic members
Type = other.Type;
Visibility = other.Visibility;
Offset = other.Offset;

// Initialize the new union member based on the Type from 'other'
switch (Type) {
case llvm::to_underlying(dxbc::RootParameterType::Constants32Bit):
new (&Constants) RootConstantsYaml(other.Constants);
break;
case llvm::to_underlying(dxbc::RootParameterType::CBV):
case llvm::to_underlying(dxbc::RootParameterType::SRV):
case llvm::to_underlying(dxbc::RootParameterType::UAV):
new (&Descriptor) RootDescriptorYaml(other.Descriptor);
break;
case llvm::to_underlying(dxbc::RootParameterType::DescriptorTable):
new (&Table) DescriptorTableYaml(other.Table);
break;
}
}
return *this;
}

union {
RootConstantsYaml Constants;
RootDescriptorYaml Descriptor;
DescriptorTableYaml Table;
};
};

Expand Down Expand Up @@ -244,6 +333,7 @@ LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DXContainerYAML::SignatureElement)
LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DXContainerYAML::PSVInfo::MaskVector)
LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DXContainerYAML::SignatureParameter)
LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DXContainerYAML::RootParameterYamlDesc)
LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DXContainerYAML::DescriptorRangeYaml)
LLVM_YAML_DECLARE_ENUM_TRAITS(llvm::dxbc::PSV::SemanticKind)
LLVM_YAML_DECLARE_ENUM_TRAITS(llvm::dxbc::PSV::ComponentType)
LLVM_YAML_DECLARE_ENUM_TRAITS(llvm::dxbc::PSV::InterpolationMode)
Expand Down Expand Up @@ -328,6 +418,14 @@ template <> struct MappingTraits<llvm::DXContainerYAML::RootDescriptorYaml> {
static void mapping(IO &IO, llvm::DXContainerYAML::RootDescriptorYaml &D);
};

template <> struct MappingTraits<llvm::DXContainerYAML::DescriptorTableYaml> {
static void mapping(IO &IO, llvm::DXContainerYAML::DescriptorTableYaml &D);
};

template <> struct MappingTraits<llvm::DXContainerYAML::DescriptorRangeYaml> {
static void mapping(IO &IO, llvm::DXContainerYAML::DescriptorRangeYaml &D);
};

} // namespace yaml

} // namespace llvm
Expand Down
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.