Memory init tracker refactor (#1839)

* split out init_tracker module with explicit buffer init tracking types * Added shortcut methods for checked init action handling Fixed a few unchecked sites in the process * fix clippy warnings
gfx-rs · Aug 23, 2021 · 9e1384d · 9e1384d
1 parent 7f395b3
commit 9e1384d
Show file tree

Hide file tree

Showing 13 changed files with 220 additions and 245 deletions.
diff --git a/wgpu-core/src/binding_model.rs b/wgpu-core/src/binding_model.rs
@@ -3,7 +3,7 @@ use crate::{
     error::{ErrorFormatter, PrettyError},
     hub::Resource,
     id::{BindGroupLayoutId, BufferId, DeviceId, SamplerId, TextureViewId, Valid},
-    memory_init_tracker::MemoryInitTrackerAction,
+    init_tracker::BufferInitTrackerAction,
     track::{TrackerSet, UsageConflict, DUMMY_SELECTOR},
     validation::{MissingBufferUsageError, MissingTextureUsageError},
     FastHashMap, Label, LifeGuard, MultiRefCount, Stored,
@@ -671,7 +671,7 @@ pub struct BindGroup<A: hal::Api> {
     pub(crate) layout_id: Valid<BindGroupLayoutId>,
     pub(crate) life_guard: LifeGuard,
     pub(crate) used: TrackerSet,
-    pub(crate) used_buffer_ranges: Vec<MemoryInitTrackerAction<BufferId>>,
+    pub(crate) used_buffer_ranges: Vec<BufferInitTrackerAction>,
     pub(crate) dynamic_binding_info: Vec<BindGroupDynamicBindingData>,
 }
 

diff --git a/wgpu-core/src/command/bundle.rs b/wgpu-core/src/command/bundle.rs
@@ -46,7 +46,7 @@ use crate::{
     error::{ErrorFormatter, PrettyError},
     hub::{GlobalIdentityHandlerFactory, HalApi, Hub, Resource, Storage, Token},
     id,
-    memory_init_tracker::{MemoryInitKind, MemoryInitTrackerAction},
+    init_tracker::{BufferInitTrackerAction, MemoryInitKind},
     pipeline::PipelineFlags,
     track::{TrackerSet, UsageConflict},
     validation::check_buffer_usage,
@@ -287,11 +287,11 @@ impl RenderBundleEncoder {
                         Some(s) => offset + s.get(),
                         None => buffer.size,
                     };
-                    buffer_memory_init_actions.push(MemoryInitTrackerAction {
-                        id: buffer_id,
-                        range: offset..end,
-                        kind: MemoryInitKind::NeedsInitializedMemory,
-                    });
+                    buffer_memory_init_actions.extend(buffer.initialization_status.create_action(
+                        buffer_id,
+                        offset..end,
+                        MemoryInitKind::NeedsInitializedMemory,
+                    ));
                     state.index.set_format(index_format);
                     state.index.set_buffer(buffer_id, offset..end);
                 }
@@ -314,11 +314,11 @@ impl RenderBundleEncoder {
                         Some(s) => offset + s.get(),
                         None => buffer.size,
                     };
-                    buffer_memory_init_actions.push(MemoryInitTrackerAction {
-                        id: buffer_id,
-                        range: offset..end,
-                        kind: MemoryInitKind::NeedsInitializedMemory,
-                    });
+                    buffer_memory_init_actions.extend(buffer.initialization_status.create_action(
+                        buffer_id,
+                        offset..end,
+                        MemoryInitKind::NeedsInitializedMemory,
+                    ));
                     state.vertex[slot as usize].set_buffer(buffer_id, offset..end);
                 }
                 RenderCommand::SetPushConstant {
@@ -435,18 +435,11 @@ impl RenderBundleEncoder {
                     check_buffer_usage(buffer.usage, wgt::BufferUsages::INDIRECT)
                         .map_pass_err(scope)?;
 
-                    buffer_memory_init_actions.extend(
-                        buffer
-                            .initialization_status
-                            .check(
-                                offset..(offset + mem::size_of::<wgt::DrawIndirectArgs>() as u64),
-                            )
-                            .map(|range| MemoryInitTrackerAction {
-                                id: buffer_id,
-                                range,
-                                kind: MemoryInitKind::NeedsInitializedMemory,
-                            }),
-                    );
+                    buffer_memory_init_actions.extend(buffer.initialization_status.create_action(
+                        buffer_id,
+                        offset..(offset + mem::size_of::<wgt::DrawIndirectArgs>() as u64),
+                        MemoryInitKind::NeedsInitializedMemory,
+                    ));
 
                     commands.extend(state.flush_vertices());
                     commands.extend(state.flush_binds());
@@ -476,18 +469,11 @@ impl RenderBundleEncoder {
                     check_buffer_usage(buffer.usage, wgt::BufferUsages::INDIRECT)
                         .map_pass_err(scope)?;
 
-                    buffer_memory_init_actions.extend(
-                        buffer
-                            .initialization_status
-                            .check(
-                                offset..(offset + mem::size_of::<wgt::DrawIndirectArgs>() as u64),
-                            )
-                            .map(|range| MemoryInitTrackerAction {
-                                id: buffer_id,
-                                range,
-                                kind: MemoryInitKind::NeedsInitializedMemory,
-                            }),
-                    );
+                    buffer_memory_init_actions.extend(buffer.initialization_status.create_action(
+                        buffer_id,
+                        offset..(offset + mem::size_of::<wgt::DrawIndirectArgs>() as u64),
+                        MemoryInitKind::NeedsInitializedMemory,
+                    ));
 
                     commands.extend(state.index.flush());
                     commands.extend(state.flush_vertices());
@@ -586,7 +572,7 @@ pub struct RenderBundle {
     pub(super) is_ds_read_only: bool,
     pub(crate) device_id: Stored<id::DeviceId>,
     pub(crate) used: TrackerSet,
-    pub(super) buffer_memory_init_actions: Vec<MemoryInitTrackerAction<id::BufferId>>,
+    pub(super) buffer_memory_init_actions: Vec<BufferInitTrackerAction>,
     pub(super) context: RenderPassContext,
     pub(crate) life_guard: LifeGuard,
 }

diff --git a/wgpu-core/src/command/clear.rs b/wgpu-core/src/command/clear.rs
@@ -6,7 +6,7 @@ use crate::{
     command::CommandBuffer,
     hub::{Global, GlobalIdentityHandlerFactory, HalApi, Token},
     id::{BufferId, CommandEncoderId, TextureId},
-    memory_init_tracker::{MemoryInitKind, MemoryInitTrackerAction},
+    init_tracker::MemoryInitKind,
     track::TextureSelector,
 };
 
@@ -127,17 +127,13 @@ impl<G: GlobalIdentityHandlerFactory> Global<G> {
         }
 
         // Mark dest as initialized.
-        cmd_buf.buffer_memory_init_actions.extend(
-            dst_buffer
-                .initialization_status
-                .check(offset..end)
-                .map(|range| MemoryInitTrackerAction {
-                    id: dst,
-                    range,
-                    kind: MemoryInitKind::ImplicitlyInitialized,
-                }),
-        );
-
+        cmd_buf
+            .buffer_memory_init_actions
+            .extend(dst_buffer.initialization_status.create_action(
+                dst,
+                offset..end,
+                MemoryInitKind::ImplicitlyInitialized,
+            ));
         // actual hal barrier & operation
         let dst_barrier = dst_pending.map(|pending| pending.into_hal(dst_buffer));
         let cmd_buf_raw = cmd_buf.encoder.open();

diff --git a/wgpu-core/src/command/compute.rs b/wgpu-core/src/command/compute.rs
@@ -9,7 +9,7 @@ use crate::{
     error::{ErrorFormatter, PrettyError},
     hub::{Global, GlobalIdentityHandlerFactory, HalApi, Storage, Token},
     id,
-    memory_init_tracker::{MemoryInitKind, MemoryInitTrackerAction},
+    init_tracker::MemoryInitKind,
     resource::{Buffer, Texture},
     track::{StatefulTrackerSubset, TrackerSet, UsageConflict, UseExtendError},
     validation::{check_buffer_usage, MissingBufferUsageError},
@@ -366,19 +366,11 @@ impl<G: GlobalIdentityHandlerFactory> Global<G> {
                     cmd_buf.buffer_memory_init_actions.extend(
                         bind_group.used_buffer_ranges.iter().filter_map(
                             |action| match buffer_guard.get(action.id) {
-                                Ok(buffer) => buffer
-                                    .initialization_status
-                                    .check(action.range.clone())
-                                    .map(|range| MemoryInitTrackerAction {
-                                        id: action.id,
-                                        range,
-                                        kind: action.kind,
-                                    }),
+                                Ok(buffer) => buffer.initialization_status.check_action(action),
                                 Err(_) => None,
                             },
                         ),
                     );
-
                     let pipeline_layout_id = state.binder.pipeline_layout_id;
                     let entries = state.binder.assign_group(
                         index as usize,
@@ -565,14 +557,11 @@ impl<G: GlobalIdentityHandlerFactory> Global<G> {
                     let stride = 3 * 4; // 3 integers, x/y/z group size
 
                     cmd_buf.buffer_memory_init_actions.extend(
-                        indirect_buffer
-                            .initialization_status
-                            .check(offset..(offset + stride))
-                            .map(|range| MemoryInitTrackerAction {
-                                id: buffer_id,
-                                range,
-                                kind: MemoryInitKind::NeedsInitializedMemory,
-                            }),
+                        indirect_buffer.initialization_status.create_action(
+                            buffer_id,
+                            offset..(offset + stride),
+                            MemoryInitKind::NeedsInitializedMemory,
+                        ),
                     );
 
                     state

diff --git a/wgpu-core/src/command/mod.rs b/wgpu-core/src/command/mod.rs
@@ -22,7 +22,7 @@ use crate::FastHashMap;
 use crate::{
     hub::{Global, GlobalIdentityHandlerFactory, HalApi, Storage, Token},
     id,
-    memory_init_tracker::{MemoryInitKind, MemoryInitTrackerAction},
+    init_tracker::{BufferInitTrackerAction, MemoryInitKind},
     resource::{Buffer, Texture},
     track::{BufferState, ResourceTracker, TextureState, TrackerSet},
     Label, Stored,
@@ -71,7 +71,7 @@ pub struct BakedCommands<A: hal::Api> {
     pub(crate) encoder: A::CommandEncoder,
     pub(crate) list: Vec<A::CommandBuffer>,
     pub(crate) trackers: TrackerSet,
-    buffer_memory_init_actions: Vec<MemoryInitTrackerAction<id::BufferId>>,
+    buffer_memory_init_actions: Vec<BufferInitTrackerAction>,
 }
 
 pub(crate) struct DestroyedBufferError(pub id::BufferId);
@@ -158,7 +158,7 @@ pub struct CommandBuffer<A: hal::Api> {
     status: CommandEncoderStatus,
     pub(crate) device_id: Stored<id::DeviceId>,
     pub(crate) trackers: TrackerSet,
-    buffer_memory_init_actions: Vec<MemoryInitTrackerAction<id::BufferId>>,
+    buffer_memory_init_actions: Vec<BufferInitTrackerAction>,
     limits: wgt::Limits,
     support_fill_buffer_texture: bool,
     #[cfg(feature = "trace")]

diff --git a/wgpu-core/src/command/query.rs b/wgpu-core/src/command/query.rs
@@ -6,7 +6,7 @@ use crate::{
     command::{CommandBuffer, CommandEncoderError},
     hub::{Global, GlobalIdentityHandlerFactory, HalApi, Storage, Token},
     id::{self, Id, TypedId},
-    memory_init_tracker::{MemoryInitKind, MemoryInitTrackerAction},
+    init_tracker::MemoryInitKind,
     resource::QuerySet,
     track::UseExtendError,
     Epoch, FastHashMap, Index,
@@ -392,16 +392,13 @@ impl<G: GlobalIdentityHandlerFactory> Global<G> {
             .into());
         }
 
-        cmd_buf.buffer_memory_init_actions.extend(
-            dst_buffer
-                .initialization_status
-                .check(buffer_start_offset..buffer_end_offset)
-                .map(|range| MemoryInitTrackerAction {
-                    id: destination,
-                    range,
-                    kind: MemoryInitKind::ImplicitlyInitialized,
-                }),
-        );
+        cmd_buf
+            .buffer_memory_init_actions
+            .extend(dst_buffer.initialization_status.create_action(
+                destination,
+                buffer_start_offset..buffer_end_offset,
+                MemoryInitKind::ImplicitlyInitialized,
+            ));
 
         unsafe {
             raw_encoder.transition_buffers(dst_barrier);