Skip to content

[HLSL] Refactor Offset calculation while writing Root Signatures. #128577

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.

Sign up for GitHub

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 12 commits into from
Feb 26, 2025
Merged

[HLSL] Refactor Offset calculation while writing Root Signatures. #128577

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
767b7d0
first working version
Feb 22, 2025
d391727
moving the offset logic to it's own class
Feb 24, 2025
68c7513
refactoring to remove use of map and string
Feb 24, 2025
23069ab
addressing comments
Feb 25, 2025
d14471b
using buffer_ostream
Feb 25, 2025
216341c
remove getsize
Feb 25, 2025
85f012c
clean up
Feb 25, 2025
1e2bcf5
clean up
Feb 25, 2025
0e277d9
clean up
Feb 25, 2025
5cd0044
clean up
Feb 25, 2025
7a7c34d
addressing pr comments
Feb 25, 2025
d3fafab
clean up
Feb 25, 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
63 changes: 38 additions & 25 deletions llvm/lib/MC/DXContainerRootSignature.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,48 +8,61 @@

#include "llvm/MC/DXContainerRootSignature.h"
#include "llvm/Support/EndianStream.h"
#include <cstdint>

using namespace llvm;
using namespace llvm::mcdxbc;

static uint32_t writePlaceholder(raw_ostream &Stream) {
const uint32_t DummyValue = std::numeric_limits<uint32_t>::max();
uint32_t Offset = Stream.tell();
support::endian::write(Stream, DummyValue, llvm::endianness::little);
return Offset;
}

static void rewriteOffset(buffer_ostream &Stream, uint32_t Offset) {
uint32_t Value =
support::endian::byte_swap<uint32_t, llvm::endianness::little>(
Stream.tell());
Stream.pwrite(reinterpret_cast<const char *>(&Value), sizeof(Value), Offset);
}

void RootSignatureDesc::write(raw_ostream &OS) const {
// Root signature header in dxcontainer has 6 uint_32t values.
const uint32_t HeaderSize = 24;
const uint32_t ParameterByteSize = Parameters.size_in_bytes();
const uint32_t NumParametes = Parameters.size();
buffer_ostream BOS(OS);
const uint32_t NumParameters = Parameters.size();
const uint32_t Zero = 0;

// Writing header information
support::endian::write(OS, Header.Version, llvm::endianness::little);
support::endian::write(OS, NumParametes, llvm::endianness::little);
support::endian::write(OS, HeaderSize, llvm::endianness::little);
support::endian::write(BOS, Header.Version, llvm::endianness::little);
support::endian::write(BOS, NumParameters, llvm::endianness::little);

uint32_t HeaderPoint = writePlaceholder(BOS);

// Static samplers still not implemented
support::endian::write(OS, Zero, llvm::endianness::little);
support::endian::write(OS, ParameterByteSize + HeaderSize,
llvm::endianness::little);
support::endian::write(BOS, Zero, llvm::endianness::little);
support::endian::write(BOS, Zero, llvm::endianness::little);
support::endian::write(BOS, Header.Flags, llvm::endianness::little);

support::endian::write(OS, Header.Flags, llvm::endianness::little);
rewriteOffset(BOS, HeaderPoint);

uint32_t ParamsOffset =
HeaderSize + (3 * sizeof(uint32_t) * Parameters.size());
for (const dxbc::RootParameter &P : Parameters) {
support::endian::write(OS, P.ParameterType, llvm::endianness::little);
support::endian::write(OS, P.ShaderVisibility, llvm::endianness::little);
support::endian::write(OS, ParamsOffset, llvm::endianness::little);
SmallVector<uint32_t> ParamsOffsets;
for (const auto &P : Parameters) {
support::endian::write(BOS, P.ParameterType, llvm::endianness::little);
support::endian::write(BOS, P.ShaderVisibility, llvm::endianness::little);

// Size of root parameter, removing the ParameterType and ShaderVisibility.
ParamsOffset += sizeof(dxbc::RootParameter) - 2 * sizeof(uint32_t);
ParamsOffsets.push_back(writePlaceholder(BOS));
}

for (const dxbc::RootParameter &P : Parameters) {
assert(NumParameters == ParamsOffsets.size());
for (size_t I = 0; I < NumParameters; ++I) {
rewriteOffset(BOS, ParamsOffsets[I]);
const auto &P = Parameters[I];

switch (P.ParameterType) {
case dxbc::RootParameterType::Constants32Bit: {
support::endian::write(OS, P.Constants.ShaderRegister,
support::endian::write(BOS, P.Constants.ShaderRegister,
llvm::endianness::little);
support::endian::write(OS, P.Constants.RegisterSpace,
support::endian::write(BOS, P.Constants.RegisterSpace,
llvm::endianness::little);
support::endian::write(OS, P.Constants.Num32BitValues,
support::endian::write(BOS, P.Constants.Num32BitValues,
llvm::endianness::little);
} break;
case dxbc::RootParameterType::Empty:
Expand Down
10 changes: 6 additions & 4 deletions llvm/lib/Object/DXContainer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,16 +296,18 @@ Error DirectX::RootSignature::parse(StringRef Data) {
NewParam.ParameterType =
support::endian::read<dxbc::RootParameterType,
llvm::endianness::little>(Current);
if (!dxbc::RootSignatureValidations::isValidParameterType(NewParam.ParameterType))
if (!dxbc::RootSignatureValidations::isValidParameterType(
NewParam.ParameterType))
return validationFailed("unsupported parameter type value read: " +
llvm::Twine((uint32_t)NewParam.ParameterType));

Current += sizeof(dxbc::RootParameterType);

NewParam.ShaderVisibility =
support::endian::read<dxbc::ShaderVisibility,
llvm::endianness::little>(Current);
if (!dxbc::RootSignatureValidations::isValidShaderVisibility(NewParam.ShaderVisibility))
support::endian::read<dxbc::ShaderVisibility, llvm::endianness::little>(
Current);
if (!dxbc::RootSignatureValidations::isValidShaderVisibility(
NewParam.ShaderVisibility))
return validationFailed("unsupported shader visility flag value read: " +
llvm::Twine((uint32_t)NewParam.ShaderVisibility));

Expand Down
2 changes: 1 addition & 1 deletion llvm/test/CodeGen/DirectX/ContainerData/RootSignature-Flags.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ attributes #0 = { "hlsl.numthreads"="1,1,1" "hlsl.shader"="compute" }
; DXC-NEXT: RootSignature:
; DXC-NEXT: Version: 2
; DXC-NEXT: NumStaticSamplers: 0
; DXC-NEXT: StaticSamplersOffset: 24
; DXC-NEXT: StaticSamplersOffset: 0
; DXC-NEXT: Parameters: []
; DXC-NEXT: AllowInputAssemblerInputLayout: true
2 changes: 1 addition & 1 deletion llvm/test/ObjectYAML/DXContainer/RootSignature-Flags.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Parts:
# CHECK-NEXT: RootSignature:
# CHECK-NEXT: Version: 2
# CHECK-NEXT: NumStaticSamplers: 0
# CHECK-NEXT: StaticSamplersOffset: 24
# CHECK-NEXT: StaticSamplersOffset: 0
# CHECK-NEXT: Parameters: []
# CHECK-NEXT: AllowInputAssemblerInputLayout: true
# CHECK-NEXT: DenyGeometryShaderRootAccess: true
2 changes: 1 addition & 1 deletion llvm/test/ObjectYAML/DXContainer/RootSignature-MultipleParameters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Parts:
# CHECK-NEXT: RootSignature:
# CHECK-NEXT: Version: 2
# CHECK-NEXT: NumStaticSamplers: 0
# CHECK-NEXT: StaticSamplersOffset: 64
# CHECK-NEXT: StaticSamplersOffset: 0
# CHECK-NEXT: Parameters:
# CHECK-NEXT: - ParameterType: Constants32Bit
# CHECK-NEXT: ShaderVisibility: Hull
Expand Down
8 changes: 4 additions & 4 deletions llvm/unittests/ObjectYAML/DXContainerYAMLTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,12 @@ TEST(RootSignature, ParseRootFlags) {
)"));

uint8_t Buffer[] = {
0x44, 0x58, 0x42, 0x43, 0x32, 0x9A, 0x53, 0xD8, 0xEC, 0xBE, 0x35, 0x6F,
0x05, 0x39, 0xE1, 0xFE, 0x31, 0x20, 0xF0, 0xC1, 0x01, 0x00, 0x00, 0x00,
0x44, 0x58, 0x42, 0x43, 0x32, 0x9a, 0x53, 0xd8, 0xec, 0xbe, 0x35, 0x6f,
0x05, 0x39, 0xe1, 0xfe, 0x31, 0x20, 0xf0, 0xc1, 0x01, 0x00, 0x00, 0x00,
0x44, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x24, 0x00, 0x00, 0x00,
0x52, 0x54, 0x53, 0x30, 0x18, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x18, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x18, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
};

EXPECT_EQ(Storage.size(), 68u);
Expand Down Expand Up @@ -184,7 +184,7 @@ TEST(RootSignature, ParseRootConstants) {
0x85, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x24, 0x00, 0x00, 0x00,
0x52, 0x54, 0x53, 0x30, 0x59, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00,
0x01, 0x00, 0x00, 0x00, 0x18, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x2c, 0x00, 0x00, 0x00, 0x11, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x11, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
0x02, 0x00, 0x00, 0x00, 0x24, 0x00, 0x00, 0x00, 0x0f, 0x00, 0x00, 0x00,
0x0e, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
Expand Down
Loading