Add specialization constants via `#[spirv(spec_constant(id = 123))] x…

…: u32` entry-point inputs.
EmbarkStudios · Jul 20, 2023 · 64a3332 · 64a3332
1 parent 55edc4e
commit 64a3332
Show file tree

Hide file tree

Showing 8 changed files with 333 additions and 67 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,11 +30,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added ⭐
+- [PR#1081](https://github.com/EmbarkStudios/rust-gpu/pull/1081) added the ability
+  to access SPIR-V specialization constants (`OpSpecConstant`) via entry-point
+  inputs declared as `#[spirv(spec_constant(id = ..., default = ...))] x: u32`  
+  (see also [the `#[spirv(spec_constant)]` attribute documentation](docs/src/attributes.md#specialization-constants))
 - [PR#1036](https://github.com/EmbarkStudios/rust-gpu/pull/1036) added a `--force-spirv-passthru` flag to `example-runner-wgpu`, to bypass Naga (`wgpu`'s shader translator),
   used it to test `debugPrintf` for `wgpu`,  and updated `ShaderPanicStrategy::DebugPrintfThenExit` docs to reflect what "enabling `debugPrintf`" looks like for `wgpu`  
   <sub><sup>(e.g. `VK_LOADER_LAYERS_ENABLE=VK_LAYER_KHRONOS_validation VK_LAYER_ENABLES=VK_VALIDATION_FEATURE_ENABLE_DEBUG_PRINTF_EXT DEBUG_PRINTF_TO_STDOUT=1`)</sup></sub>
 - [PR#1080](https://github.com/EmbarkStudios/rust-gpu/pull/1080) added `debugPrintf`-based
-  panic reporting, with the desired behavior selected via `spirv_builder::ShaderPanicStrategy`
+  panic reporting, with the desired behavior selected via `spirv_builder::ShaderPanicStrategy`  
   (see its documentation for more details about each available panic handling strategy)
 
 ### Changed 🛠

diff --git a/crates/rustc_codegen_spirv/src/attr.rs b/crates/rustc_codegen_spirv/src/attr.rs
@@ -68,6 +68,12 @@ pub enum IntrinsicType {
     Matrix,
 }
 
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+pub struct SpecConstant {
+    pub id: u32,
+    pub default: Option<u32>,
+}
+
 // NOTE(eddyb) when adding new `#[spirv(...)]` attributes, the tests found inside
 // `tests/ui/spirv-attr` should be updated (and new ones added if necessary).
 #[derive(Debug, Clone)]
@@ -87,6 +93,7 @@ pub enum SpirvAttribute {
     Flat,
     Invariant,
     InputAttachmentIndex(u32),
+    SpecConstant(SpecConstant),
 
     // `fn`/closure attributes:
     BufferLoadIntrinsic,
@@ -121,6 +128,7 @@ pub struct AggregatedSpirvAttributes {
     pub flat: Option<Spanned<()>>,
     pub invariant: Option<Spanned<()>>,
     pub input_attachment_index: Option<Spanned<u32>>,
+    pub spec_constant: Option<Spanned<SpecConstant>>,
 
     // `fn`/closure attributes:
     pub buffer_load_intrinsic: Option<Spanned<()>>,
@@ -211,6 +219,12 @@ impl AggregatedSpirvAttributes {
                 span,
                 "#[spirv(attachment_index)]",
             ),
+            SpecConstant(value) => try_insert(
+                &mut self.spec_constant,
+                value,
+                span,
+                "#[spirv(spec_constant)]",
+            ),
             BufferLoadIntrinsic => try_insert(
                 &mut self.buffer_load_intrinsic,
                 (),
@@ -300,7 +314,8 @@ impl CheckSpirvAttrVisitor<'_> {
                 | SpirvAttribute::Binding(_)
                 | SpirvAttribute::Flat
                 | SpirvAttribute::Invariant
-                | SpirvAttribute::InputAttachmentIndex(_) => match target {
+                | SpirvAttribute::InputAttachmentIndex(_)
+                | SpirvAttribute::SpecConstant(_) => match target {
                     Target::Param => {
                         let parent_hir_id = self.tcx.hir().parent_id(hir_id);
                         let parent_is_entry_point =