Convert error scopes to use thread-local guards

Co-authored-by: Kevin Reid <kpreid@switchb.org>

Author: cwfitzgerald

CHANGELOG.md

@@ -106,7 +106,15 @@ One other breaking change worth noting is that in WGSL `@builtin(view_index)` no
 
 By @SupaMaggie70Incorporated in [#8206](https://github.com/gfx-rs/wgpu/pull/8206).
 
-#### Error Scopes are now thread-local
+#### Error scopes now use guards and are thread local.
+
+```diff
+- device.push_error_scope(wgpu::ErrorFilter::Validation);
++ let scope = device.push_error_scope(wgpu::ErrorFilter::Validation);
+ // ... perform operations on the device ...
+- let error: Option<Error> = device.pop_error_scope().await;
++ let error: Option<Error> = scope.pop().await;
+```
 
 Device error scopes now operate on a per-thread basis. This allows them to be used easily within multithreaded contexts,
 without having the error scope capture errors from other threads.

examples/features/src/ray_cube_compute/mod.rs

@@ -420,8 +420,6 @@ impl crate::framework::Example for Example {
  }
 
  fn render(&mut self, view: &wgpu::TextureView, device: &wgpu::Device, queue: &wgpu::Queue) {
- device.push_error_scope(wgpu::ErrorFilter::Validation);
-
  let anim_time = self.animation_timer.time();
 
  self.tlas[0].as_mut().unwrap().transform =

examples/features/src/ray_cube_fragment/mod.rs

@@ -294,8 +294,6 @@ impl crate::framework::Example for Example {
  }
 
  fn render(&mut self, view: &wgpu::TextureView, device: &wgpu::Device, queue: &wgpu::Queue) {
- device.push_error_scope(wgpu::ErrorFilter::Validation);
-
  // scene update
  {
  let dist = 12.0;

examples/features/src/ray_cube_normals/mod.rs

@@ -406,8 +406,6 @@ impl crate::framework::Example for Example {
  }
 
  fn render(&mut self, view: &wgpu::TextureView, device: &wgpu::Device, queue: &wgpu::Queue) {
- device.push_error_scope(wgpu::ErrorFilter::Validation);
-
  let anim_time = self.animation_timer.time();
 
  self.tlas[0].as_mut().unwrap().transform =

examples/features/src/ray_scene/mod.rs

@@ -464,8 +464,6 @@ impl crate::framework::Example for Example {
  }
 
  fn render(&mut self, view: &wgpu::TextureView, device: &wgpu::Device, queue: &wgpu::Queue) {
- device.push_error_scope(wgpu::ErrorFilter::Validation);
-
  // scene update
  {
  let dist = 3.5;

examples/features/src/srgb_blend/mod.rs

@@ -173,7 +173,6 @@ impl<const SRGB: bool> crate::framework::Example for Example<SRGB> {
  }
 
  fn render(&mut self, view: &wgpu::TextureView, device: &wgpu::Device, queue: &wgpu::Queue) {
- device.push_error_scope(wgpu::ErrorFilter::Validation);
  let mut encoder =
  device.create_command_encoder(&wgpu::CommandEncoderDescriptor { label: None });
  {

examples/standalone/custom_backend/src/custom.rs

@@ -251,11 +251,11 @@ impl DeviceInterface for CustomDevice {
  unimplemented!()
  }
 
- fn push_error_scope(&self, _filter: wgpu::ErrorFilter) {
+ fn push_error_scope(&self, _filter: wgpu::ErrorFilter) -> u32 {
  unimplemented!()
  }
 
- fn pop_error_scope(&self) -> Pin<Box<dyn wgpu::custom::PopErrorScopeFuture>> {
+ fn pop_error_scope(&self, _index: u32) -> Pin<Box<dyn wgpu::custom::PopErrorScopeFuture>> {
  unimplemented!()
  }
 

tests/Cargo.toml

@@ -94,4 +94,5 @@ wasm-bindgen.workspace = true
 web-sys = { workspace = true, features = ["CanvasRenderingContext2d", "Blob"] }
 
 [lints.clippy]
+bool_assert_comparison = "allow"
 disallowed_types = "allow"

tests/src/lib.rs

@@ -39,9 +39,9 @@ pub fn fail<T>(
  callback: impl FnOnce() -> T,
  expected_msg_substring: Option<&str>,
 ) -> T {
- device.push_error_scope(wgpu::ErrorFilter::Validation);
+ let scope = device.push_error_scope(wgpu::ErrorFilter::Validation);
  let result = callback();
- let validation_error = pollster::block_on(device.pop_error_scope())
+ let validation_error = pollster::block_on(scope.pop())
  .expect("expected validation error in callback, but no validation error was emitted");
  if let Some(expected_msg_substring) = expected_msg_substring {
  let lowered_expected = expected_msg_substring.to_lowercase();
@@ -63,9 +63,9 @@ pub fn fail<T>(
 /// Run some code in an error scope and assert that validation succeeds.
 #[track_caller]
 pub fn valid<T>(device: &wgpu::Device, callback: impl FnOnce() -> T) -> T {
- device.push_error_scope(wgpu::ErrorFilter::Validation);
+ let scope = device.push_error_scope(wgpu::ErrorFilter::Validation);
  let result = callback();
- if let Some(error) = pollster::block_on(device.pop_error_scope()) {
+ if let Some(error) = pollster::block_on(scope.pop()) {
  panic!(
  "`valid` block at {} encountered wgpu error:\n{error}",
  std::panic::Location::caller()
@@ -95,9 +95,9 @@ fn did_fill_error_scope<T>(
  callback: impl FnOnce() -> T,
  filter: wgpu::ErrorFilter,
 ) -> (bool, T) {
- device.push_error_scope(filter);
+ let scope = device.push_error_scope(filter);
  let result = callback();
- let validation_error = pollster::block_on(device.pop_error_scope());
+ let validation_error = pollster::block_on(scope.pop());
  let failed = validation_error.is_some();
 
  (failed, result)

tests/tests/wgpu-gpu/dispatch_workgroups_indirect.rs

@@ -77,7 +77,7 @@ static RESET_BIND_GROUPS: GpuTestConfiguration = GpuTestConfiguration::new()
  }).enable_noop(),
  )
  .run_async(|ctx| async move {
- ctx.device.push_error_scope(wgpu::ErrorFilter::Validation);
+ let scope = ctx.device.push_error_scope(wgpu::ErrorFilter::Validation);
 
  let test_resources = TestResources::new(&ctx);
 
@@ -98,7 +98,7 @@ static RESET_BIND_GROUPS: GpuTestConfiguration = GpuTestConfiguration::new()
  }
  ctx.queue.submit(Some(encoder.finish()));
 
- let error = pollster::block_on(ctx.device.pop_error_scope());
+ let error = pollster::block_on(scope.pop());
  assert!(error.is_some_and(|error| {
  format!("{error}").contains("The current set ComputePipeline with '' label expects a BindGroup to be set at index 0")
  }));
@@ -120,7 +120,7 @@ static ZERO_SIZED_BUFFER: GpuTestConfiguration = GpuTestConfiguration::new()
  .enable_noop(),
  )
  .run_async(|ctx| async move {
- ctx.device.push_error_scope(wgpu::ErrorFilter::Validation);
+ let scope = ctx.device.push_error_scope(wgpu::ErrorFilter::Validation);
 
  let test_resources = TestResources::new(&ctx);
 
@@ -141,7 +141,7 @@ static ZERO_SIZED_BUFFER: GpuTestConfiguration = GpuTestConfiguration::new()
  }
  ctx.queue.submit(Some(encoder.finish()));
 
- let error = pollster::block_on(ctx.device.pop_error_scope());
+ let error = pollster::block_on(scope.pop());
  assert!(error.is_some_and(|error| {
  format!("{error}").contains(
  "Indirect buffer uses bytes 0..12 which overruns indirect buffer of size 0",