From 86e12499499f19b2b1439ad734bb9bfecca7e9d7 Mon Sep 17 00:00:00 2001 From: Aaron Loucks Date: Sat, 9 Mar 2019 13:56:32 -0500 Subject: [PATCH 1/2] Add the static lifetime bound to async buffer mapping callbacks These callbacks are executed outside of the mapping function and could previously reference data that had been dropped. This fixes the soundness issues described in #95, but not the buggy mapping behavior. --- examples/hello_compute_rust/main.rs | 5 ++++- wgpu-rs/src/lib.rs | 4 ++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/examples/hello_compute_rust/main.rs b/examples/hello_compute_rust/main.rs index ef5bdef87..27c5ad774 100644 --- a/examples/hello_compute_rust/main.rs +++ b/examples/hello_compute_rust/main.rs @@ -88,13 +88,16 @@ fn main() { } encoder.copy_buffer_to_buffer(&storage_buffer, 0, &staging_buffer, 0, size); + device.get_queue().submit(&[encoder.finish()]); + staging_buffer.map_read_async(0, size, |result: wgpu::BufferMapAsyncResult<&[u32]>| { if let wgpu::BufferMapAsyncResult::Success(data) = result { println!("Times: {:?}", data); } - staging_buffer.unmap(); + // staging_buffer.unmap(); // TODO }); + let encoder = device.create_command_encoder(&wgpu::CommandEncoderDescriptor { todo: 0 }); device.get_queue().submit(&[encoder.finish()]); } diff --git a/wgpu-rs/src/lib.rs b/wgpu-rs/src/lib.rs index cd456656a..32eb32b7d 100644 --- a/wgpu-rs/src/lib.rs +++ b/wgpu-rs/src/lib.rs @@ -530,7 +530,7 @@ impl Buffer { pub fn map_read_async(&self, start: u32, size: u32, callback: F) where T: 'static + Copy, - F: FnOnce(BufferMapAsyncResult<&[T]>), + F: FnOnce(BufferMapAsyncResult<&[T]>) + 'static, { let type_size = std::mem::size_of::() as u32; assert_ne!(type_size, 0); @@ -575,7 +575,7 @@ impl Buffer { pub fn map_write_async(&self, start: u32, size: u32, callback: F) where T: 'static + Copy, - F: FnOnce(BufferMapAsyncResult<&mut [T]>), + F: FnOnce(BufferMapAsyncResult<&mut [T]>) + 'static, { let type_size = std::mem::size_of::() as u32; assert_ne!(type_size, 0); From e0811db8d464e1b84e4082d5a6cac917a422d2bb Mon Sep 17 00:00:00 2001 From: Aaron Loucks Date: Tue, 12 Mar 2019 22:15:37 -0400 Subject: [PATCH 2/2] Triage buffers prior to overwriting the submission index This allows async buffer mapping to function when a renderpass is also submitted on the queue. The state transition and fencing still needs work, however. --- examples/hello_compute_rust/main.rs | 4 ++-- wgpu-native/src/device.rs | 22 +++++++++++++++++----- 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/examples/hello_compute_rust/main.rs b/examples/hello_compute_rust/main.rs index 27c5ad774..bac59cf1c 100644 --- a/examples/hello_compute_rust/main.rs +++ b/examples/hello_compute_rust/main.rs @@ -94,10 +94,10 @@ fn main() { if let wgpu::BufferMapAsyncResult::Success(data) = result { println!("Times: {:?}", data); } - - // staging_buffer.unmap(); // TODO }); let encoder = device.create_command_encoder(&wgpu::CommandEncoderDescriptor { todo: 0 }); device.get_queue().submit(&[encoder.finish()]); + + staging_buffer.unmap(); // TODO: staging_buffer can't be referenced from the callback } diff --git a/wgpu-native/src/device.rs b/wgpu-native/src/device.rs index b1cab1158..9d466ecc8 100644 --- a/wgpu-native/src/device.rs +++ b/wgpu-native/src/device.rs @@ -1059,11 +1059,15 @@ pub extern "C" fn wgpu_queue_submit( let mut swap_chain_links = Vec::new(); + let mut trackers = device.trackers.lock(); + let mut destroyed = device.destroyed.lock(); + destroyed.triage_referenced(&mut *trackers); + destroyed.triage_framebuffers(&mut *device.framebuffers.lock()); + let old_submit_index = device .life_guard .submission_index .fetch_add(1, Ordering::Relaxed); - let mut trackers = device.trackers.lock(); //TODO: if multiple command buffers are submitted, we can re-use the last // native command buffer of the previous chain instead of always creating @@ -1170,12 +1174,8 @@ pub extern "C" fn wgpu_queue_submit( let device_guard = HUB.devices.read(); let device = &device_guard[queue_id]; - let mut trackers = device.trackers.lock(); - let last_done = { let mut destroyed = device.destroyed.lock(); - destroyed.triage_referenced(&mut *trackers); - destroyed.triage_framebuffers(&mut *device.framebuffers.lock()); let last_done = destroyed.cleanup(&device.raw); destroyed.handle_mapping(&device.raw); @@ -1776,6 +1776,12 @@ pub extern "C" fn wgpu_buffer_map_read_async( let mut buffer_guard = HUB.buffers.write(); let buffer = &mut buffer_guard[buffer_id]; + if buffer.pending_map_operation.is_some() { + log::error!("wgpu_buffer_map_read_async failed: buffer mapping is pending"); + callback(BufferMapAsyncStatus::Error, std::ptr::null_mut(), userdata); + return; + } + let range = start as u64..(start + size) as u64; buffer.pending_map_operation = Some(BufferMapOperation::Read(range, callback, userdata)); @@ -1796,6 +1802,12 @@ pub extern "C" fn wgpu_buffer_map_write_async( let mut buffer_guard = HUB.buffers.write(); let buffer = &mut buffer_guard[buffer_id]; + if buffer.pending_map_operation.is_some() { + log::error!("wgpu_buffer_map_write_async failed: buffer mapping is pending"); + callback(BufferMapAsyncStatus::Error, std::ptr::null_mut(), userdata); + return; + } + let range = start as u64..(start + size) as u64; buffer.pending_map_operation = Some(BufferMapOperation::Write(range, callback, userdata));