wgpu_core/device/
queue.rs

1use alloc::{boxed::Box, string::ToString, sync::Arc, vec, vec::Vec};
2use core::{
3    iter,
4    mem::{self, ManuallyDrop},
5    num::NonZeroU64,
6    ptr::NonNull,
7    sync::atomic::Ordering,
8};
9use smallvec::SmallVec;
10use thiserror::Error;
11use wgt::{
12    error::{ErrorType, WebGpuError},
13    AccelerationStructureFlags,
14};
15
16use super::{life::LifetimeTracker, Device};
17#[cfg(feature = "trace")]
18use crate::device::trace::{Action, IntoTrace};
19use crate::{
20    api_log,
21    command::{
22        extract_texture_selector, validate_linear_texture_data, validate_texture_buffer_copy,
23        validate_texture_copy_dst_format, validate_texture_copy_range, ClearError,
24        CommandAllocator, CommandBuffer, CommandEncoder, CommandEncoderError, CopySide,
25        TransferError,
26    },
27    device::{DeviceError, WaitIdleError},
28    get_lowest_common_denom,
29    global::Global,
30    hal_label,
31    id::{self, BlasId, QueueId},
32    init_tracker::{has_copy_partial_init_tracker_coverage, TextureInitRange},
33    lock::{rank, Mutex, MutexGuard, RwLock, RwLockWriteGuard},
34    ray_tracing::{BlasCompactReadyPendingClosure, CompactBlasError},
35    resource::{
36        Blas, BlasCompactState, Buffer, BufferAccessError, BufferMapState, DestroyedBuffer,
37        DestroyedResourceError, DestroyedTexture, Fallible, FlushedStagingBuffer,
38        InvalidResourceError, Labeled, ParentDevice, ResourceErrorIdent, StagingBuffer, Texture,
39        TextureInner, Trackable, TrackingData,
40    },
41    resource_log,
42    scratch::ScratchBuffer,
43    snatch::{SnatchGuard, Snatchable},
44    track::{self, Tracker, TrackerIndex},
45    FastHashMap, SubmissionIndex,
46};
47use crate::{device::resource::CommandIndices, resource::RawResourceAccess};
48
49pub struct Queue {
50    raw: Box<dyn hal::DynQueue>,
51    pub(crate) pending_writes: Mutex<PendingWrites>,
52    life_tracker: Mutex<LifetimeTracker>,
53    // The device needs to be dropped last (`Device.zero_buffer` might be referenced by the encoder in pending writes).
54    pub(crate) device: Arc<Device>,
55}
56
57impl Queue {
58    pub(crate) fn new(
59        device: Arc<Device>,
60        raw: Box<dyn hal::DynQueue>,
61        instance_flags: wgt::InstanceFlags,
62    ) -> Result<Self, DeviceError> {
63        let pending_encoder = device
64            .command_allocator
65            .acquire_encoder(device.raw(), raw.as_ref())
66            .map_err(DeviceError::from_hal);
67
68        let pending_encoder = match pending_encoder {
69            Ok(pending_encoder) => pending_encoder,
70            Err(e) => {
71                return Err(e);
72            }
73        };
74
75        let mut pending_writes = PendingWrites::new(pending_encoder, instance_flags);
76
77        let zero_buffer = device.zero_buffer.as_ref();
78        pending_writes.activate();
79        unsafe {
80            pending_writes
81                .command_encoder
82                .transition_buffers(&[hal::BufferBarrier {
83                    buffer: zero_buffer,
84                    usage: hal::StateTransition {
85                        from: wgt::BufferUses::empty(),
86                        to: wgt::BufferUses::COPY_DST,
87                    },
88                }]);
89            pending_writes
90                .command_encoder
91                .clear_buffer(zero_buffer, 0..super::ZERO_BUFFER_SIZE);
92            pending_writes
93                .command_encoder
94                .transition_buffers(&[hal::BufferBarrier {
95                    buffer: zero_buffer,
96                    usage: hal::StateTransition {
97                        from: wgt::BufferUses::COPY_DST,
98                        to: wgt::BufferUses::COPY_SRC,
99                    },
100                }]);
101        }
102
103        Ok(Queue {
104            raw,
105            device,
106            pending_writes: Mutex::new(rank::QUEUE_PENDING_WRITES, pending_writes),
107            life_tracker: Mutex::new(rank::QUEUE_LIFE_TRACKER, LifetimeTracker::new()),
108        })
109    }
110
111    pub(crate) fn raw(&self) -> &dyn hal::DynQueue {
112        self.raw.as_ref()
113    }
114
115    #[track_caller]
116    pub(crate) fn lock_life<'a>(&'a self) -> MutexGuard<'a, LifetimeTracker> {
117        self.life_tracker.lock()
118    }
119
120    pub(crate) fn maintain(
121        &self,
122        submission_index: u64,
123        snatch_guard: &SnatchGuard,
124    ) -> (
125        SmallVec<[SubmittedWorkDoneClosure; 1]>,
126        Vec<super::BufferMapPendingClosure>,
127        Vec<BlasCompactReadyPendingClosure>,
128        bool,
129    ) {
130        let mut life_tracker = self.lock_life();
131        let submission_closures = life_tracker.triage_submissions(submission_index);
132
133        let mapping_closures = life_tracker.handle_mapping(snatch_guard);
134        let blas_closures = life_tracker.handle_compact_read_back();
135
136        let queue_empty = life_tracker.queue_empty();
137
138        (
139            submission_closures,
140            mapping_closures,
141            blas_closures,
142            queue_empty,
143        )
144    }
145}
146
147crate::impl_resource_type!(Queue);
148// TODO: https://github.com/gfx-rs/wgpu/issues/4014
149impl Labeled for Queue {
150    fn label(&self) -> &str {
151        ""
152    }
153}
154crate::impl_parent_device!(Queue);
155crate::impl_storage_item!(Queue);
156
157impl Drop for Queue {
158    fn drop(&mut self) {
159        resource_log!("Drop {}", self.error_ident());
160
161        let last_successful_submission_index = self
162            .device
163            .last_successful_submission_index
164            .load(Ordering::Acquire);
165
166        let fence = self.device.fence.read();
167
168        // Try waiting on the last submission using the following sequence of timeouts
169        let timeouts_in_ms = [100, 200, 400, 800, 1600, 3200];
170
171        for (i, timeout_ms) in timeouts_in_ms.into_iter().enumerate() {
172            let is_last_iter = i == timeouts_in_ms.len() - 1;
173
174            api_log!(
175                "Waiting on last submission. try: {}/{}. timeout: {}ms",
176                i + 1,
177                timeouts_in_ms.len(),
178                timeout_ms
179            );
180
181            let wait_res = unsafe {
182                self.device.raw().wait(
183                    fence.as_ref(),
184                    last_successful_submission_index,
185                    #[cfg(not(target_arch = "wasm32"))]
186                    Some(core::time::Duration::from_millis(timeout_ms)),
187                    #[cfg(target_arch = "wasm32")]
188                    Some(core::time::Duration::ZERO), // WebKit and Chromium don't support a non-0 timeout
189                )
190            };
191            // Note: If we don't panic below we are in UB land (destroying resources while they are still in use by the GPU).
192            match wait_res {
193                Ok(true) => break,
194                Ok(false) => {
195                    // It's fine that we timed out on WebGL; GL objects can be deleted early as they
196                    // will be kept around by the driver if GPU work hasn't finished.
197                    // Moreover, the way we emulate read mappings on WebGL allows us to execute map_buffer earlier than on other
198                    // backends since getBufferSubData is synchronous with respect to the other previously enqueued GL commands.
199                    // Relying on this behavior breaks the clean abstraction wgpu-hal tries to maintain and
200                    // we should find ways to improve this. See https://github.com/gfx-rs/wgpu/issues/6538.
201                    #[cfg(target_arch = "wasm32")]
202                    {
203                        break;
204                    }
205                    #[cfg(not(target_arch = "wasm32"))]
206                    {
207                        if is_last_iter {
208                            panic!(
209                                "We timed out while waiting on the last successful submission to complete!"
210                            );
211                        }
212                    }
213                }
214                Err(e) => match e {
215                    hal::DeviceError::OutOfMemory => {
216                        if is_last_iter {
217                            panic!(
218                                "We ran into an OOM error while waiting on the last successful submission to complete!"
219                            );
220                        }
221                    }
222                    hal::DeviceError::Lost => {
223                        self.device.handle_hal_error(e); // will lose the device
224                        break;
225                    }
226                    hal::DeviceError::Unexpected => {
227                        panic!(
228                            "We ran into an unexpected error while waiting on the last successful submission to complete!"
229                        );
230                    }
231                },
232            }
233        }
234        drop(fence);
235
236        let snatch_guard = self.device.snatchable_lock.read();
237        let (submission_closures, mapping_closures, blas_compact_ready_closures, queue_empty) =
238            self.maintain(last_successful_submission_index, &snatch_guard);
239        drop(snatch_guard);
240
241        assert!(queue_empty);
242
243        let closures = crate::device::UserClosures {
244            mappings: mapping_closures,
245            blas_compact_ready: blas_compact_ready_closures,
246            submissions: submission_closures,
247            device_lost_invocations: SmallVec::new(),
248        };
249
250        closures.fire();
251    }
252}
253
254#[cfg(send_sync)]
255pub type SubmittedWorkDoneClosure = Box<dyn FnOnce() + Send + 'static>;
256#[cfg(not(send_sync))]
257pub type SubmittedWorkDoneClosure = Box<dyn FnOnce() + 'static>;
258
259/// A texture or buffer to be freed soon.
260///
261/// This is just a tagged raw texture or buffer, generally about to be added to
262/// some other more specific container like:
263///
264/// - `PendingWrites::temp_resources`: resources used by queue writes and
265///   unmaps, waiting to be folded in with the next queue submission
266///
267/// - `ActiveSubmission::temp_resources`: temporary resources used by a queue
268///   submission, to be freed when it completes
269#[derive(Debug)]
270pub enum TempResource {
271    StagingBuffer(FlushedStagingBuffer),
272    ScratchBuffer(ScratchBuffer),
273    DestroyedBuffer(DestroyedBuffer),
274    DestroyedTexture(DestroyedTexture),
275}
276
277/// A series of raw [`CommandBuffer`]s that have been submitted to a
278/// queue, and the [`wgpu_hal::CommandEncoder`] that built them.
279///
280/// [`CommandBuffer`]: hal::Api::CommandBuffer
281/// [`wgpu_hal::CommandEncoder`]: hal::CommandEncoder
282pub(crate) struct EncoderInFlight {
283    inner: crate::command::InnerCommandEncoder,
284    pub(crate) trackers: Tracker,
285    pub(crate) temp_resources: Vec<TempResource>,
286    /// We only need to keep these resources alive.
287    _indirect_draw_validation_resources: crate::indirect_validation::DrawResources,
288
289    /// These are the buffers that have been tracked by `PendingWrites`.
290    pub(crate) pending_buffers: FastHashMap<TrackerIndex, Arc<Buffer>>,
291    /// These are the textures that have been tracked by `PendingWrites`.
292    pub(crate) pending_textures: FastHashMap<TrackerIndex, Arc<Texture>>,
293    /// These are the BLASes that have been tracked by `PendingWrites`.
294    pub(crate) pending_blas_s: FastHashMap<TrackerIndex, Arc<Blas>>,
295}
296
297/// A private command encoder for writes made directly on the device
298/// or queue.
299///
300/// Operations like `buffer_unmap`, `queue_write_buffer`, and
301/// `queue_write_texture` need to copy data to the GPU. At the hal
302/// level, this must be done by encoding and submitting commands, but
303/// these operations are not associated with any specific wgpu command
304/// buffer.
305///
306/// Instead, `Device::pending_writes` owns one of these values, which
307/// has its own hal command encoder and resource lists. The commands
308/// accumulated here are automatically submitted to the queue the next
309/// time the user submits a wgpu command buffer, ahead of the user's
310/// commands.
311///
312/// Important:
313/// When locking pending_writes be sure that tracker is not locked
314/// and try to lock trackers for the minimum timespan possible
315///
316/// All uses of [`StagingBuffer`]s end up here.
317#[derive(Debug)]
318pub(crate) struct PendingWrites {
319    // The command encoder needs to be destroyed before any other resource in pending writes.
320    pub command_encoder: Box<dyn hal::DynCommandEncoder>,
321
322    /// True if `command_encoder` is in the "recording" state, as
323    /// described in the docs for the [`wgpu_hal::CommandEncoder`]
324    /// trait.
325    ///
326    /// [`wgpu_hal::CommandEncoder`]: hal::CommandEncoder
327    pub is_recording: bool,
328
329    temp_resources: Vec<TempResource>,
330    dst_buffers: FastHashMap<TrackerIndex, Arc<Buffer>>,
331    dst_textures: FastHashMap<TrackerIndex, Arc<Texture>>,
332    copied_blas_s: FastHashMap<TrackerIndex, Arc<Blas>>,
333    instance_flags: wgt::InstanceFlags,
334}
335
336impl PendingWrites {
337    pub fn new(
338        command_encoder: Box<dyn hal::DynCommandEncoder>,
339        instance_flags: wgt::InstanceFlags,
340    ) -> Self {
341        Self {
342            command_encoder,
343            is_recording: false,
344            temp_resources: Vec::new(),
345            dst_buffers: FastHashMap::default(),
346            dst_textures: FastHashMap::default(),
347            copied_blas_s: FastHashMap::default(),
348            instance_flags,
349        }
350    }
351
352    pub fn insert_buffer(&mut self, buffer: &Arc<Buffer>) {
353        self.dst_buffers
354            .insert(buffer.tracker_index(), buffer.clone());
355    }
356
357    pub fn insert_texture(&mut self, texture: &Arc<Texture>) {
358        self.dst_textures
359            .insert(texture.tracker_index(), texture.clone());
360    }
361
362    pub fn insert_blas(&mut self, blas: &Arc<Blas>) {
363        self.copied_blas_s
364            .insert(blas.tracker_index(), blas.clone());
365    }
366
367    pub fn contains_buffer(&self, buffer: &Arc<Buffer>) -> bool {
368        self.dst_buffers.contains_key(&buffer.tracker_index())
369    }
370
371    pub fn contains_texture(&self, texture: &Arc<Texture>) -> bool {
372        self.dst_textures.contains_key(&texture.tracker_index())
373    }
374
375    pub fn consume_temp(&mut self, resource: TempResource) {
376        self.temp_resources.push(resource);
377    }
378
379    pub fn consume(&mut self, buffer: FlushedStagingBuffer) {
380        self.temp_resources
381            .push(TempResource::StagingBuffer(buffer));
382    }
383
384    fn pre_submit(
385        &mut self,
386        command_allocator: &CommandAllocator,
387        device: &Arc<Device>,
388        queue: &Queue,
389    ) -> Result<Option<EncoderInFlight>, DeviceError> {
390        if self.is_recording {
391            let pending_buffers = mem::take(&mut self.dst_buffers);
392            let pending_textures = mem::take(&mut self.dst_textures);
393            let pending_blas_s = mem::take(&mut self.copied_blas_s);
394
395            let cmd_buf = unsafe { self.command_encoder.end_encoding() }
396                .map_err(|e| device.handle_hal_error(e))?;
397            self.is_recording = false;
398
399            let new_encoder = command_allocator
400                .acquire_encoder(device.raw(), queue.raw())
401                .map_err(|e| device.handle_hal_error(e))?;
402
403            let encoder = EncoderInFlight {
404                inner: crate::command::InnerCommandEncoder {
405                    raw: ManuallyDrop::new(mem::replace(&mut self.command_encoder, new_encoder)),
406                    list: vec![cmd_buf],
407                    device: device.clone(),
408                    is_open: false,
409                    api: crate::command::EncodingApi::InternalUse,
410                    label: "(wgpu internal) PendingWrites command encoder".into(),
411                },
412                trackers: Tracker::new(),
413                temp_resources: mem::take(&mut self.temp_resources),
414                _indirect_draw_validation_resources: crate::indirect_validation::DrawResources::new(
415                    device.clone(),
416                ),
417                pending_buffers,
418                pending_textures,
419                pending_blas_s,
420            };
421            Ok(Some(encoder))
422        } else {
423            self.dst_buffers.clear();
424            self.dst_textures.clear();
425            self.copied_blas_s.clear();
426            Ok(None)
427        }
428    }
429
430    pub fn activate(&mut self) -> &mut dyn hal::DynCommandEncoder {
431        if !self.is_recording {
432            unsafe {
433                self.command_encoder
434                    .begin_encoding(hal_label(
435                        Some("(wgpu internal) PendingWrites"),
436                        self.instance_flags,
437                    ))
438                    .unwrap();
439            }
440            self.is_recording = true;
441        }
442        self.command_encoder.as_mut()
443    }
444}
445
446impl Drop for PendingWrites {
447    fn drop(&mut self) {
448        unsafe {
449            if self.is_recording {
450                self.command_encoder.discard_encoding();
451            }
452        }
453    }
454}
455
456#[derive(Clone, Debug, Error)]
457#[non_exhaustive]
458pub enum QueueWriteError {
459    #[error(transparent)]
460    Queue(#[from] DeviceError),
461    #[error(transparent)]
462    Transfer(#[from] TransferError),
463    #[error(transparent)]
464    MemoryInitFailure(#[from] ClearError),
465    #[error(transparent)]
466    DestroyedResource(#[from] DestroyedResourceError),
467    #[error(transparent)]
468    InvalidResource(#[from] InvalidResourceError),
469}
470
471impl WebGpuError for QueueWriteError {
472    fn webgpu_error_type(&self) -> ErrorType {
473        let e: &dyn WebGpuError = match self {
474            Self::Queue(e) => e,
475            Self::Transfer(e) => e,
476            Self::MemoryInitFailure(e) => e,
477            Self::DestroyedResource(e) => e,
478            Self::InvalidResource(e) => e,
479        };
480        e.webgpu_error_type()
481    }
482}
483
484#[derive(Clone, Debug, Error)]
485#[non_exhaustive]
486pub enum QueueSubmitError {
487    #[error(transparent)]
488    Queue(#[from] DeviceError),
489    #[error(transparent)]
490    DestroyedResource(#[from] DestroyedResourceError),
491    #[error(transparent)]
492    Unmap(#[from] BufferAccessError),
493    #[error("{0} is still mapped")]
494    BufferStillMapped(ResourceErrorIdent),
495    #[error(transparent)]
496    InvalidResource(#[from] InvalidResourceError),
497    #[error(transparent)]
498    CommandEncoder(#[from] CommandEncoderError),
499    #[error(transparent)]
500    ValidateAsActionsError(#[from] crate::ray_tracing::ValidateAsActionsError),
501}
502
503impl WebGpuError for QueueSubmitError {
504    fn webgpu_error_type(&self) -> ErrorType {
505        let e: &dyn WebGpuError = match self {
506            Self::Queue(e) => e,
507            Self::Unmap(e) => e,
508            Self::CommandEncoder(e) => e,
509            Self::ValidateAsActionsError(e) => e,
510            Self::InvalidResource(e) => e,
511            Self::DestroyedResource(_) | Self::BufferStillMapped(_) => {
512                return ErrorType::Validation
513            }
514        };
515        e.webgpu_error_type()
516    }
517}
518
519//TODO: move out common parts of write_xxx.
520
521impl Queue {
522    pub fn write_buffer(
523        &self,
524        buffer: Arc<Buffer>,
525        buffer_offset: wgt::BufferAddress,
526        data: &[u8],
527    ) -> Result<(), QueueWriteError> {
528        profiling::scope!("Queue::write_buffer");
529        api_log!("Queue::write_buffer");
530
531        self.device.check_is_valid()?;
532
533        let data_size = data.len() as wgt::BufferAddress;
534
535        self.same_device_as(buffer.as_ref())?;
536
537        let data_size = if let Some(data_size) = wgt::BufferSize::new(data_size) {
538            data_size
539        } else {
540            // This must happen after parameter validation (so that errors are reported
541            // as required by the spec), but before any side effects.
542            log::trace!("Ignoring write_buffer of size 0");
543            return Ok(());
544        };
545
546        // Platform validation requires that the staging buffer always be
547        // freed, even if an error occurs. All paths from here must call
548        // `device.pending_writes.consume`.
549        let mut staging_buffer = StagingBuffer::new(&self.device, data_size)?;
550
551        let staging_buffer = {
552            profiling::scope!("copy");
553            staging_buffer.write(data);
554            staging_buffer.flush()
555        };
556
557        let snatch_guard = self.device.snatchable_lock.read();
558        let mut pending_writes = self.pending_writes.lock();
559
560        let result = self.write_staging_buffer_impl(
561            &snatch_guard,
562            &mut pending_writes,
563            &staging_buffer,
564            buffer,
565            buffer_offset,
566        );
567
568        drop(snatch_guard);
569
570        pending_writes.consume(staging_buffer);
571
572        drop(pending_writes);
573
574        result
575    }
576
577    pub fn create_staging_buffer(
578        &self,
579        buffer_size: wgt::BufferSize,
580    ) -> Result<(StagingBuffer, NonNull<u8>), QueueWriteError> {
581        profiling::scope!("Queue::create_staging_buffer");
582        resource_log!("Queue::create_staging_buffer");
583
584        self.device.check_is_valid()?;
585
586        let staging_buffer = StagingBuffer::new(&self.device, buffer_size)?;
587        let ptr = unsafe { staging_buffer.ptr() };
588
589        Ok((staging_buffer, ptr))
590    }
591
592    pub fn write_staging_buffer(
593        &self,
594        buffer: Fallible<Buffer>,
595        buffer_offset: wgt::BufferAddress,
596        staging_buffer: StagingBuffer,
597    ) -> Result<(), QueueWriteError> {
598        profiling::scope!("Queue::write_staging_buffer");
599
600        self.device.check_is_valid()?;
601
602        let buffer = buffer.get()?;
603
604        // At this point, we have taken ownership of the staging_buffer from the
605        // user. Platform validation requires that the staging buffer always
606        // be freed, even if an error occurs. All paths from here must call
607        // `device.pending_writes.consume`.
608        let staging_buffer = staging_buffer.flush();
609
610        let snatch_guard = self.device.snatchable_lock.read();
611        let mut pending_writes = self.pending_writes.lock();
612
613        let result = self.write_staging_buffer_impl(
614            &snatch_guard,
615            &mut pending_writes,
616            &staging_buffer,
617            buffer,
618            buffer_offset,
619        );
620
621        drop(snatch_guard);
622
623        pending_writes.consume(staging_buffer);
624
625        drop(pending_writes);
626
627        result
628    }
629
630    pub fn validate_write_buffer(
631        &self,
632        buffer: Fallible<Buffer>,
633        buffer_offset: u64,
634        buffer_size: wgt::BufferSize,
635    ) -> Result<(), QueueWriteError> {
636        profiling::scope!("Queue::validate_write_buffer");
637
638        self.device.check_is_valid()?;
639
640        let buffer = buffer.get()?;
641
642        self.validate_write_buffer_impl(&buffer, buffer_offset, buffer_size)?;
643
644        Ok(())
645    }
646
647    fn validate_write_buffer_impl(
648        &self,
649        buffer: &Buffer,
650        buffer_offset: u64,
651        buffer_size: wgt::BufferSize,
652    ) -> Result<(), TransferError> {
653        if !matches!(&*buffer.map_state.lock(), BufferMapState::Idle) {
654            return Err(TransferError::BufferNotAvailable);
655        }
656        buffer.check_usage(wgt::BufferUsages::COPY_DST)?;
657        if !buffer_size.get().is_multiple_of(wgt::COPY_BUFFER_ALIGNMENT) {
658            return Err(TransferError::UnalignedCopySize(buffer_size.get()));
659        }
660        if !buffer_offset.is_multiple_of(wgt::COPY_BUFFER_ALIGNMENT) {
661            return Err(TransferError::UnalignedBufferOffset(buffer_offset));
662        }
663
664        if buffer_offset > buffer.size {
665            return Err(TransferError::BufferStartOffsetOverrun {
666                start_offset: buffer_offset,
667                buffer_size: buffer.size,
668                side: CopySide::Destination,
669            });
670        }
671        if buffer_size.get() > buffer.size - buffer_offset {
672            return Err(TransferError::BufferEndOffsetOverrun {
673                start_offset: buffer_offset,
674                size: buffer_size.get(),
675                buffer_size: buffer.size,
676                side: CopySide::Destination,
677            });
678        }
679
680        Ok(())
681    }
682
683    fn write_staging_buffer_impl(
684        &self,
685        snatch_guard: &SnatchGuard,
686        pending_writes: &mut PendingWrites,
687        staging_buffer: &FlushedStagingBuffer,
688        buffer: Arc<Buffer>,
689        buffer_offset: u64,
690    ) -> Result<(), QueueWriteError> {
691        self.device.check_is_valid()?;
692
693        let transition = {
694            let mut trackers = self.device.trackers.lock();
695            trackers
696                .buffers
697                .set_single(&buffer, wgt::BufferUses::COPY_DST)
698        };
699
700        let dst_raw = buffer.try_raw(snatch_guard)?;
701
702        self.same_device_as(buffer.as_ref())?;
703
704        self.validate_write_buffer_impl(&buffer, buffer_offset, staging_buffer.size)?;
705
706        let region = hal::BufferCopy {
707            src_offset: 0,
708            dst_offset: buffer_offset,
709            size: staging_buffer.size,
710        };
711        let barriers = iter::once(hal::BufferBarrier {
712            buffer: staging_buffer.raw(),
713            usage: hal::StateTransition {
714                from: wgt::BufferUses::MAP_WRITE,
715                to: wgt::BufferUses::COPY_SRC,
716            },
717        })
718        .chain(transition.map(|pending| pending.into_hal(&buffer, snatch_guard)))
719        .collect::<Vec<_>>();
720        let encoder = pending_writes.activate();
721        unsafe {
722            encoder.transition_buffers(&barriers);
723            encoder.copy_buffer_to_buffer(staging_buffer.raw(), dst_raw, &[region]);
724        }
725
726        pending_writes.insert_buffer(&buffer);
727
728        // Ensure the overwritten bytes are marked as initialized so
729        // they don't need to be nulled prior to mapping or binding.
730        {
731            buffer
732                .initialization_status
733                .write()
734                .drain(buffer_offset..(buffer_offset + staging_buffer.size.get()));
735        }
736
737        Ok(())
738    }
739
740    pub fn write_texture(
741        &self,
742        destination: wgt::TexelCopyTextureInfo<Arc<Texture>>,
743        data: &[u8],
744        data_layout: &wgt::TexelCopyBufferLayout,
745        size: &wgt::Extent3d,
746    ) -> Result<(), QueueWriteError> {
747        profiling::scope!("Queue::write_texture");
748        api_log!("Queue::write_texture");
749
750        self.device.check_is_valid()?;
751
752        let dst = destination.texture;
753        let destination = wgt::TexelCopyTextureInfo {
754            texture: (),
755            mip_level: destination.mip_level,
756            origin: destination.origin,
757            aspect: destination.aspect,
758        };
759
760        self.same_device_as(dst.as_ref())?;
761
762        dst.check_usage(wgt::TextureUsages::COPY_DST)
763            .map_err(TransferError::MissingTextureUsage)?;
764
765        // Note: Doing the copy range validation early is important because ensures that the
766        // dimensions are not going to cause overflow in other parts of the validation.
767        let (hal_copy_size, array_layer_count) =
768            validate_texture_copy_range(&destination, &dst.desc, CopySide::Destination, size)?;
769
770        let (selector, dst_base) = extract_texture_selector(&destination, size, &dst)?;
771
772        validate_texture_copy_dst_format(dst.desc.format, destination.aspect)?;
773
774        validate_texture_buffer_copy(
775            &destination,
776            dst_base.aspect,
777            &dst.desc,
778            data_layout,
779            false, // alignment not required for buffer offset or bytes per row
780        )?;
781
782        // Note: `_source_bytes_per_array_layer` is ignored since we
783        // have a staging copy, and it can have a different value.
784        let (required_bytes_in_copy, _source_bytes_per_array_layer, _) =
785            validate_linear_texture_data(
786                data_layout,
787                dst.desc.format,
788                destination.aspect,
789                data.len() as wgt::BufferAddress,
790                CopySide::Source,
791                size,
792            )?;
793
794        if dst.desc.format.is_depth_stencil_format() {
795            self.device
796                .require_downlevel_flags(wgt::DownlevelFlags::DEPTH_TEXTURE_AND_BUFFER_COPIES)
797                .map_err(TransferError::from)?;
798        }
799
800        let snatch_guard = self.device.snatchable_lock.read();
801
802        let dst_raw = dst.try_raw(&snatch_guard)?;
803
804        // This must happen after parameter validation (so that errors are reported
805        // as required by the spec), but before any side effects.
806        if size.width == 0 || size.height == 0 || size.depth_or_array_layers == 0 {
807            log::trace!("Ignoring write_texture of size 0");
808            return Ok(());
809        }
810
811        let mut pending_writes = self.pending_writes.lock();
812        let encoder = pending_writes.activate();
813
814        // If the copy does not fully cover the layers, we need to initialize to
815        // zero *first* as we don't keep track of partial texture layer inits.
816        //
817        // Strictly speaking we only need to clear the areas of a layer
818        // untouched, but this would get increasingly messy.
819        let init_layer_range = if dst.desc.dimension == wgt::TextureDimension::D3 {
820            // volume textures don't have a layer range as array volumes aren't supported
821            0..1
822        } else {
823            destination.origin.z..destination.origin.z + size.depth_or_array_layers
824        };
825        let mut dst_initialization_status = dst.initialization_status.write();
826        if dst_initialization_status.mips[destination.mip_level as usize]
827            .check(init_layer_range.clone())
828            .is_some()
829        {
830            if has_copy_partial_init_tracker_coverage(size, destination.mip_level, &dst.desc) {
831                for layer_range in dst_initialization_status.mips[destination.mip_level as usize]
832                    .drain(init_layer_range)
833                    .collect::<Vec<core::ops::Range<u32>>>()
834                {
835                    let mut trackers = self.device.trackers.lock();
836                    crate::command::clear_texture(
837                        &dst,
838                        TextureInitRange {
839                            mip_range: destination.mip_level..(destination.mip_level + 1),
840                            layer_range,
841                        },
842                        encoder,
843                        &mut trackers.textures,
844                        &self.device.alignments,
845                        self.device.zero_buffer.as_ref(),
846                        &snatch_guard,
847                        self.device.instance_flags,
848                    )
849                    .map_err(QueueWriteError::from)?;
850                }
851            } else {
852                dst_initialization_status.mips[destination.mip_level as usize]
853                    .drain(init_layer_range);
854            }
855        }
856
857        let (block_width, block_height) = dst.desc.format.block_dimensions();
858        let width_in_blocks = size.width / block_width;
859        let height_in_blocks = size.height / block_height;
860
861        let block_size = dst
862            .desc
863            .format
864            .block_copy_size(Some(destination.aspect))
865            .unwrap();
866        let bytes_in_last_row = width_in_blocks * block_size;
867
868        let bytes_per_row = data_layout.bytes_per_row.unwrap_or(bytes_in_last_row);
869        let rows_per_image = data_layout.rows_per_image.unwrap_or(height_in_blocks);
870
871        let bytes_per_row_alignment = get_lowest_common_denom(
872            self.device.alignments.buffer_copy_pitch.get() as u32,
873            block_size,
874        );
875        let stage_bytes_per_row = wgt::math::align_to(bytes_in_last_row, bytes_per_row_alignment);
876
877        // Platform validation requires that the staging buffer always be
878        // freed, even if an error occurs. All paths from here must call
879        // `device.pending_writes.consume`.
880        let staging_buffer = if stage_bytes_per_row == bytes_per_row {
881            profiling::scope!("copy aligned");
882            // Fast path if the data is already being aligned optimally.
883            let stage_size = wgt::BufferSize::new(required_bytes_in_copy).unwrap();
884            let mut staging_buffer = StagingBuffer::new(&self.device, stage_size)?;
885            staging_buffer.write(&data[data_layout.offset as usize..]);
886            staging_buffer
887        } else {
888            profiling::scope!("copy chunked");
889            // Copy row by row into the optimal alignment.
890            let block_rows_in_copy =
891                (size.depth_or_array_layers - 1) * rows_per_image + height_in_blocks;
892            let stage_size =
893                wgt::BufferSize::new(stage_bytes_per_row as u64 * block_rows_in_copy as u64)
894                    .unwrap();
895            let mut staging_buffer = StagingBuffer::new(&self.device, stage_size)?;
896            for layer in 0..size.depth_or_array_layers {
897                let rows_offset = layer * rows_per_image;
898                for row in rows_offset..rows_offset + height_in_blocks {
899                    let src_offset = data_layout.offset as u32 + row * bytes_per_row;
900                    let dst_offset = row * stage_bytes_per_row;
901                    unsafe {
902                        staging_buffer.write_with_offset(
903                            data,
904                            src_offset as isize,
905                            dst_offset as isize,
906                            bytes_in_last_row as usize,
907                        )
908                    }
909                }
910            }
911            staging_buffer
912        };
913
914        let staging_buffer = staging_buffer.flush();
915
916        let regions = (0..array_layer_count)
917            .map(|array_layer_offset| {
918                let mut texture_base = dst_base.clone();
919                texture_base.array_layer += array_layer_offset;
920                hal::BufferTextureCopy {
921                    buffer_layout: wgt::TexelCopyBufferLayout {
922                        offset: array_layer_offset as u64
923                            * rows_per_image as u64
924                            * stage_bytes_per_row as u64,
925                        bytes_per_row: Some(stage_bytes_per_row),
926                        rows_per_image: Some(rows_per_image),
927                    },
928                    texture_base,
929                    size: hal_copy_size,
930                }
931            })
932            .collect::<Vec<_>>();
933
934        {
935            let buffer_barrier = hal::BufferBarrier {
936                buffer: staging_buffer.raw(),
937                usage: hal::StateTransition {
938                    from: wgt::BufferUses::MAP_WRITE,
939                    to: wgt::BufferUses::COPY_SRC,
940                },
941            };
942
943            let mut trackers = self.device.trackers.lock();
944            let transition =
945                trackers
946                    .textures
947                    .set_single(&dst, selector, wgt::TextureUses::COPY_DST);
948            let texture_barriers = transition
949                .map(|pending| pending.into_hal(dst_raw))
950                .collect::<Vec<_>>();
951
952            unsafe {
953                encoder.transition_textures(&texture_barriers);
954                encoder.transition_buffers(&[buffer_barrier]);
955                encoder.copy_buffer_to_texture(staging_buffer.raw(), dst_raw, &regions);
956            }
957        }
958
959        pending_writes.consume(staging_buffer);
960        pending_writes.insert_texture(&dst);
961
962        Ok(())
963    }
964
965    #[cfg(webgl)]
966    pub fn copy_external_image_to_texture(
967        &self,
968        source: &wgt::CopyExternalImageSourceInfo,
969        destination: wgt::CopyExternalImageDestInfo<Fallible<Texture>>,
970        size: wgt::Extent3d,
971    ) -> Result<(), QueueWriteError> {
972        use crate::conv;
973
974        profiling::scope!("Queue::copy_external_image_to_texture");
975
976        self.device.check_is_valid()?;
977
978        let mut needs_flag = false;
979        needs_flag |= matches!(source.source, wgt::ExternalImageSource::OffscreenCanvas(_));
980        needs_flag |= source.origin != wgt::Origin2d::ZERO;
981        needs_flag |= destination.color_space != wgt::PredefinedColorSpace::Srgb;
982        #[allow(clippy::bool_comparison)]
983        if matches!(source.source, wgt::ExternalImageSource::ImageBitmap(_)) {
984            needs_flag |= source.flip_y != false;
985            needs_flag |= destination.premultiplied_alpha != false;
986        }
987
988        if needs_flag {
989            self.device
990                .require_downlevel_flags(wgt::DownlevelFlags::UNRESTRICTED_EXTERNAL_TEXTURE_COPIES)
991                .map_err(TransferError::from)?;
992        }
993
994        let src_width = source.source.width();
995        let src_height = source.source.height();
996
997        let dst = destination.texture.get()?;
998        let premultiplied_alpha = destination.premultiplied_alpha;
999        let destination = wgt::TexelCopyTextureInfo {
1000            texture: (),
1001            mip_level: destination.mip_level,
1002            origin: destination.origin,
1003            aspect: destination.aspect,
1004        };
1005
1006        if !conv::is_valid_external_image_copy_dst_texture_format(dst.desc.format) {
1007            return Err(
1008                TransferError::ExternalCopyToForbiddenTextureFormat(dst.desc.format).into(),
1009            );
1010        }
1011        if dst.desc.dimension != wgt::TextureDimension::D2 {
1012            return Err(TransferError::InvalidDimensionExternal.into());
1013        }
1014        dst.check_usage(wgt::TextureUsages::COPY_DST | wgt::TextureUsages::RENDER_ATTACHMENT)
1015            .map_err(TransferError::MissingTextureUsage)?;
1016        if dst.desc.sample_count != 1 {
1017            return Err(TransferError::InvalidSampleCount {
1018                sample_count: dst.desc.sample_count,
1019            }
1020            .into());
1021        }
1022
1023        if source.origin.x + size.width > src_width {
1024            return Err(TransferError::TextureOverrun {
1025                start_offset: source.origin.x,
1026                end_offset: source.origin.x + size.width,
1027                texture_size: src_width,
1028                dimension: crate::resource::TextureErrorDimension::X,
1029                side: CopySide::Source,
1030            }
1031            .into());
1032        }
1033        if source.origin.y + size.height > src_height {
1034            return Err(TransferError::TextureOverrun {
1035                start_offset: source.origin.y,
1036                end_offset: source.origin.y + size.height,
1037                texture_size: src_height,
1038                dimension: crate::resource::TextureErrorDimension::Y,
1039                side: CopySide::Source,
1040            }
1041            .into());
1042        }
1043        if size.depth_or_array_layers != 1 {
1044            return Err(TransferError::TextureOverrun {
1045                start_offset: 0,
1046                end_offset: size.depth_or_array_layers,
1047                texture_size: 1,
1048                dimension: crate::resource::TextureErrorDimension::Z,
1049                side: CopySide::Source,
1050            }
1051            .into());
1052        }
1053
1054        // Note: Doing the copy range validation early is important because ensures that the
1055        // dimensions are not going to cause overflow in other parts of the validation.
1056        let (hal_copy_size, _) =
1057            validate_texture_copy_range(&destination, &dst.desc, CopySide::Destination, &size)?;
1058
1059        let (selector, dst_base) = extract_texture_selector(&destination, &size, &dst)?;
1060
1061        // This must happen after parameter validation (so that errors are reported
1062        // as required by the spec), but before any side effects.
1063        if size.width == 0 || size.height == 0 || size.depth_or_array_layers == 0 {
1064            log::trace!("Ignoring copy_external_image_to_texture of size 0");
1065            return Ok(());
1066        }
1067
1068        let mut pending_writes = self.pending_writes.lock();
1069        let encoder = pending_writes.activate();
1070
1071        // If the copy does not fully cover the layers, we need to initialize to
1072        // zero *first* as we don't keep track of partial texture layer inits.
1073        //
1074        // Strictly speaking we only need to clear the areas of a layer
1075        // untouched, but this would get increasingly messy.
1076        let init_layer_range = if dst.desc.dimension == wgt::TextureDimension::D3 {
1077            // volume textures don't have a layer range as array volumes aren't supported
1078            0..1
1079        } else {
1080            destination.origin.z..destination.origin.z + size.depth_or_array_layers
1081        };
1082        let mut dst_initialization_status = dst.initialization_status.write();
1083        if dst_initialization_status.mips[destination.mip_level as usize]
1084            .check(init_layer_range.clone())
1085            .is_some()
1086        {
1087            if has_copy_partial_init_tracker_coverage(&size, destination.mip_level, &dst.desc) {
1088                for layer_range in dst_initialization_status.mips[destination.mip_level as usize]
1089                    .drain(init_layer_range)
1090                    .collect::<Vec<core::ops::Range<u32>>>()
1091                {
1092                    let mut trackers = self.device.trackers.lock();
1093                    crate::command::clear_texture(
1094                        &dst,
1095                        TextureInitRange {
1096                            mip_range: destination.mip_level..(destination.mip_level + 1),
1097                            layer_range,
1098                        },
1099                        encoder,
1100                        &mut trackers.textures,
1101                        &self.device.alignments,
1102                        self.device.zero_buffer.as_ref(),
1103                        &self.device.snatchable_lock.read(),
1104                        self.device.instance_flags,
1105                    )
1106                    .map_err(QueueWriteError::from)?;
1107                }
1108            } else {
1109                dst_initialization_status.mips[destination.mip_level as usize]
1110                    .drain(init_layer_range);
1111            }
1112        }
1113
1114        let snatch_guard = self.device.snatchable_lock.read();
1115        let dst_raw = dst.try_raw(&snatch_guard)?;
1116
1117        let regions = hal::TextureCopy {
1118            src_base: hal::TextureCopyBase {
1119                mip_level: 0,
1120                array_layer: 0,
1121                origin: source.origin.to_3d(0),
1122                aspect: hal::FormatAspects::COLOR,
1123            },
1124            dst_base,
1125            size: hal_copy_size,
1126        };
1127
1128        let mut trackers = self.device.trackers.lock();
1129        let transitions = trackers
1130            .textures
1131            .set_single(&dst, selector, wgt::TextureUses::COPY_DST);
1132
1133        // `copy_external_image_to_texture` is exclusive to the WebGL backend.
1134        // Don't go through the `DynCommandEncoder` abstraction and directly to the WebGL backend.
1135        let encoder_webgl = encoder
1136            .as_any_mut()
1137            .downcast_mut::<hal::gles::CommandEncoder>()
1138            .unwrap();
1139        let dst_raw_webgl = dst_raw
1140            .as_any()
1141            .downcast_ref::<hal::gles::Texture>()
1142            .unwrap();
1143        let transitions_webgl = transitions.map(|pending| {
1144            let dyn_transition = pending.into_hal(dst_raw);
1145            hal::TextureBarrier {
1146                texture: dst_raw_webgl,
1147                range: dyn_transition.range,
1148                usage: dyn_transition.usage,
1149            }
1150        });
1151
1152        use hal::CommandEncoder as _;
1153        unsafe {
1154            encoder_webgl.transition_textures(transitions_webgl);
1155            encoder_webgl.copy_external_image_to_texture(
1156                source,
1157                dst_raw_webgl,
1158                premultiplied_alpha,
1159                iter::once(regions),
1160            );
1161        }
1162
1163        Ok(())
1164    }
1165
1166    #[cfg(feature = "trace")]
1167    fn trace_submission(
1168        &self,
1169        submit_index: SubmissionIndex,
1170        commands: Vec<crate::command::Command<crate::command::PointerReferences>>,
1171    ) {
1172        if let Some(ref mut trace) = *self.device.trace.lock() {
1173            trace.add(Action::Submit(submit_index, commands));
1174        }
1175    }
1176
1177    #[cfg(feature = "trace")]
1178    fn trace_failed_submission(
1179        &self,
1180        submit_index: SubmissionIndex,
1181        commands: Option<Vec<crate::command::Command<crate::command::PointerReferences>>>,
1182        error: alloc::string::String,
1183    ) {
1184        if let Some(ref mut trace) = *self.device.trace.lock() {
1185            trace.add(Action::FailedCommands {
1186                commands,
1187                failed_at_submit: Some(submit_index),
1188                error,
1189            });
1190        }
1191    }
1192
1193    pub fn submit(
1194        &self,
1195        command_buffers: &[Arc<CommandBuffer>],
1196    ) -> Result<SubmissionIndex, (SubmissionIndex, QueueSubmitError)> {
1197        profiling::scope!("Queue::submit");
1198        api_log!("Queue::submit");
1199
1200        let submit_index;
1201
1202        let res = 'error: {
1203            let snatch_guard = self.device.snatchable_lock.read();
1204
1205            // Fence lock must be acquired after the snatch lock everywhere to avoid deadlocks.
1206            let mut fence = self.device.fence.write();
1207
1208            let mut command_index_guard = self.device.command_indices.write();
1209            command_index_guard.active_submission_index += 1;
1210            submit_index = command_index_guard.active_submission_index;
1211
1212            if let Err(e) = self.device.check_is_valid() {
1213                break 'error Err(e.into());
1214            }
1215
1216            let mut active_executions = Vec::new();
1217
1218            let mut used_surface_textures = track::TextureUsageScope::default();
1219
1220            // Use a hashmap here to deduplicate the surface textures that are used in the command buffers.
1221            // This avoids vulkan deadlocking from the same surface texture being submitted multiple times.
1222            let mut submit_surface_textures_owned = FastHashMap::default();
1223
1224            {
1225                if !command_buffers.is_empty() {
1226                    profiling::scope!("prepare");
1227
1228                    let mut first_error = None;
1229
1230                    //TODO: if multiple command buffers are submitted, we can re-use the last
1231                    // native command buffer of the previous chain instead of always creating
1232                    // a temporary one, since the chains are not finished.
1233
1234                    // finish all the command buffers first
1235                    for command_buffer in command_buffers {
1236                        profiling::scope!("process command buffer");
1237
1238                        // we reset the used surface textures every time we use
1239                        // it, so make sure to set_size on it.
1240                        used_surface_textures.set_size(self.device.tracker_indices.textures.size());
1241
1242                        // Note that we are required to invalidate all command buffers in both the success and failure paths.
1243                        // This is why we `continue` and don't early return via `?`.
1244                        #[allow(unused_mut)]
1245                        let mut cmd_buf_data = command_buffer.take_finished();
1246
1247                        if first_error.is_some() {
1248                            continue;
1249                        }
1250
1251                        #[cfg(feature = "trace")]
1252                        let trace_commands = cmd_buf_data
1253                            .as_mut()
1254                            .ok()
1255                            .and_then(|data| mem::take(&mut data.trace_commands));
1256
1257                        let mut baked = match cmd_buf_data {
1258                            Ok(cmd_buf_data) => {
1259                                let res = validate_command_buffer(
1260                                    command_buffer,
1261                                    self,
1262                                    &cmd_buf_data,
1263                                    &snatch_guard,
1264                                    &mut submit_surface_textures_owned,
1265                                    &mut used_surface_textures,
1266                                    &mut command_index_guard,
1267                                );
1268                                if let Err(err) = res {
1269                                    #[cfg(feature = "trace")]
1270                                    self.trace_failed_submission(
1271                                        submit_index,
1272                                        trace_commands,
1273                                        err.to_string(),
1274                                    );
1275                                    first_error.get_or_insert(err);
1276                                    continue;
1277                                }
1278
1279                                #[cfg(feature = "trace")]
1280                                if let Some(commands) = trace_commands {
1281                                    self.trace_submission(submit_index, commands);
1282                                }
1283
1284                                cmd_buf_data.set_acceleration_structure_dependencies(&snatch_guard);
1285                                cmd_buf_data.into_baked_commands()
1286                            }
1287                            Err(err) => {
1288                                #[cfg(feature = "trace")]
1289                                self.trace_failed_submission(
1290                                    submit_index,
1291                                    trace_commands,
1292                                    err.to_string(),
1293                                );
1294                                first_error.get_or_insert(err.into());
1295                                continue;
1296                            }
1297                        };
1298
1299                        // execute resource transitions
1300                        if let Err(e) = baked.encoder.open_pass(hal_label(
1301                            Some("(wgpu internal) Transit"),
1302                            self.device.instance_flags,
1303                        )) {
1304                            break 'error Err(e.into());
1305                        }
1306
1307                        //Note: locking the trackers has to be done after the storages
1308                        let mut trackers = self.device.trackers.lock();
1309                        if let Err(e) = baked.initialize_buffer_memory(&mut trackers, &snatch_guard)
1310                        {
1311                            break 'error Err(e.into());
1312                        }
1313                        if let Err(e) = baked.initialize_texture_memory(
1314                            &mut trackers,
1315                            &self.device,
1316                            &snatch_guard,
1317                        ) {
1318                            break 'error Err(e.into());
1319                        }
1320
1321                        //Note: stateless trackers are not merged:
1322                        // device already knows these resources exist.
1323                        CommandEncoder::insert_barriers_from_device_tracker(
1324                            baked.encoder.raw.as_mut(),
1325                            &mut trackers,
1326                            &baked.trackers,
1327                            &snatch_guard,
1328                        );
1329
1330                        if let Err(e) = baked.encoder.close_and_push_front() {
1331                            break 'error Err(e.into());
1332                        }
1333
1334                        // Transition surface textures into `Present` state.
1335                        // Note: we could technically do it after all of the command buffers,
1336                        // but here we have a command encoder by hand, so it's easier to use it.
1337                        if !used_surface_textures.is_empty() {
1338                            if let Err(e) = baked.encoder.open_pass(hal_label(
1339                                Some("(wgpu internal) Present"),
1340                                self.device.instance_flags,
1341                            )) {
1342                                break 'error Err(e.into());
1343                            }
1344                            let texture_barriers = trackers
1345                                .textures
1346                                .set_from_usage_scope_and_drain_transitions(
1347                                    &used_surface_textures,
1348                                    &snatch_guard,
1349                                )
1350                                .collect::<Vec<_>>();
1351                            unsafe {
1352                                baked.encoder.raw.transition_textures(&texture_barriers);
1353                            };
1354                            if let Err(e) = baked.encoder.close() {
1355                                break 'error Err(e.into());
1356                            }
1357                            used_surface_textures = track::TextureUsageScope::default();
1358                        }
1359
1360                        // done
1361                        active_executions.push(EncoderInFlight {
1362                            inner: baked.encoder,
1363                            trackers: baked.trackers,
1364                            temp_resources: baked.temp_resources,
1365                            _indirect_draw_validation_resources: baked
1366                                .indirect_draw_validation_resources,
1367                            pending_buffers: FastHashMap::default(),
1368                            pending_textures: FastHashMap::default(),
1369                            pending_blas_s: FastHashMap::default(),
1370                        });
1371                    }
1372
1373                    if let Some(first_error) = first_error {
1374                        break 'error Err(first_error);
1375                    }
1376                }
1377            }
1378
1379            let mut pending_writes = self.pending_writes.lock();
1380
1381            {
1382                used_surface_textures.set_size(self.device.tracker_indices.textures.size());
1383                for texture in pending_writes.dst_textures.values() {
1384                    match texture.try_inner(&snatch_guard) {
1385                        Ok(TextureInner::Native { .. }) => {}
1386                        Ok(TextureInner::Surface { .. }) => {
1387                            // Compare the Arcs by pointer as Textures don't implement Eq
1388                            submit_surface_textures_owned
1389                                .insert(Arc::as_ptr(texture), texture.clone());
1390
1391                            unsafe {
1392                                used_surface_textures
1393                                    .merge_single(texture, None, wgt::TextureUses::PRESENT)
1394                                    .unwrap()
1395                            };
1396                        }
1397                        // The texture must not have been destroyed when its usage here was
1398                        // encoded. If it was destroyed after that, then it was transferred
1399                        // to `pending_writes.temp_resources` at the time of destruction, so
1400                        // we are still okay to use it.
1401                        Err(DestroyedResourceError(_)) => {}
1402                    }
1403                }
1404
1405                if !used_surface_textures.is_empty() {
1406                    let mut trackers = self.device.trackers.lock();
1407
1408                    let texture_barriers = trackers
1409                        .textures
1410                        .set_from_usage_scope_and_drain_transitions(
1411                            &used_surface_textures,
1412                            &snatch_guard,
1413                        )
1414                        .collect::<Vec<_>>();
1415                    unsafe {
1416                        pending_writes
1417                            .command_encoder
1418                            .transition_textures(&texture_barriers);
1419                    };
1420                }
1421            }
1422
1423            match pending_writes.pre_submit(&self.device.command_allocator, &self.device, self) {
1424                Ok(Some(pending_execution)) => {
1425                    active_executions.insert(0, pending_execution);
1426                }
1427                Ok(None) => {}
1428                Err(e) => break 'error Err(e.into()),
1429            }
1430            let hal_command_buffers = active_executions
1431                .iter()
1432                .flat_map(|e| e.inner.list.iter().map(|b| b.as_ref()))
1433                .collect::<Vec<_>>();
1434
1435            {
1436                let mut submit_surface_textures =
1437                    SmallVec::<[&dyn hal::DynSurfaceTexture; 2]>::with_capacity(
1438                        submit_surface_textures_owned.len(),
1439                    );
1440
1441                for texture in submit_surface_textures_owned.values() {
1442                    let raw = match texture.inner.get(&snatch_guard) {
1443                        Some(TextureInner::Surface { raw, .. }) => raw.as_ref(),
1444                        _ => unreachable!(),
1445                    };
1446                    submit_surface_textures.push(raw);
1447                }
1448
1449                if let Err(e) = unsafe {
1450                    self.raw().submit(
1451                        &hal_command_buffers,
1452                        &submit_surface_textures,
1453                        (fence.as_mut(), submit_index),
1454                    )
1455                }
1456                .map_err(|e| self.device.handle_hal_error(e))
1457                {
1458                    break 'error Err(e.into());
1459                }
1460
1461                drop(command_index_guard);
1462
1463                // Advance the successful submission index.
1464                self.device
1465                    .last_successful_submission_index
1466                    .fetch_max(submit_index, Ordering::SeqCst);
1467            }
1468
1469            profiling::scope!("cleanup");
1470
1471            // this will register the new submission to the life time tracker
1472            self.lock_life()
1473                .track_submission(submit_index, active_executions);
1474            drop(pending_writes);
1475
1476            // This will schedule destruction of all resources that are no longer needed
1477            // by the user but used in the command stream, among other things.
1478            let fence_guard = RwLockWriteGuard::downgrade(fence);
1479            let (closures, result) =
1480                self.device
1481                    .maintain(fence_guard, wgt::PollType::Poll, snatch_guard);
1482            match result {
1483                Ok(status) => {
1484                    debug_assert!(matches!(
1485                        status,
1486                        wgt::PollStatus::QueueEmpty | wgt::PollStatus::Poll
1487                    ));
1488                }
1489                Err(WaitIdleError::Device(err)) => break 'error Err(QueueSubmitError::Queue(err)),
1490                Err(WaitIdleError::WrongSubmissionIndex(..)) => {
1491                    unreachable!("Cannot get WrongSubmissionIndex from Poll")
1492                }
1493                Err(WaitIdleError::Timeout) => unreachable!("Cannot get Timeout from Poll"),
1494            };
1495
1496            Ok(closures)
1497        };
1498
1499        let callbacks = match res {
1500            Ok(ok) => ok,
1501            Err(e) => return Err((submit_index, e)),
1502        };
1503
1504        // the closures should execute with nothing locked!
1505        callbacks.fire();
1506
1507        self.device.lose_if_oom();
1508
1509        api_log!("Queue::submit returned submit index {submit_index}");
1510
1511        Ok(submit_index)
1512    }
1513
1514    pub fn get_timestamp_period(&self) -> f32 {
1515        unsafe { self.raw().get_timestamp_period() }
1516    }
1517
1518    /// `closure` is guaranteed to be called.
1519    pub fn on_submitted_work_done(
1520        &self,
1521        closure: SubmittedWorkDoneClosure,
1522    ) -> Option<SubmissionIndex> {
1523        api_log!("Queue::on_submitted_work_done");
1524        //TODO: flush pending writes
1525        self.lock_life().add_work_done_closure(closure)
1526    }
1527
1528    pub fn compact_blas(&self, blas: &Arc<Blas>) -> Result<Arc<Blas>, CompactBlasError> {
1529        profiling::scope!("Queue::compact_blas");
1530        api_log!("Queue::compact_blas");
1531
1532        let new_label = blas.label.clone() + " (compacted)";
1533
1534        self.device.check_is_valid()?;
1535        self.same_device_as(blas.as_ref())?;
1536
1537        let device = blas.device.clone();
1538
1539        let snatch_guard = device.snatchable_lock.read();
1540
1541        let BlasCompactState::Ready { size } = *blas.compacted_state.lock() else {
1542            return Err(CompactBlasError::BlasNotReady);
1543        };
1544
1545        let mut size_info = blas.size_info;
1546        size_info.acceleration_structure_size = size;
1547
1548        let mut pending_writes = self.pending_writes.lock();
1549        let cmd_buf_raw = pending_writes.activate();
1550
1551        let raw = unsafe {
1552            device
1553                .raw()
1554                .create_acceleration_structure(&hal::AccelerationStructureDescriptor {
1555                    label: hal_label(Some(&new_label), device.instance_flags),
1556                    size: size_info.acceleration_structure_size,
1557                    format: hal::AccelerationStructureFormat::BottomLevel,
1558                    allow_compaction: false,
1559                })
1560        }
1561        .map_err(DeviceError::from_hal)?;
1562
1563        let src_raw = blas.try_raw(&snatch_guard)?;
1564
1565        unsafe {
1566            cmd_buf_raw.copy_acceleration_structure_to_acceleration_structure(
1567                src_raw,
1568                raw.as_ref(),
1569                wgt::AccelerationStructureCopy::Compact,
1570            )
1571        };
1572
1573        let handle = unsafe {
1574            device
1575                .raw()
1576                .get_acceleration_structure_device_address(raw.as_ref())
1577        };
1578
1579        drop(snatch_guard);
1580
1581        let mut command_indices_lock = device.command_indices.write();
1582        command_indices_lock.next_acceleration_structure_build_command_index += 1;
1583        let built_index =
1584            NonZeroU64::new(command_indices_lock.next_acceleration_structure_build_command_index)
1585                .unwrap();
1586
1587        let new_blas = Arc::new(Blas {
1588            raw: Snatchable::new(raw),
1589            device: device.clone(),
1590            size_info,
1591            sizes: blas.sizes.clone(),
1592            flags: blas.flags & !AccelerationStructureFlags::ALLOW_COMPACTION,
1593            update_mode: blas.update_mode,
1594            // Bypass the submit checks which update this because we don't submit this normally.
1595            built_index: RwLock::new(rank::BLAS_BUILT_INDEX, Some(built_index)),
1596            handle,
1597            label: new_label,
1598            tracking_data: TrackingData::new(blas.device.tracker_indices.blas_s.clone()),
1599            compaction_buffer: None,
1600            compacted_state: Mutex::new(rank::BLAS_COMPACTION_STATE, BlasCompactState::Compacted),
1601        });
1602
1603        pending_writes.insert_blas(blas);
1604        pending_writes.insert_blas(&new_blas);
1605
1606        Ok(new_blas)
1607    }
1608}
1609
1610impl Global {
1611    pub fn queue_write_buffer(
1612        &self,
1613        queue_id: QueueId,
1614        buffer_id: id::BufferId,
1615        buffer_offset: wgt::BufferAddress,
1616        data: &[u8],
1617    ) -> Result<(), QueueWriteError> {
1618        let queue = self.hub.queues.get(queue_id);
1619        let buffer = self.hub.buffers.get(buffer_id).get()?;
1620
1621        #[cfg(feature = "trace")]
1622        if let Some(ref mut trace) = *queue.device.trace.lock() {
1623            use crate::device::trace::DataKind;
1624            let size = data.len() as u64;
1625            let data = trace.make_binary(DataKind::Bin, data);
1626            trace.add(Action::WriteBuffer {
1627                id: buffer.to_trace(),
1628                data,
1629                offset: buffer_offset,
1630                size,
1631                queued: true,
1632            });
1633        }
1634
1635        queue.write_buffer(buffer, buffer_offset, data)
1636    }
1637
1638    pub fn queue_create_staging_buffer(
1639        &self,
1640        queue_id: QueueId,
1641        buffer_size: wgt::BufferSize,
1642        id_in: Option<id::StagingBufferId>,
1643    ) -> Result<(id::StagingBufferId, NonNull<u8>), QueueWriteError> {
1644        let queue = self.hub.queues.get(queue_id);
1645        let (staging_buffer, ptr) = queue.create_staging_buffer(buffer_size)?;
1646
1647        let fid = self.hub.staging_buffers.prepare(id_in);
1648        let id = fid.assign(staging_buffer);
1649
1650        Ok((id, ptr))
1651    }
1652
1653    pub fn queue_write_staging_buffer(
1654        &self,
1655        queue_id: QueueId,
1656        buffer_id: id::BufferId,
1657        buffer_offset: wgt::BufferAddress,
1658        staging_buffer_id: id::StagingBufferId,
1659    ) -> Result<(), QueueWriteError> {
1660        let queue = self.hub.queues.get(queue_id);
1661        let buffer = self.hub.buffers.get(buffer_id);
1662        let staging_buffer = self.hub.staging_buffers.remove(staging_buffer_id);
1663        queue.write_staging_buffer(buffer, buffer_offset, staging_buffer)
1664    }
1665
1666    pub fn queue_validate_write_buffer(
1667        &self,
1668        queue_id: QueueId,
1669        buffer_id: id::BufferId,
1670        buffer_offset: u64,
1671        buffer_size: wgt::BufferSize,
1672    ) -> Result<(), QueueWriteError> {
1673        let queue = self.hub.queues.get(queue_id);
1674        let buffer = self.hub.buffers.get(buffer_id);
1675        queue.validate_write_buffer(buffer, buffer_offset, buffer_size)
1676    }
1677
1678    pub fn queue_write_texture(
1679        &self,
1680        queue_id: QueueId,
1681        destination: &wgt::TexelCopyTextureInfo<id::TextureId>,
1682        data: &[u8],
1683        data_layout: &wgt::TexelCopyBufferLayout,
1684        size: &wgt::Extent3d,
1685    ) -> Result<(), QueueWriteError> {
1686        let queue = self.hub.queues.get(queue_id);
1687        let texture = self.hub.textures.get(destination.texture).get()?;
1688        let destination = wgt::TexelCopyTextureInfo {
1689            texture,
1690            mip_level: destination.mip_level,
1691            origin: destination.origin,
1692            aspect: destination.aspect,
1693        };
1694
1695        #[cfg(feature = "trace")]
1696        if let Some(ref mut trace) = *queue.device.trace.lock() {
1697            use crate::device::trace::DataKind;
1698            let data = trace.make_binary(DataKind::Bin, data);
1699            trace.add(Action::WriteTexture {
1700                to: destination.to_trace(),
1701                data,
1702                layout: *data_layout,
1703                size: *size,
1704            });
1705        }
1706
1707        queue.write_texture(destination, data, data_layout, size)
1708    }
1709
1710    #[cfg(webgl)]
1711    pub fn queue_copy_external_image_to_texture(
1712        &self,
1713        queue_id: QueueId,
1714        source: &wgt::CopyExternalImageSourceInfo,
1715        destination: crate::command::CopyExternalImageDestInfo,
1716        size: wgt::Extent3d,
1717    ) -> Result<(), QueueWriteError> {
1718        let queue = self.hub.queues.get(queue_id);
1719        let destination = wgt::CopyExternalImageDestInfo {
1720            texture: self.hub.textures.get(destination.texture),
1721            mip_level: destination.mip_level,
1722            origin: destination.origin,
1723            aspect: destination.aspect,
1724            color_space: destination.color_space,
1725            premultiplied_alpha: destination.premultiplied_alpha,
1726        };
1727        queue.copy_external_image_to_texture(source, destination, size)
1728    }
1729
1730    pub fn queue_submit(
1731        &self,
1732        queue_id: QueueId,
1733        command_buffer_ids: &[id::CommandBufferId],
1734    ) -> Result<SubmissionIndex, (SubmissionIndex, QueueSubmitError)> {
1735        let queue = self.hub.queues.get(queue_id);
1736        let command_buffer_guard = self.hub.command_buffers.read();
1737        let command_buffers = command_buffer_ids
1738            .iter()
1739            .map(|id| command_buffer_guard.get(*id))
1740            .collect::<Vec<_>>();
1741        drop(command_buffer_guard);
1742        queue.submit(&command_buffers)
1743    }
1744
1745    pub fn queue_get_timestamp_period(&self, queue_id: QueueId) -> f32 {
1746        let queue = self.hub.queues.get(queue_id);
1747
1748        if queue.device.timestamp_normalizer.get().unwrap().enabled() {
1749            return 1.0;
1750        }
1751
1752        queue.get_timestamp_period()
1753    }
1754
1755    pub fn queue_on_submitted_work_done(
1756        &self,
1757        queue_id: QueueId,
1758        closure: SubmittedWorkDoneClosure,
1759    ) -> SubmissionIndex {
1760        api_log!("Queue::on_submitted_work_done {queue_id:?}");
1761
1762        //TODO: flush pending writes
1763        let queue = self.hub.queues.get(queue_id);
1764        let result = queue.on_submitted_work_done(closure);
1765        result.unwrap_or(0) // '0' means no wait is necessary
1766    }
1767
1768    pub fn queue_compact_blas(
1769        &self,
1770        queue_id: QueueId,
1771        blas_id: BlasId,
1772        id_in: Option<BlasId>,
1773    ) -> (BlasId, Option<u64>, Option<CompactBlasError>) {
1774        api_log!("Queue::compact_blas {queue_id:?}, {blas_id:?}");
1775
1776        let fid = self.hub.blas_s.prepare(id_in);
1777
1778        let queue = self.hub.queues.get(queue_id);
1779        let blas = self.hub.blas_s.get(blas_id);
1780        let device = &queue.device;
1781
1782        // TODO: Tracing
1783
1784        let error = 'error: {
1785            match device.require_features(wgpu_types::Features::EXPERIMENTAL_RAY_QUERY) {
1786                Ok(_) => {}
1787                Err(err) => break 'error err.into(),
1788            }
1789
1790            let blas = match blas.get() {
1791                Ok(blas) => blas,
1792                Err(err) => break 'error err.into(),
1793            };
1794
1795            let new_blas = match queue.compact_blas(&blas) {
1796                Ok(blas) => blas,
1797                Err(err) => break 'error err,
1798            };
1799
1800            // We should have no more errors after this because we have marked the command encoder as successful.
1801            let old_blas_size = blas.size_info.acceleration_structure_size;
1802            let new_blas_size = new_blas.size_info.acceleration_structure_size;
1803            let handle = new_blas.handle;
1804
1805            let id = fid.assign(Fallible::Valid(new_blas));
1806
1807            api_log!("CommandEncoder::compact_blas {blas_id:?} (size: {old_blas_size}) -> {id:?} (size: {new_blas_size})");
1808
1809            return (id, Some(handle), None);
1810        };
1811
1812        let id = fid.assign(Fallible::Invalid(Arc::new(error.to_string())));
1813
1814        (id, None, Some(error))
1815    }
1816}
1817
1818fn validate_command_buffer(
1819    command_buffer: &CommandBuffer,
1820    queue: &Queue,
1821    cmd_buf_data: &crate::command::CommandBufferMutable,
1822    snatch_guard: &SnatchGuard,
1823    submit_surface_textures_owned: &mut FastHashMap<*const Texture, Arc<Texture>>,
1824    used_surface_textures: &mut track::TextureUsageScope,
1825    command_index_guard: &mut RwLockWriteGuard<CommandIndices>,
1826) -> Result<(), QueueSubmitError> {
1827    command_buffer.same_device_as(queue)?;
1828
1829    {
1830        profiling::scope!("check resource state");
1831
1832        {
1833            profiling::scope!("buffers");
1834            for buffer in cmd_buf_data.trackers.buffers.used_resources() {
1835                buffer.check_destroyed(snatch_guard)?;
1836
1837                match *buffer.map_state.lock() {
1838                    BufferMapState::Idle => (),
1839                    _ => return Err(QueueSubmitError::BufferStillMapped(buffer.error_ident())),
1840                }
1841            }
1842        }
1843        {
1844            profiling::scope!("textures");
1845            for texture in cmd_buf_data.trackers.textures.used_resources() {
1846                let should_extend = match texture.try_inner(snatch_guard)? {
1847                    TextureInner::Native { .. } => false,
1848                    TextureInner::Surface { .. } => {
1849                        // Compare the Arcs by pointer as Textures don't implement Eq.
1850                        submit_surface_textures_owned.insert(Arc::as_ptr(texture), texture.clone());
1851
1852                        true
1853                    }
1854                };
1855                if should_extend {
1856                    unsafe {
1857                        used_surface_textures
1858                            .merge_single(texture, None, wgt::TextureUses::PRESENT)
1859                            .unwrap();
1860                    };
1861                }
1862            }
1863        }
1864        // WebGPU requires that we check every bind group referenced during
1865        // encoding, even ones that may have been replaced before being used.
1866        // TODO(<https://github.com/gfx-rs/wgpu/issues/8510>): Optimize this.
1867        {
1868            profiling::scope!("bind groups");
1869            for bind_group in &cmd_buf_data.trackers.bind_groups {
1870                // This checks the bind group and all resources it references.
1871                bind_group.try_raw(snatch_guard)?;
1872            }
1873        }
1874
1875        if let Err(e) =
1876            cmd_buf_data.validate_acceleration_structure_actions(snatch_guard, command_index_guard)
1877        {
1878            return Err(e.into());
1879        }
1880    }
1881    Ok(())
1882}