Author: Finn Plummer Date: 2025-05-30T13:24:01-07:00 New Revision: 9bd63b1dc79d40945664daf3a462da099f9b2870
URL: https://github.com/llvm/llvm-project/commit/9bd63b1dc79d40945664daf3a462da099f9b2870 DIFF: https://github.com/llvm/llvm-project/commit/9bd63b1dc79d40945664daf3a462da099f9b2870.diff LOG: [HLSL][RootSignature] Add parsing of remaining enums to StaticSampler (#140305) - defines in-memory reprsentation of `comparisonFunc` and `borderColor` - defines parsing of the `ComparisonFunc` and `StaticBorderColor` enum - integrates parsing of these number parameters with their respective `parseComparisonFunc` and `parseStaticBorderColor` - adds basic unit tests to demonstrate setting functionality Part 6 of https://github.com/llvm/llvm-project/issues/126574 Added: Modified: clang/include/clang/Lex/HLSLRootSignatureTokenKinds.def clang/include/clang/Parse/ParseHLSLRootSignature.h clang/lib/Parse/ParseHLSLRootSignature.cpp clang/unittests/Lex/LexHLSLRootSignatureTest.cpp clang/unittests/Parse/ParseHLSLRootSignatureTest.cpp llvm/include/llvm/Frontend/HLSL/HLSLRootSignature.h Removed: ################################################################################ diff --git a/clang/include/clang/Lex/HLSLRootSignatureTokenKinds.def b/clang/include/clang/Lex/HLSLRootSignatureTokenKinds.def index 9b47ec57f541b..1814ac4aeae5f 100644 --- a/clang/include/clang/Lex/HLSLRootSignatureTokenKinds.def +++ b/clang/include/clang/Lex/HLSLRootSignatureTokenKinds.def @@ -56,6 +56,12 @@ #ifndef TEXTURE_ADDRESS_MODE_ENUM #define TEXTURE_ADDRESS_MODE_ENUM(NAME, LIT) ENUM(NAME, LIT) #endif +#ifndef COMPARISON_FUNC_ENUM +#define COMPARISON_FUNC_ENUM(NAME, LIT) ENUM(NAME, LIT) +#endif +#ifndef STATIC_BORDER_COLOR_ENUM +#define STATIC_BORDER_COLOR_ENUM(NAME, LIT) ENUM(NAME, LIT) +#endif // General Tokens: TOK(invalid, "invalid identifier") @@ -109,6 +115,8 @@ KEYWORD(addressU) KEYWORD(addressV) KEYWORD(addressW) KEYWORD(maxAnisotropy) +KEYWORD(comparisonFunc) +KEYWORD(borderColor) KEYWORD(minLOD) KEYWORD(maxLOD) @@ -161,6 +169,25 @@ TEXTURE_ADDRESS_MODE_ENUM(Clamp, "TEXTURE_ADDRESS_CLAMP") TEXTURE_ADDRESS_MODE_ENUM(Border, "TEXTURE_ADDRESS_BORDER") TEXTURE_ADDRESS_MODE_ENUM(MirrorOnce, "TEXTURE_ADDRESS_MIRRORONCE") +// Comparison Func Enums: +COMPARISON_FUNC_ENUM(Never, "COMPARISON_NEVER") +COMPARISON_FUNC_ENUM(Less, "COMPARISON_LESS") +COMPARISON_FUNC_ENUM(Equal, "COMPARISON_EQUAL") +COMPARISON_FUNC_ENUM(LessEqual, "COMPARISON_LESS_EQUAL") +COMPARISON_FUNC_ENUM(Greater, "COMPARISON_GREATER") +COMPARISON_FUNC_ENUM(NotEqual, "COMPARISON_NOT_EQUAL") +COMPARISON_FUNC_ENUM(GreaterEqual, "COMPARISON_GREATER_EQUAL") +COMPARISON_FUNC_ENUM(Always, "COMPARISON_ALWAYS") + +// Static Border Color Enums: +STATIC_BORDER_COLOR_ENUM(TransparentBlack, "STATIC_BORDER_COLOR_TRANSPARENT_BLACK") +STATIC_BORDER_COLOR_ENUM(OpaqueBlack, "STATIC_BORDER_COLOR_OPAQUE_BLACK") +STATIC_BORDER_COLOR_ENUM(OpaqueWhite, "STATIC_BORDER_COLOR_OPAQUE_WHITE") +STATIC_BORDER_COLOR_ENUM(OpaqueBlackUint, "STATIC_BORDER_COLOR_OPAQUE_BLACK_UINT") +STATIC_BORDER_COLOR_ENUM(OpaqueWhiteUint, "STATIC_BORDER_COLOR_OPAQUE_WHITE_UINT") + +#undef STATIC_BORDER_COLOR_ENUM +#undef COMPARISON_FUNC_ENUM #undef TEXTURE_ADDRESS_MODE_ENUM #undef SHADER_VISIBILITY_ENUM #undef DESCRIPTOR_RANGE_FLAG_ENUM diff --git a/clang/include/clang/Parse/ParseHLSLRootSignature.h b/clang/include/clang/Parse/ParseHLSLRootSignature.h index d436265b8b37a..8052df1c568dd 100644 --- a/clang/include/clang/Parse/ParseHLSLRootSignature.h +++ b/clang/include/clang/Parse/ParseHLSLRootSignature.h @@ -116,6 +116,8 @@ class RootSignatureParser { std::optional<llvm::hlsl::rootsig::TextureAddressMode> AddressV; std::optional<llvm::hlsl::rootsig::TextureAddressMode> AddressW; std::optional<uint32_t> MaxAnisotropy; + std::optional<llvm::hlsl::rootsig::ComparisonFunc> CompFunc; + std::optional<llvm::hlsl::rootsig::StaticBorderColor> BorderColor; std::optional<float> MinLOD; std::optional<float> MaxLOD; }; @@ -130,6 +132,9 @@ class RootSignatureParser { std::optional<llvm::hlsl::rootsig::ShaderVisibility> parseShaderVisibility(); std::optional<llvm::hlsl::rootsig::TextureAddressMode> parseTextureAddressMode(); + std::optional<llvm::hlsl::rootsig::ComparisonFunc> parseComparisonFunc(); + std::optional<llvm::hlsl::rootsig::StaticBorderColor> + parseStaticBorderColor(); std::optional<llvm::hlsl::rootsig::RootDescriptorFlags> parseRootDescriptorFlags(); std::optional<llvm::hlsl::rootsig::DescriptorRangeFlags> diff --git a/clang/lib/Parse/ParseHLSLRootSignature.cpp b/clang/lib/Parse/ParseHLSLRootSignature.cpp index e9373f9a82beb..eb0ebee2e6ce9 100644 --- a/clang/lib/Parse/ParseHLSLRootSignature.cpp +++ b/clang/lib/Parse/ParseHLSLRootSignature.cpp @@ -392,6 +392,12 @@ std::optional<StaticSampler> RootSignatureParser::parseStaticSampler() { if (Params->MaxAnisotropy.has_value()) Sampler.MaxAnisotropy = Params->MaxAnisotropy.value(); + if (Params->CompFunc.has_value()) + Sampler.CompFunc = Params->CompFunc.value(); + + if (Params->BorderColor.has_value()) + Sampler.BorderColor = Params->BorderColor.value(); + if (Params->MinLOD.has_value()) Sampler.MinLOD = Params->MinLOD.value(); @@ -769,6 +775,40 @@ RootSignatureParser::parseStaticSamplerParams() { Params.MaxAnisotropy = MaxAnisotropy; } + // `comparisonFunc` `=` COMPARISON_FUNC + if (tryConsumeExpectedToken(TokenKind::kw_comparisonFunc)) { + if (Params.CompFunc.has_value()) { + getDiags().Report(CurToken.TokLoc, diag::err_hlsl_rootsig_repeat_param) + << CurToken.TokKind; + return std::nullopt; + } + + if (consumeExpectedToken(TokenKind::pu_equal)) + return std::nullopt; + + auto CompFunc = parseComparisonFunc(); + if (!CompFunc.has_value()) + return std::nullopt; + Params.CompFunc = CompFunc; + } + + // `borderColor` `=` STATIC_BORDER_COLOR + if (tryConsumeExpectedToken(TokenKind::kw_borderColor)) { + if (Params.BorderColor.has_value()) { + getDiags().Report(CurToken.TokLoc, diag::err_hlsl_rootsig_repeat_param) + << CurToken.TokKind; + return std::nullopt; + } + + if (consumeExpectedToken(TokenKind::pu_equal)) + return std::nullopt; + + auto BorderColor = parseStaticBorderColor(); + if (!BorderColor.has_value()) + return std::nullopt; + Params.BorderColor = BorderColor; + } + // `minLOD` `=` NUMBER if (tryConsumeExpectedToken(TokenKind::kw_minLOD)) { if (Params.MinLOD.has_value()) { @@ -935,6 +975,58 @@ RootSignatureParser::parseTextureAddressMode() { return std::nullopt; } +std::optional<llvm::hlsl::rootsig::ComparisonFunc> +RootSignatureParser::parseComparisonFunc() { + assert(CurToken.TokKind == TokenKind::pu_equal && + "Expects to only be invoked starting at given keyword"); + + TokenKind Expected[] = { +#define COMPARISON_FUNC_ENUM(NAME, LIT) TokenKind::en_##NAME, +#include "clang/Lex/HLSLRootSignatureTokenKinds.def" + }; + + if (!tryConsumeExpectedToken(Expected)) + return std::nullopt; + + switch (CurToken.TokKind) { +#define COMPARISON_FUNC_ENUM(NAME, LIT) \ + case TokenKind::en_##NAME: \ + return ComparisonFunc::NAME; \ + break; +#include "clang/Lex/HLSLRootSignatureTokenKinds.def" + default: + llvm_unreachable("Switch for consumed enum token was not provided"); + } + + return std::nullopt; +} + +std::optional<llvm::hlsl::rootsig::StaticBorderColor> +RootSignatureParser::parseStaticBorderColor() { + assert(CurToken.TokKind == TokenKind::pu_equal && + "Expects to only be invoked starting at given keyword"); + + TokenKind Expected[] = { +#define STATIC_BORDER_COLOR_ENUM(NAME, LIT) TokenKind::en_##NAME, +#include "clang/Lex/HLSLRootSignatureTokenKinds.def" + }; + + if (!tryConsumeExpectedToken(Expected)) + return std::nullopt; + + switch (CurToken.TokKind) { +#define STATIC_BORDER_COLOR_ENUM(NAME, LIT) \ + case TokenKind::en_##NAME: \ + return StaticBorderColor::NAME; \ + break; +#include "clang/Lex/HLSLRootSignatureTokenKinds.def" + default: + llvm_unreachable("Switch for consumed enum token was not provided"); + } + + return std::nullopt; +} + std::optional<llvm::hlsl::rootsig::RootDescriptorFlags> RootSignatureParser::parseRootDescriptorFlags() { assert(CurToken.TokKind == TokenKind::pu_equal && diff --git a/clang/unittests/Lex/LexHLSLRootSignatureTest.cpp b/clang/unittests/Lex/LexHLSLRootSignatureTest.cpp index f0f22ccc29e9f..943a31a08604c 100644 --- a/clang/unittests/Lex/LexHLSLRootSignatureTest.cpp +++ b/clang/unittests/Lex/LexHLSLRootSignatureTest.cpp @@ -137,7 +137,8 @@ TEST_F(LexHLSLRootSignatureTest, ValidLexAllTokensTest) { numDescriptors offset mipLODBias addressU addressV addressW - maxAnisotropy minLOD maxLOD + maxAnisotropy comparisonFunc borderColor + minLOD maxLOD unbounded DESCRIPTOR_RANGE_OFFSET_APPEND @@ -175,6 +176,21 @@ TEST_F(LexHLSLRootSignatureTest, ValidLexAllTokensTest) { TEXTURE_ADDRESS_CLAMP TEXTURE_ADDRESS_BORDER TEXTURE_ADDRESS_MIRRORONCE + + comparison_never + comparison_less + comparison_equal + comparison_less_equal + comparison_greater + comparison_not_equal + comparison_greater_equal + comparison_always + + STATIC_BORDER_COLOR_TRANSPARENT_BLACK + STATIC_BORDER_COLOR_OPAQUE_BLACK + STATIC_BORDER_COLOR_OPAQUE_WHITE + STATIC_BORDER_COLOR_OPAQUE_BLACK_UINT + STATIC_BORDER_COLOR_OPAQUE_WHITE_UINT )cc"; auto TokLoc = SourceLocation(); hlsl::RootSignatureLexer Lexer(Source, TokLoc); diff --git a/clang/unittests/Parse/ParseHLSLRootSignatureTest.cpp b/clang/unittests/Parse/ParseHLSLRootSignatureTest.cpp index 6477b25550c4d..5330355596356 100644 --- a/clang/unittests/Parse/ParseHLSLRootSignatureTest.cpp +++ b/clang/unittests/Parse/ParseHLSLRootSignatureTest.cpp @@ -230,7 +230,9 @@ TEST_F(ParseHLSLRootSignatureTest, ValidParseStaticSamplerTest) { minLOD = 4.2f, mipLODBias = 0.23e+3, addressW = TEXTURE_ADDRESS_CLAMP, addressV = TEXTURE_ADDRESS_BORDER, - maxLOD = 9000, addressU = TEXTURE_ADDRESS_MIRROR + maxLOD = 9000, addressU = TEXTURE_ADDRESS_MIRROR, + comparisonFunc = COMPARISON_NOT_EQUAL, + borderColor = STATIC_BORDER_COLOR_OPAQUE_BLACK_UINT ) )cc"; @@ -259,6 +261,9 @@ TEST_F(ParseHLSLRootSignatureTest, ValidParseStaticSamplerTest) { ASSERT_EQ(std::get<StaticSampler>(Elem).AddressW, TextureAddressMode::Wrap); ASSERT_FLOAT_EQ(std::get<StaticSampler>(Elem).MipLODBias, 0.f); ASSERT_EQ(std::get<StaticSampler>(Elem).MaxAnisotropy, 16u); + ASSERT_EQ(std::get<StaticSampler>(Elem).CompFunc, ComparisonFunc::LessEqual); + ASSERT_EQ(std::get<StaticSampler>(Elem).BorderColor, + StaticBorderColor::OpaqueWhite); ASSERT_FLOAT_EQ(std::get<StaticSampler>(Elem).MinLOD, 0.f); ASSERT_FLOAT_EQ(std::get<StaticSampler>(Elem).MaxLOD, 3.402823466e+38f); @@ -272,6 +277,9 @@ TEST_F(ParseHLSLRootSignatureTest, ValidParseStaticSamplerTest) { ASSERT_EQ(std::get<StaticSampler>(Elem).AddressW, TextureAddressMode::Clamp); ASSERT_FLOAT_EQ(std::get<StaticSampler>(Elem).MipLODBias, 230.f); ASSERT_EQ(std::get<StaticSampler>(Elem).MaxAnisotropy, 3u); + ASSERT_EQ(std::get<StaticSampler>(Elem).CompFunc, ComparisonFunc::NotEqual); + ASSERT_EQ(std::get<StaticSampler>(Elem).BorderColor, + StaticBorderColor::OpaqueBlackUint); ASSERT_FLOAT_EQ(std::get<StaticSampler>(Elem).MinLOD, 4.2f); ASSERT_FLOAT_EQ(std::get<StaticSampler>(Elem).MaxLOD, 9000.f); diff --git a/llvm/include/llvm/Frontend/HLSL/HLSLRootSignature.h b/llvm/include/llvm/Frontend/HLSL/HLSLRootSignature.h index bb0a0d158a980..7c8ddef4144e6 100644 --- a/llvm/include/llvm/Frontend/HLSL/HLSLRootSignature.h +++ b/llvm/include/llvm/Frontend/HLSL/HLSLRootSignature.h @@ -84,6 +84,25 @@ enum class TextureAddressMode { MirrorOnce = 5 }; +enum class ComparisonFunc : unsigned { + Never = 1, + Less = 2, + Equal = 3, + LessEqual = 4, + Greater = 5, + NotEqual = 6, + GreaterEqual = 7, + Always = 8 +}; + +enum class StaticBorderColor { + TransparentBlack = 0, + OpaqueBlack = 1, + OpaqueWhite = 2, + OpaqueBlackUint = 3, + OpaqueWhiteUint = 4 +}; + // Definitions of the in-memory data layout structures // Models the diff erent registers: bReg | tReg | uReg | sReg @@ -170,6 +189,8 @@ struct StaticSampler { TextureAddressMode AddressW = TextureAddressMode::Wrap; float MipLODBias = 0.f; uint32_t MaxAnisotropy = 16; + ComparisonFunc CompFunc = ComparisonFunc::LessEqual; + StaticBorderColor BorderColor = StaticBorderColor::OpaqueWhite; float MinLOD = 0.f; float MaxLOD = std::numeric_limits<float>::max(); }; _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits