Allow configuring whether workgroup memory is zero initialised (#5508)

gfx-rs · Apr 17, 2024 · 965b00c · 965b00c
1 parent 40db4df
commit 965b00c
Show file tree

Hide file tree

Showing 59 changed files with 219 additions and 125 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -118,6 +118,7 @@ Bottom level categories:
   - `wgpu::Texture::as_hal` now returns a user-defined type to match the other as_hal functions
 
 - Added support for pipeline-overridable constants. By @teoxoy & @jimblandy in [#5500](https://github.com/gfx-rs/wgpu/pull/5500)
+- Support disabling zero-initialization of workgroup local memory in compute shaders. By @DJMcNab in [#5508](https://github.com/gfx-rs/wgpu/pull/5508)
 
 #### GLES
 

diff --git a/deno_webgpu/pipeline.rs b/deno_webgpu/pipeline.rs
@@ -113,6 +113,7 @@ pub fn op_webgpu_create_compute_pipeline(
             module: compute_shader_module_resource.1,
             entry_point: compute.entry_point.map(Cow::from),
             constants: Cow::Owned(compute.constants),
+            zero_initialize_workgroup_memory: true,
         },
     };
     let implicit_pipelines = match layout {
@@ -359,6 +360,8 @@ pub fn op_webgpu_create_render_pipeline(
                 module: fragment_shader_module_resource.1,
                 entry_point: Some(Cow::from(fragment.entry_point)),
                 constants: Cow::Owned(fragment.constants),
+                // Required to be true for WebGPU
+                zero_initialize_workgroup_memory: true,
             },
             targets: Cow::Owned(fragment.targets),
         })
@@ -382,6 +385,8 @@ pub fn op_webgpu_create_render_pipeline(
                 module: vertex_shader_module_resource.1,
                 entry_point: Some(Cow::Owned(args.vertex.entry_point)),
                 constants: Cow::Owned(args.vertex.constants),
+                // Required to be true for WebGPU
+                zero_initialize_workgroup_memory: true,
             },
             buffers: Cow::Owned(vertex_buffers),
         },

