Skip to content

Commit 900c99b

Browse files
committed
[SPIRV][HLSL] Add DXC compatibility option for extension
The default behaviour in DXC is to allow all extesions the compiler knows about. We did the same in clang: all extensions that clang knows about. However, this causes the shader to use different extensions because the two compilers have different sets of extensions. To avoid using a new extension when moving from DXC to Clang, we add the special DXC suboptions to `-fspv-extension". If `-fspv-extension=DXC` is used, then the available extensions will be those available in DXC.
1 parent 8e9a0fc commit 900c99b

File tree

4 files changed

+116
-8
lines changed

4 files changed

+116
-8
lines changed

clang/include/clang/Driver/Options.td

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9428,8 +9428,12 @@ def fspv_target_env_EQ : Joined<["-"], "fspv-target-env=">, Group<dxc_Group>,
94289428
def fspv_extension_EQ
94299429
: Joined<["-"], "fspv-extension=">,
94309430
Group<dxc_Group>,
9431-
HelpText<"Specify the available SPIR-V extensions. If this option is not "
9432-
"specified, then all extensions are available.">;
9431+
HelpText<
9432+
"Specify the available SPIR-V extensions. If this option is not "
9433+
"specified, then all extensions are available. If KHR is specified, "
9434+
"then all KHR extensions will be available. If DXC is specified, "
9435+
"then all extensions implemented by the DirectXShader compiler will "
9436+
"be available. This option is useful for moving from DXC to Clang.">;
94339437
def fvk_use_dx_layout
94349438
: DXCFlag<"fvk-use-dx-layout">,
94359439
HelpText<"Use DirectX memory layout for Vulkan resources.">;

clang/lib/Driver/ToolChains/HLSL.cpp

Lines changed: 60 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -173,24 +173,78 @@ bool isLegalValidatorVersion(StringRef ValVersionStr, const Driver &D) {
173173
return true;
174174
}
175175

176+
std::string getSpirvExtOperand(llvm::StringRef SpvExtensionArg) {
177+
// The extensions that are commented out are supported in DXC, but the SPIR-V
178+
// backend does not know about them yet.
179+
static const std::vector<std::string> DxcSupportedExtensions = {
180+
"SPV_KHR_16bit_storage",
181+
"SPV_KHR_device_group",
182+
"SPV_KHR_fragment_shading_rate",
183+
"SPV_KHR_multiview",
184+
"SPV_KHR_post_depth_coverage",
185+
"SPV_KHR_non_semantic_info",
186+
"SPV_KHR_shader_draw_parameters",
187+
"SPV_KHR_ray_tracing",
188+
"SPV_KHR_shader_clock",
189+
"SPV_EXT_demote_to_helper_invocation",
190+
"SPV_EXT_descriptor_indexing",
191+
"SPV_EXT_fragment_fully_covered",
192+
"SPV_EXT_fragment_invocation_density",
193+
"SPV_EXT_fragment_shader_interlock",
194+
"SPV_EXT_mesh_shader",
195+
"SPV_EXT_shader_stencil_export",
196+
"SPV_EXT_shader_viewport_index_layer",
197+
// "SPV_AMD_shader_early_and_late_fragment_tests",
198+
"SPV_GOOGLE_hlsl_functionality1",
199+
"SPV_GOOGLE_user_type",
200+
"SPV_KHR_ray_query",
201+
"SPV_EXT_shader_image_int64",
202+
"SPV_KHR_fragment_shader_barycentric",
203+
"SPV_KHR_physical_storage_buffer",
204+
"SPV_KHR_vulkan_memory_model",
205+
// "SPV_KHR_compute_shader_derivatives",
206+
// "SPV_KHR_maximal_reconvergence",
207+
"SPV_KHR_float_controls",
208+
"SPV_NV_shader_subgroup_partitioned",
209+
// "SPV_KHR_quad_control"
210+
};
211+
212+
if (SpvExtensionArg.starts_with("SPV_")) {
213+
return ("+" + SpvExtensionArg).str();
214+
}
215+
if (SpvExtensionArg.compare_insensitive("DXC") == 0) {
216+
bool first = true;
217+
std::string Operand;
218+
for (llvm::StringRef E : DxcSupportedExtensions) {
219+
if (first) {
220+
Operand = (Operand + "+" + E).str();
221+
first = false;
222+
continue;
223+
}
224+
Operand = (Operand + ",+" + E).str();
225+
}
226+
return Operand;
227+
}
228+
return SpvExtensionArg.str();
229+
}
230+
176231
std::string getSpirvExtArg(ArrayRef<std::string> SpvExtensionArgs) {
177232
if (SpvExtensionArgs.empty()) {
178233
return "-spirv-ext=all";
179234
}
180235

181236
std::string LlvmOption =
182-
(Twine("-spirv-ext=+") + SpvExtensionArgs.front()).str();
237+
"-spirv-ext=" + getSpirvExtOperand(SpvExtensionArgs[0]);
183238
SpvExtensionArgs = SpvExtensionArgs.slice(1);
184-
for (auto Extension : SpvExtensionArgs) {
185-
if (Extension != "KHR")
186-
Extension = (Twine("+") + Extension).str();
187-
LlvmOption = (Twine(LlvmOption) + "," + Extension).str();
239+
for (llvm::StringRef Extension : SpvExtensionArgs) {
240+
LlvmOption =
241+
(Twine(LlvmOption) + "," + getSpirvExtOperand(Extension)).str();
188242
}
189243
return LlvmOption;
190244
}
191245

192246
bool isValidSPIRVExtensionName(const std::string &str) {
193-
std::regex pattern("KHR|SPV_[a-zA-Z0-9_]+");
247+
std::regex pattern("dxc|DXC|KHR|SPV_[a-zA-Z0-9_]+");
194248
return std::regex_match(str, pattern);
195249
}
196250

clang/test/Driver/dxc_fspv_extension.hlsl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@
1414
// RUN: %clang_dxc -spirv -Tlib_6_7 -### %s -fspv-extension=SPV_TEST1 -fspv-extension=KHR -fspv-extension=SPV_TEST2 2>&1 | FileCheck %s -check-prefix=TEST3
1515
// TEST3: "-spirv-ext=+SPV_TEST1,KHR,+SPV_TEST2"
1616

17+
// Merge KHR with other extensions.
18+
// RUN: %clang_dxc -spirv -Tlib_6_7 -### %s -fspv-extension=KHR -fspv-extension=SPV_TEST2 2>&1 | FileCheck %s -check-prefix=TEST4
19+
// TEST4: "-spirv-ext=KHR,+SPV_TEST2"
20+
21+
// Merge KHR with other extensions.
22+
// RUN: %clang_dxc -spirv -Tlib_6_7 -### %s -fspv-extension=DXC 2>&1 | FileCheck %s -check-prefix=TEST5
23+
// TEST5: "-spirv-ext={{(\+SPV_[a-zA-Z0-9_]+,?)+}}"
24+
1725
// Check for the error message if the extension name is not properly formed.
1826
// RUN: not %clang_dxc -spirv -Tlib_6_7 -### %s -fspv-extension=KHR_BAD -fspv-extension=TEST1 -fspv-extension=SPV_GOOD -fspv-extension=TEST2 2>&1 | FileCheck %s -check-prefix=FAIL
1927
// FAIL: invalid value 'KHR_BAD' in '-fspv-extension'

llvm/lib/Target/SPIRV/SPIRVCommandLine.cpp

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,24 @@ static const std::map<std::string, SPIRV::Extension::Extension, std::less<>>
3232
SPIRV::Extension::Extension::SPV_EXT_arithmetic_fence},
3333
{"SPV_EXT_demote_to_helper_invocation",
3434
SPIRV::Extension::Extension::SPV_EXT_demote_to_helper_invocation},
35+
{"SPV_EXT_descriptor_indexing",
36+
SPIRV::Extension::Extension::SPV_EXT_descriptor_indexing},
37+
{"SPV_EXT_fragment_fully_covered",
38+
SPIRV::Extension::Extension::SPV_EXT_fragment_fully_covered},
39+
{"SPV_EXT_fragment_invocation_density",
40+
SPIRV::Extension::Extension::SPV_EXT_fragment_invocation_density},
41+
{"SPV_EXT_fragment_shader_interlock",
42+
SPIRV::Extension::Extension::SPV_EXT_fragment_shader_interlock},
43+
{"SPV_EXT_mesh_shader",
44+
SPIRV::Extension::Extension::SPV_EXT_mesh_shader},
45+
{"SPV_EXT_shader_stencil_export",
46+
SPIRV::Extension::Extension::SPV_EXT_shader_stencil_export},
47+
{"SPV_EXT_shader_viewport_index_layer",
48+
SPIRV::Extension::Extension::SPV_EXT_shader_viewport_index_layer},
49+
{"SPV_GOOGLE_hlsl_functionality1",
50+
SPIRV::Extension::Extension::SPV_GOOGLE_hlsl_functionality1},
51+
{"SPV_GOOGLE_user_type",
52+
SPIRV::Extension::Extension::SPV_GOOGLE_user_type},
3553
{"SPV_INTEL_arbitrary_precision_integers",
3654
SPIRV::Extension::Extension::SPV_INTEL_arbitrary_precision_integers},
3755
{"SPV_INTEL_cache_controls",
@@ -57,6 +75,19 @@ static const std::map<std::string, SPIRV::Extension::Extension, std::less<>>
5775
SPIRV::Extension::Extension::SPV_INTEL_memory_access_aliasing},
5876
{"SPV_INTEL_joint_matrix",
5977
SPIRV::Extension::Extension::SPV_INTEL_joint_matrix},
78+
{"SPV_KHR_16bit_storage",
79+
SPIRV::Extension::Extension::SPV_KHR_16bit_storage},
80+
{"SPV_KHR_device_group",
81+
SPIRV::Extension::Extension::SPV_KHR_device_group},
82+
{"SPV_KHR_fragment_shading_rate",
83+
SPIRV::Extension::Extension::SPV_KHR_fragment_shading_rate},
84+
{"SPV_KHR_multiview", SPIRV::Extension::Extension::SPV_KHR_multiview},
85+
{"SPV_KHR_post_depth_coverage",
86+
SPIRV::Extension::Extension::SPV_KHR_post_depth_coverage},
87+
{"SPV_KHR_shader_draw_parameters",
88+
SPIRV::Extension::Extension::SPV_KHR_shader_draw_parameters},
89+
{"SPV_KHR_ray_tracing",
90+
SPIRV::Extension::Extension::SPV_KHR_ray_tracing},
6091
{"SPV_KHR_uniform_group_instructions",
6192
SPIRV::Extension::Extension::SPV_KHR_uniform_group_instructions},
6293
{"SPV_KHR_no_integer_wrap_decoration",
@@ -89,6 +120,17 @@ static const std::map<std::string, SPIRV::Extension::Extension, std::less<>>
89120
SPIRV::Extension::Extension::SPV_KHR_cooperative_matrix},
90121
{"SPV_KHR_non_semantic_info",
91122
SPIRV::Extension::Extension::SPV_KHR_non_semantic_info},
123+
{"SPV_KHR_ray_query", SPIRV::Extension::Extension::SPV_KHR_ray_query},
124+
{"SPV_EXT_shader_image_int64",
125+
SPIRV::Extension::Extension::SPV_EXT_shader_image_int64},
126+
{"SPV_KHR_fragment_shader_barycentric",
127+
SPIRV::Extension::Extension::SPV_KHR_fragment_shader_barycentric},
128+
{"SPV_KHR_physical_storage_buffer",
129+
SPIRV::Extension::Extension::SPV_KHR_physical_storage_buffer},
130+
{"SPV_KHR_vulkan_memory_model",
131+
SPIRV::Extension::Extension::SPV_KHR_vulkan_memory_model},
132+
{"SPV_NV_shader_subgroup_partitioned",
133+
SPIRV::Extension::Extension::SPV_NV_shader_subgroup_partitioned},
92134
{"SPV_INTEL_long_composites",
93135
SPIRV::Extension::Extension::SPV_INTEL_long_composites},
94136
{"SPV_INTEL_fp_max_error",

0 commit comments

Comments
 (0)