-
Notifications
You must be signed in to change notification settings - Fork 14.3k
[HLSL] Adding support for root descriptors in root signature metadata representation #139781
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
Changes from 1 commit
Commits
Show all changes
38 commits
Select commit
Hold shift + click to select a range
0abacfc
adding support for Root Descriptors
8b8c02a
clean up
7ac9641
addressing comments
c105458
formating
efe76aa
try fix test
a928e9d
addressing comments
a38f10b
refactoring mcdxbc struct to store root parameters out of order
9a7c359
changing name
d6c2b55
changing variant to host pointers
93e4cf2
clean up
b45b1b6
fix
f804a23
fix
15eb6f5
fix naming
b9d7f07
fix naming
46cc8c1
addressing comments
1b3e10a
addressing comments
1f31957
addressing comments
e8fbfce
clean up
a31e5a5
removing v parameter
a394ad0
Merge branch 'obj2yaml/root-descriptors' into refactoring/remove-union
ad415a7
clean up
8ff4845
Merge branch 'main' into refactoring/remove-union
f875555
adding support for root descriptors
4f7f998
removing none as a flag option
3eb5e10
adding tests
58e1789
clean up and add more tests
81915ad
addressing comments
a515e28
Merge branch 'main' into metadata/root-descriptors
0d54162
clean
7f70dc5
cleanup
0c570c8
adding requested comment
d1ca37d
addressing PR comments
cb0780b
formating
eeffded
addressing PR comments
3cbe0cf
formating
92b766b
formating
8732594
adding test
fdb8b98
clean up
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
adding tests
- Loading branch information
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,6 +12,7 @@ | |
//===----------------------------------------------------------------------===// | ||
#include "DXILRootSignature.h" | ||
#include "DirectX.h" | ||
#include "llvm/ADT/STLForwardCompat.h" | ||
#include "llvm/ADT/StringSwitch.h" | ||
#include "llvm/ADT/Twine.h" | ||
#include "llvm/Analysis/DXILMetadataAnalysis.h" | ||
|
@@ -30,6 +31,7 @@ | |
#include <cstdint> | ||
#include <optional> | ||
#include <utility> | ||
#include <variant> | ||
|
||
using namespace llvm; | ||
using namespace llvm::dxil; | ||
|
@@ -217,6 +219,19 @@ static bool verifyVersion(uint32_t Version) { | |
return (Version == 1 || Version == 2); | ||
} | ||
|
||
static bool verifyRegisterValue(uint32_t RegisterValue) { | ||
return !(RegisterValue == 0xFFFFFFFF); | ||
} | ||
|
||
static bool verifyRegisterSpace(uint32_t RegisterSpace) { | ||
return !(RegisterSpace >= 0xFFFFFFF0 && RegisterSpace <= 0xFFFFFFFF); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you add a comment about what the condition we're checking here is? Why are specifically the largest 16 values of a uint32 invalid? |
||
} | ||
|
||
static bool verifyDescriptorFlag(uint32_t Flags) { | ||
return (Flags & ~0xE) == 0; | ||
} | ||
|
||
|
||
static bool validate(LLVMContext *Ctx, const mcdxbc::RootSignatureDesc &RSD) { | ||
|
||
if (!verifyVersion(RSD.Version)) { | ||
|
@@ -234,6 +249,38 @@ static bool validate(LLVMContext *Ctx, const mcdxbc::RootSignatureDesc &RSD) { | |
|
||
assert(dxbc::isValidParameterType(Info.Header.ParameterType) && | ||
"Invalid value for ParameterType"); | ||
|
||
|
||
auto P = RSD.ParametersContainer.getParameter(&Info); | ||
if(!P) | ||
return reportError(Ctx, "Cannot locate parameter from Header Info"); | ||
|
||
if( std::holds_alternative<const dxbc::RTS0::v1::RootDescriptor *>(*P)){ | ||
auto *Descriptor = std::get<const dxbc::RTS0::v1::RootDescriptor *>(P.value()); | ||
|
||
if(!verifyRegisterValue(Descriptor->ShaderRegister)) | ||
return reportValueError(Ctx, "ShaderRegister", | ||
Descriptor->ShaderRegister); | ||
|
||
if(!verifyRegisterSpace(Descriptor->RegisterSpace)) | ||
return reportValueError(Ctx, "RegisterSpace", | ||
Descriptor->RegisterSpace); | ||
|
||
} else if( std::holds_alternative<const dxbc::RTS0::v2::RootDescriptor *>(*P)){ | ||
auto *Descriptor = std::get<const dxbc::RTS0::v2::RootDescriptor *>(P.value()); | ||
|
||
if(!verifyRegisterValue(Descriptor->ShaderRegister)) | ||
return reportValueError(Ctx, "ShaderRegister", | ||
Descriptor->ShaderRegister); | ||
|
||
if(!verifyRegisterSpace(Descriptor->RegisterSpace)) | ||
return reportValueError(Ctx, "RegisterSpace", | ||
Descriptor->RegisterSpace); | ||
|
||
if(!verifyDescriptorFlag(Descriptor->Flags)) | ||
return reportValueError(Ctx, "DescriptorFlag", | ||
Descriptor->Flags); | ||
} | ||
} | ||
|
||
return false; | ||
|
@@ -370,6 +417,20 @@ PreservedAnalyses RootSignatureAnalysisPrinter::run(Module &M, | |
<< "Shader Register: " << Constants->ShaderRegister << "\n"; | ||
OS << indent(Space + 2) | ||
<< "Num 32 Bit Values: " << Constants->Num32BitValues << "\n"; | ||
} else if (std::holds_alternative<const dxbc::RTS0::v1::RootDescriptor *>(*P)) { | ||
auto *Constants = std::get<const dxbc::RTS0::v1::RootDescriptor *>(*P); | ||
OS << indent(Space + 2) | ||
<< "Register Space: " << Constants->RegisterSpace << "\n"; | ||
OS << indent(Space + 2) | ||
<< "Shader Register: " << Constants->ShaderRegister << "\n"; | ||
} else if (std::holds_alternative<const dxbc::RTS0::v2::RootDescriptor *>(*P)) { | ||
auto *Constants = std::get<const dxbc::RTS0::v2::RootDescriptor *>(*P); | ||
OS << indent(Space + 2) | ||
<< "Register Space: " << Constants->RegisterSpace << "\n"; | ||
OS << indent(Space + 2) | ||
<< "Shader Register: " << Constants->ShaderRegister << "\n"; | ||
OS << indent(Space + 2) | ||
<< "Flags: " << Constants->Flags << "\n"; | ||
} | ||
} | ||
Space--; | ||
|
18 changes: 18 additions & 0 deletions
18
llvm/test/CodeGen/DirectX/ContainerData/RootSignature-RootDescriptor-Invalid-Flags.ll
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
; 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 value for DescriptorFlag: 3 | ||
; 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 } ; function, root signature | ||
!3 = !{ !5 } ; list of root signature elements | ||
!5 = !{ !"RootCBV", i32 0, i32 1, i32 2, i32 3 } |
18 changes: 18 additions & 0 deletions
18
.../test/CodeGen/DirectX/ContainerData/RootSignature-RootDescriptor-Invalid-RegisterSpace.ll
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
; 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 value for RegisterSpace: 4294967280 | ||
; 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 } ; function, root signature | ||
!3 = !{ !5 } ; list of root signature elements | ||
!5 = !{ !"RootCBV", i32 0, i32 1, i32 4294967280, i32 0 } |
18 changes: 18 additions & 0 deletions
18
.../test/CodeGen/DirectX/ContainerData/RootSignature-RootDescriptor-Invalid-RegisterValue.ll
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
; 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 value for ShaderRegister: 4294967295 | ||
; 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 } ; function, root signature | ||
!3 = !{ !5 } ; list of root signature elements | ||
!5 = !{ !"RootCBV", i32 0, i32 4294967295, i32 2, i32 3 } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clearer to use
std::numeric_limits
or~0U
here. Also!(x == y)
is harder to understand thanx != y