diff --git a/examples/src/boids/mod.rs b/examples/src/boids/mod.rs
@@ -132,7 +132,7 @@ impl crate::framework::Example for Example {
             vertex: wgpu::VertexState {
                 module: &draw_shader,
                 entry_point: "main_vs",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 buffers: &[
                     wgpu::VertexBufferLayout {
                         array_stride: 4 * 4,
@@ -149,7 +149,7 @@ impl crate::framework::Example for Example {
             fragment: Some(wgpu::FragmentState {
                 module: &draw_shader,
                 entry_point: "main_fs",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 targets: &[Some(config.view_formats[0].into())],
             }),
             primitive: wgpu::PrimitiveState::default(),
@@ -165,7 +165,7 @@ impl crate::framework::Example for Example {
             layout: Some(&compute_pipeline_layout),
             module: &compute_shader,
             entry_point: "main",
-            constants: &Default::default(),
+            compilation_options: Default::default(),
         });
 
         // buffer for the three 2d triangle vertices of each instance

diff --git a/examples/src/bunnymark/mod.rs b/examples/src/bunnymark/mod.rs
@@ -203,13 +203,13 @@ impl crate::framework::Example for Example {
             vertex: wgpu::VertexState {
                 module: &shader,
                 entry_point: "vs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 buffers: &[],
             },
             fragment: Some(wgpu::FragmentState {
                 module: &shader,
                 entry_point: "fs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 targets: &[Some(wgpu::ColorTargetState {
                     format: config.view_formats[0],
                     blend: Some(wgpu::BlendState::ALPHA_BLENDING),

diff --git a/examples/src/conservative_raster/mod.rs b/examples/src/conservative_raster/mod.rs
@@ -97,13 +97,13 @@ impl crate::framework::Example for Example {
                 vertex: wgpu::VertexState {
                     module: &shader_triangle_and_lines,
                     entry_point: "vs_main",
-                    constants: &Default::default(),
+                    compilation_options: Default::default(),
                     buffers: &[],
                 },
                 fragment: Some(wgpu::FragmentState {
                     module: &shader_triangle_and_lines,
                     entry_point: "fs_main_red",
-                    constants: &Default::default(),
+                    compilation_options: Default::default(),
                     targets: &[Some(RENDER_TARGET_FORMAT.into())],
                 }),
                 primitive: wgpu::PrimitiveState {
@@ -122,13 +122,13 @@ impl crate::framework::Example for Example {
                 vertex: wgpu::VertexState {
                     module: &shader_triangle_and_lines,
                     entry_point: "vs_main",
-                    constants: &Default::default(),
+                    compilation_options: Default::default(),
                     buffers: &[],
                 },
                 fragment: Some(wgpu::FragmentState {
                     module: &shader_triangle_and_lines,
                     entry_point: "fs_main_blue",
-                    constants: &Default::default(),
+                    compilation_options: Default::default(),
                     targets: &[Some(RENDER_TARGET_FORMAT.into())],
                 }),
                 primitive: wgpu::PrimitiveState::default(),
@@ -148,13 +148,13 @@ impl crate::framework::Example for Example {
                     vertex: wgpu::VertexState {
                         module: &shader_triangle_and_lines,
                         entry_point: "vs_main",
-                        constants: &Default::default(),
+                        compilation_options: Default::default(),
                         buffers: &[],
                     },
                     fragment: Some(wgpu::FragmentState {
                         module: &shader_triangle_and_lines,
                         entry_point: "fs_main_white",
-                        constants: &Default::default(),
+                        compilation_options: Default::default(),
                         targets: &[Some(config.view_formats[0].into())],
                     }),
                     primitive: wgpu::PrimitiveState {
@@ -211,13 +211,13 @@ impl crate::framework::Example for Example {
                     vertex: wgpu::VertexState {
                         module: &shader,
                         entry_point: "vs_main",
-                        constants: &Default::default(),
+                        compilation_options: Default::default(),
                         buffers: &[],
                     },
                     fragment: Some(wgpu::FragmentState {
                         module: &shader,
                         entry_point: "fs_main",
-                        constants: &Default::default(),
+                        compilation_options: Default::default(),
                         targets: &[Some(config.view_formats[0].into())],
                     }),
                     primitive: wgpu::PrimitiveState::default(),

diff --git a/examples/src/cube/mod.rs b/examples/src/cube/mod.rs
@@ -244,13 +244,13 @@ impl crate::framework::Example for Example {
             vertex: wgpu::VertexState {
                 module: &shader,
                 entry_point: "vs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 buffers: &vertex_buffers,
             },
             fragment: Some(wgpu::FragmentState {
                 module: &shader,
                 entry_point: "fs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 targets: &[Some(config.view_formats[0].into())],
             }),
             primitive: wgpu::PrimitiveState {
@@ -272,13 +272,13 @@ impl crate::framework::Example for Example {
                 vertex: wgpu::VertexState {
                     module: &shader,
                     entry_point: "vs_main",
-                    constants: &Default::default(),
+                    compilation_options: Default::default(),
                     buffers: &vertex_buffers,
                 },
                 fragment: Some(wgpu::FragmentState {
                     module: &shader,
                     entry_point: "fs_wire",
-                    constants: &Default::default(),
+                    compilation_options: Default::default(),
                     targets: &[Some(wgpu::ColorTargetState {
                         format: config.view_formats[0],
                         blend: Some(wgpu::BlendState {

diff --git a/examples/src/hello_compute/mod.rs b/examples/src/hello_compute/mod.rs
@@ -109,7 +109,7 @@ async fn execute_gpu_inner(
         layout: None,
         module: &cs_module,
         entry_point: "main",
-        constants: &Default::default(),
+        compilation_options: Default::default(),
     });
 
     // Instantiates the bind group, once again specifying the binding of buffers.

diff --git a/examples/src/hello_synchronization/mod.rs b/examples/src/hello_synchronization/mod.rs
@@ -103,14 +103,14 @@ async fn execute(
         layout: Some(&pipeline_layout),
         module: &shaders_module,
         entry_point: "patient_main",
-        constants: &Default::default(),
+        compilation_options: Default::default(),
     });
     let hasty_pipeline = device.create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
         label: None,
         layout: Some(&pipeline_layout),
         module: &shaders_module,
         entry_point: "hasty_main",
-        constants: &Default::default(),
+        compilation_options: Default::default(),
     });
 
     //----------------------------------------------------------

diff --git a/examples/src/hello_triangle/mod.rs b/examples/src/hello_triangle/mod.rs
@@ -60,12 +60,12 @@ async fn run(event_loop: EventLoop<()>, window: Window) {
             module: &shader,
             entry_point: "vs_main",
             buffers: &[],
-            constants: &Default::default(),
+            compilation_options: Default::default(),
         },
         fragment: Some(wgpu::FragmentState {
             module: &shader,
             entry_point: "fs_main",
-            constants: &Default::default(),
+            compilation_options: Default::default(),
             targets: &[Some(swapchain_format.into())],
         }),
         primitive: wgpu::PrimitiveState::default(),

diff --git a/examples/src/hello_workgroups/mod.rs b/examples/src/hello_workgroups/mod.rs
@@ -110,7 +110,7 @@ async fn run() {
         layout: Some(&pipeline_layout),
         module: &shader,
         entry_point: "main",
-        constants: &Default::default(),
+        compilation_options: Default::default(),
     });
 
     //----------------------------------------------------------

diff --git a/examples/src/mipmap/mod.rs b/examples/src/mipmap/mod.rs
@@ -93,13 +93,13 @@ impl Example {
             vertex: wgpu::VertexState {
                 module: &shader,
                 entry_point: "vs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 buffers: &[],
             },
             fragment: Some(wgpu::FragmentState {
                 module: &shader,
                 entry_point: "fs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 targets: &[Some(TEXTURE_FORMAT.into())],
             }),
             primitive: wgpu::PrimitiveState {
@@ -292,13 +292,13 @@ impl crate::framework::Example for Example {
             vertex: wgpu::VertexState {
                 module: &shader,
                 entry_point: "vs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 buffers: &[],
             },
             fragment: Some(wgpu::FragmentState {
                 module: &shader,
                 entry_point: "fs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 targets: &[Some(config.view_formats[0].into())],
             }),
             primitive: wgpu::PrimitiveState {

diff --git a/examples/src/msaa_line/mod.rs b/examples/src/msaa_line/mod.rs
@@ -54,7 +54,7 @@ impl Example {
             vertex: wgpu::VertexState {
                 module: shader,
                 entry_point: "vs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 buffers: &[wgpu::VertexBufferLayout {
                     array_stride: std::mem::size_of::<Vertex>() as wgpu::BufferAddress,
                     step_mode: wgpu::VertexStepMode::Vertex,
@@ -64,7 +64,7 @@ impl Example {
             fragment: Some(wgpu::FragmentState {
                 module: shader,
                 entry_point: "fs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 targets: &[Some(config.view_formats[0].into())],
             }),
             primitive: wgpu::PrimitiveState {

diff --git a/examples/src/render_to_texture/mod.rs b/examples/src/render_to_texture/mod.rs
@@ -59,13 +59,13 @@ async fn run(_path: Option<String>) {
         vertex: wgpu::VertexState {
             module: &shader,
             entry_point: "vs_main",
-            constants: &Default::default(),
+            compilation_options: Default::default(),
             buffers: &[],
         },
         fragment: Some(wgpu::FragmentState {
             module: &shader,
             entry_point: "fs_main",
-            constants: &Default::default(),
+            compilation_options: Default::default(),
             targets: &[Some(wgpu::TextureFormat::Rgba8UnormSrgb.into())],
         }),
         primitive: wgpu::PrimitiveState::default(),

diff --git a/examples/src/repeated_compute/mod.rs b/examples/src/repeated_compute/mod.rs
@@ -245,7 +245,7 @@ impl WgpuContext {
             layout: Some(&pipeline_layout),
             module: &shader,
             entry_point: "main",
-            constants: &Default::default(),
+            compilation_options: Default::default(),
         });
 
         WgpuContext {

diff --git a/examples/src/shadow/mod.rs b/examples/src/shadow/mod.rs
@@ -500,7 +500,7 @@ impl crate::framework::Example for Example {
                 vertex: wgpu::VertexState {
                     module: &shader,
                     entry_point: "vs_bake",
-                    constants: &Default::default(),
+                    compilation_options: Default::default(),
                     buffers: &[vb_desc.clone()],
                 },
                 fragment: None,
@@ -633,7 +633,7 @@ impl crate::framework::Example for Example {
                 vertex: wgpu::VertexState {
                     module: &shader,
                     entry_point: "vs_main",
-                    constants: &Default::default(),
+                    compilation_options: Default::default(),
                     buffers: &[vb_desc],
                 },
                 fragment: Some(wgpu::FragmentState {
@@ -643,7 +643,7 @@ impl crate::framework::Example for Example {
                     } else {
                         "fs_main_without_storage"
                     },
-                    constants: &Default::default(),
+                    compilation_options: Default::default(),
                     targets: &[Some(config.view_formats[0].into())],
                 }),
                 primitive: wgpu::PrimitiveState {

diff --git a/examples/src/skybox/mod.rs b/examples/src/skybox/mod.rs
@@ -199,13 +199,13 @@ impl crate::framework::Example for Example {
             vertex: wgpu::VertexState {
                 module: &shader,
                 entry_point: "vs_sky",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 buffers: &[],
             },
             fragment: Some(wgpu::FragmentState {
                 module: &shader,
                 entry_point: "fs_sky",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 targets: &[Some(config.view_formats[0].into())],
             }),
             primitive: wgpu::PrimitiveState {
@@ -228,7 +228,7 @@ impl crate::framework::Example for Example {
             vertex: wgpu::VertexState {
                 module: &shader,
                 entry_point: "vs_entity",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 buffers: &[wgpu::VertexBufferLayout {
                     array_stride: std::mem::size_of::<Vertex>() as wgpu::BufferAddress,
                     step_mode: wgpu::VertexStepMode::Vertex,
@@ -238,7 +238,7 @@ impl crate::framework::Example for Example {
             fragment: Some(wgpu::FragmentState {
                 module: &shader,
                 entry_point: "fs_entity",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 targets: &[Some(config.view_formats[0].into())],
             }),
             primitive: wgpu::PrimitiveState {

diff --git a/examples/src/srgb_blend/mod.rs b/examples/src/srgb_blend/mod.rs
@@ -131,13 +131,13 @@ impl<const SRGB: bool> crate::framework::Example for Example<SRGB> {
             vertex: wgpu::VertexState {
                 module: &shader,
                 entry_point: "vs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 buffers: &vertex_buffers,
             },
             fragment: Some(wgpu::FragmentState {
                 module: &shader,
                 entry_point: "fs_main",
-                constants: &Default::default(),
+                compilation_options: Default::default(),
                 targets: &[Some(wgpu::ColorTargetState {
                     format: config.view_formats[0],
                     blend: Some(wgpu::BlendState::ALPHA_BLENDING),