-
Notifications
You must be signed in to change notification settings - Fork 916
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove lifetime constraints from
wgpu::ComputePass methods (#5570)
* basic test setup * remove lifetime and drop resources on test - test fails now just as expected * compute pass recording is now hub dependent (needs gfx_select) * compute pass recording now bumps reference count of uses resources directly on recording TODO: * bind groups don't work because the Binder gets an id only * wgpu level error handling is missing * simplify compute pass state flush, compute pass execution no longer needs to lock bind_group storage * wgpu sided error handling * make ComputePass hal dependent, removing command cast hack. Introduce DynComputePass on wgpu side * remove stray repr(C) * changelog entry * fix deno issues -> move DynComputePass into wgc * split out resources setup from test
- Loading branch information
Showing
11 changed files
with
613 additions
and
190 deletions.
There are no files selected for viewing
This file contains 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 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 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 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,174 @@ | ||
| //! Tests that compute passes take ownership of resources that are associated with. | ||
| //! I.e. once a resource is passed in to a compute pass, it can be dropped. | ||
| //! | ||
| //! TODO: Test doesn't check on timestamp writes & pipeline statistics queries yet. | ||
| //! (Not important as long as they are lifetime constrained to the command encoder, | ||
| //! but once we lift this constraint, we should add tests for this as well!) | ||
| //! TODO: Also should test resource ownership for: | ||
| //! * write_timestamp | ||
| //! * begin_pipeline_statistics_query | ||
|
|
||
| use std::num::NonZeroU64; | ||
|
|
||
| use wgpu::util::DeviceExt as _; | ||
| use wgpu_test::{gpu_test, GpuTestConfiguration, TestParameters, TestingContext}; | ||
|
|
||
| const SHADER_SRC: &str = " | ||
| @group(0) @binding(0) | ||
| var<storage, read_write> buffer: array<vec4f>; | ||
| @compute @workgroup_size(1, 1, 1) fn main() { | ||
| buffer[0] *= 2.0; | ||
| } | ||
| "; | ||
|
|
||
| #[gpu_test] | ||
| static COMPUTE_PASS_RESOURCE_OWNERSHIP: GpuTestConfiguration = GpuTestConfiguration::new() | ||
| .parameters(TestParameters::default().test_features_limits()) | ||
| .run_async(compute_pass_resource_ownership); | ||
|
|
||
| async fn compute_pass_resource_ownership(ctx: TestingContext) { | ||
| let ResourceSetup { | ||
| gpu_buffer, | ||
| cpu_buffer, | ||
| buffer_size, | ||
| indirect_buffer, | ||
| bind_group, | ||
| pipeline, | ||
| } = resource_setup(&ctx); | ||
|
|
||
| let mut encoder = ctx | ||
| .device | ||
| .create_command_encoder(&wgpu::CommandEncoderDescriptor { | ||
| label: Some("encoder"), | ||
| }); | ||
|
|
||
| { | ||
| let mut cpass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor { | ||
| label: Some("compute_pass"), | ||
| timestamp_writes: None, // TODO: See description above, we should test this as well once we lift the lifetime bound. | ||
| }); | ||
| cpass.set_pipeline(&pipeline); | ||
| cpass.set_bind_group(0, &bind_group, &[]); | ||
| cpass.dispatch_workgroups_indirect(&indirect_buffer, 0); | ||
|
|
||
| // Now drop all resources we set. Then do a device poll to make sure the resources are really not dropped too early, no matter what. | ||
| drop(pipeline); | ||
| drop(bind_group); | ||
| drop(indirect_buffer); | ||
| ctx.async_poll(wgpu::Maintain::wait()) | ||
| .await | ||
| .panic_on_timeout(); | ||
| } | ||
|
|
||
| // Ensure that the compute pass still executed normally. | ||
| encoder.copy_buffer_to_buffer(&gpu_buffer, 0, &cpu_buffer, 0, buffer_size); | ||
| ctx.queue.submit([encoder.finish()]); | ||
| cpu_buffer.slice(..).map_async(wgpu::MapMode::Read, |_| ()); | ||
| ctx.async_poll(wgpu::Maintain::wait()) | ||
| .await | ||
| .panic_on_timeout(); | ||
|
|
||
| let data = cpu_buffer.slice(..).get_mapped_range(); | ||
|
|
||
| let floats: &[f32] = bytemuck::cast_slice(&data); | ||
| assert_eq!(floats, [2.0, 4.0, 6.0, 8.0]); | ||
| } | ||
|
|
||
| // Setup ------------------------------------------------------------ | ||
|
|
||
| struct ResourceSetup { | ||
| gpu_buffer: wgpu::Buffer, | ||
| cpu_buffer: wgpu::Buffer, | ||
| buffer_size: u64, | ||
|
|
||
| indirect_buffer: wgpu::Buffer, | ||
| bind_group: wgpu::BindGroup, | ||
| pipeline: wgpu::ComputePipeline, | ||
| } | ||
|
|
||
| fn resource_setup(ctx: &TestingContext) -> ResourceSetup { | ||
| let sm = ctx | ||
| .device | ||
| .create_shader_module(wgpu::ShaderModuleDescriptor { | ||
| label: Some("shader"), | ||
| source: wgpu::ShaderSource::Wgsl(SHADER_SRC.into()), | ||
| }); | ||
|
|
||
| let buffer_size = 4 * std::mem::size_of::<f32>() as u64; | ||
|
|
||
| let bgl = ctx | ||
| .device | ||
| .create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor { | ||
| label: Some("bind_group_layout"), | ||
| entries: &[wgpu::BindGroupLayoutEntry { | ||
| binding: 0, | ||
| visibility: wgpu::ShaderStages::COMPUTE, | ||
| ty: wgpu::BindingType::Buffer { | ||
| ty: wgpu::BufferBindingType::Storage { read_only: false }, | ||
| has_dynamic_offset: false, | ||
| min_binding_size: NonZeroU64::new(buffer_size), | ||
| }, | ||
| count: None, | ||
| }], | ||
| }); | ||
|
|
||
| let gpu_buffer = ctx | ||
| .device | ||
| .create_buffer_init(&wgpu::util::BufferInitDescriptor { | ||
| label: Some("gpu_buffer"), | ||
| usage: wgpu::BufferUsages::STORAGE | wgpu::BufferUsages::COPY_SRC, | ||
| contents: bytemuck::bytes_of(&[1.0_f32, 2.0, 3.0, 4.0]), | ||
| }); | ||
|
|
||
| let cpu_buffer = ctx.device.create_buffer(&wgpu::BufferDescriptor { | ||
| label: Some("cpu_buffer"), | ||
| size: buffer_size, | ||
| usage: wgpu::BufferUsages::COPY_DST | wgpu::BufferUsages::MAP_READ, | ||
| mapped_at_creation: false, | ||
| }); | ||
|
|
||
| let indirect_buffer = ctx | ||
| .device | ||
| .create_buffer_init(&wgpu::util::BufferInitDescriptor { | ||
| label: Some("gpu_buffer"), | ||
| usage: wgpu::BufferUsages::INDIRECT, | ||
| contents: wgpu::util::DispatchIndirectArgs { x: 1, y: 1, z: 1 }.as_bytes(), | ||
| }); | ||
|
|
||
| let bind_group = ctx.device.create_bind_group(&wgpu::BindGroupDescriptor { | ||
| label: Some("bind_group"), | ||
| layout: &bgl, | ||
| entries: &[wgpu::BindGroupEntry { | ||
| binding: 0, | ||
| resource: gpu_buffer.as_entire_binding(), | ||
| }], | ||
| }); | ||
|
|
||
| let pipeline_layout = ctx | ||
| .device | ||
| .create_pipeline_layout(&wgpu::PipelineLayoutDescriptor { | ||
| label: Some("pipeline_layout"), | ||
| bind_group_layouts: &[&bgl], | ||
| push_constant_ranges: &[], | ||
| }); | ||
|
|
||
| let pipeline = ctx | ||
| .device | ||
| .create_compute_pipeline(&wgpu::ComputePipelineDescriptor { | ||
| label: Some("pipeline"), | ||
| layout: Some(&pipeline_layout), | ||
| module: &sm, | ||
| entry_point: "main", | ||
| compilation_options: Default::default(), | ||
| }); | ||
|
|
||
| ResourceSetup { | ||
| gpu_buffer, | ||
| cpu_buffer, | ||
| buffer_size, | ||
| indirect_buffer, | ||
| bind_group, | ||
| pipeline, | ||
| } | ||
| } |
This file contains 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 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
Oops, something went wrong.