wgpu_hal/vulkan/
device.rs

1use alloc::{borrow::ToOwned as _, collections::BTreeMap, ffi::CString, sync::Arc, vec::Vec};
2use core::{
3    ffi::CStr,
4    mem::{self, MaybeUninit},
5    num::NonZeroU32,
6    ptr,
7    time::Duration,
8};
9
10use arrayvec::ArrayVec;
11use ash::{ext, khr, vk};
12use hashbrown::hash_map::Entry;
13use parking_lot::Mutex;
14
15use super::{conv, RawTlasInstance};
16use crate::TlasInstance;
17
18impl super::DeviceShared {
19    /// Set the name of `object` to `name`.
20    ///
21    /// If `name` contains an interior null byte, then the name set will be truncated to that byte.
22    ///
23    /// # Safety
24    ///
25    /// This method inherits the safety contract from [`vkSetDebugUtilsObjectName`]. In particular:
26    ///
27    /// - `object` must be a valid handle for one of the following:
28    ///   - An instance-level object from the same instance as this device.
29    ///   - A physical-device-level object that descends from the same physical device as this
30    ///     device.
31    ///   - A device-level object that descends from this device.
32    /// - `object` must be externally synchronized—only the calling thread should access it during
33    ///   this call.
34    ///
35    /// [`vkSetDebugUtilsObjectName`]: https://registry.khronos.org/vulkan/specs/latest/man/html/vkSetDebugUtilsObjectNameEXT.html
36    pub(super) unsafe fn set_object_name(&self, object: impl vk::Handle, name: &str) {
37        let Some(extension) = self.extension_fns.debug_utils.as_ref() else {
38            return;
39        };
40
41        // Keep variables outside the if-else block to ensure they do not
42        // go out of scope while we hold a pointer to them
43        let mut buffer: [u8; 64] = [0u8; 64];
44        let buffer_vec: Vec<u8>;
45
46        // Append a null terminator to the string
47        let name_bytes = if name.len() < buffer.len() {
48            // Common case, string is very small. Allocate a copy on the stack.
49            buffer[..name.len()].copy_from_slice(name.as_bytes());
50            // Add null terminator
51            buffer[name.len()] = 0;
52            &buffer[..name.len() + 1]
53        } else {
54            // Less common case, the string is large.
55            // This requires a heap allocation.
56            buffer_vec = name
57                .as_bytes()
58                .iter()
59                .cloned()
60                .chain(core::iter::once(0))
61                .collect();
62            &buffer_vec
63        };
64
65        let name = CStr::from_bytes_until_nul(name_bytes).expect("We have added a null byte");
66
67        let _result = unsafe {
68            extension.set_debug_utils_object_name(
69                &vk::DebugUtilsObjectNameInfoEXT::default()
70                    .object_handle(object)
71                    .object_name(name),
72            )
73        };
74    }
75
76    pub fn make_render_pass(
77        &self,
78        key: super::RenderPassKey,
79    ) -> Result<vk::RenderPass, crate::DeviceError> {
80        Ok(match self.render_passes.lock().entry(key) {
81            Entry::Occupied(e) => *e.get(),
82            Entry::Vacant(e) => {
83                let super::RenderPassKey {
84                    ref colors,
85                    ref depth_stencil,
86                    sample_count,
87                    multiview,
88                } = *e.key();
89
90                let mut vk_attachments = Vec::new();
91                let mut color_refs = Vec::with_capacity(colors.len());
92                let mut resolve_refs = Vec::with_capacity(color_refs.capacity());
93                let mut ds_ref = None;
94                let samples = vk::SampleCountFlags::from_raw(sample_count);
95                let unused = vk::AttachmentReference {
96                    attachment: vk::ATTACHMENT_UNUSED,
97                    layout: vk::ImageLayout::UNDEFINED,
98                };
99                for cat in colors.iter() {
100                    let (color_ref, resolve_ref) =
101                        if let Some(super::ColorAttachmentKey { base, resolve }) = cat {
102                            let super::AttachmentKey {
103                                format,
104                                layout,
105                                ops,
106                            } = *base;
107
108                            let color_ref = vk::AttachmentReference {
109                                attachment: vk_attachments.len() as u32,
110                                layout,
111                            };
112                            vk_attachments.push({
113                                let (load_op, store_op) = conv::map_attachment_ops(ops);
114                                vk::AttachmentDescription::default()
115                                    .format(format)
116                                    .samples(samples)
117                                    .load_op(load_op)
118                                    .store_op(store_op)
119                                    .initial_layout(layout)
120                                    .final_layout(layout)
121                            });
122                            let resolve_ref = if let Some(rat) = resolve {
123                                let super::AttachmentKey {
124                                    format,
125                                    layout,
126                                    ops,
127                                } = *rat;
128
129                                let (load_op, store_op) = conv::map_attachment_ops(ops);
130                                let vk_attachment = vk::AttachmentDescription::default()
131                                    .format(format)
132                                    .samples(vk::SampleCountFlags::TYPE_1)
133                                    .load_op(load_op)
134                                    .store_op(store_op)
135                                    .initial_layout(layout)
136                                    .final_layout(layout);
137                                vk_attachments.push(vk_attachment);
138
139                                vk::AttachmentReference {
140                                    attachment: vk_attachments.len() as u32 - 1,
141                                    layout,
142                                }
143                            } else {
144                                unused
145                            };
146
147                            (color_ref, resolve_ref)
148                        } else {
149                            (unused, unused)
150                        };
151
152                    color_refs.push(color_ref);
153                    resolve_refs.push(resolve_ref);
154                }
155
156                if let Some(ds) = depth_stencil {
157                    let super::DepthStencilAttachmentKey {
158                        ref base,
159                        stencil_ops,
160                    } = *ds;
161
162                    let super::AttachmentKey {
163                        format,
164                        layout,
165                        ops,
166                    } = *base;
167
168                    ds_ref = Some(vk::AttachmentReference {
169                        attachment: vk_attachments.len() as u32,
170                        layout,
171                    });
172                    let (load_op, store_op) = conv::map_attachment_ops(ops);
173                    let (stencil_load_op, stencil_store_op) = conv::map_attachment_ops(stencil_ops);
174                    let vk_attachment = vk::AttachmentDescription::default()
175                        .format(format)
176                        .samples(samples)
177                        .load_op(load_op)
178                        .store_op(store_op)
179                        .stencil_load_op(stencil_load_op)
180                        .stencil_store_op(stencil_store_op)
181                        .initial_layout(layout)
182                        .final_layout(layout);
183                    vk_attachments.push(vk_attachment);
184                }
185
186                let vk_subpasses = [{
187                    let mut vk_subpass = vk::SubpassDescription::default()
188                        .pipeline_bind_point(vk::PipelineBindPoint::GRAPHICS)
189                        .color_attachments(&color_refs)
190                        .resolve_attachments(&resolve_refs);
191
192                    if self
193                        .workarounds
194                        .contains(super::Workarounds::EMPTY_RESOLVE_ATTACHMENT_LISTS)
195                        && resolve_refs.is_empty()
196                    {
197                        vk_subpass.p_resolve_attachments = ptr::null();
198                    }
199
200                    if let Some(ref reference) = ds_ref {
201                        vk_subpass = vk_subpass.depth_stencil_attachment(reference)
202                    }
203                    vk_subpass
204                }];
205
206                let mut vk_info = vk::RenderPassCreateInfo::default()
207                    .attachments(&vk_attachments)
208                    .subpasses(&vk_subpasses);
209
210                let mut multiview_info;
211                let mask;
212                if let Some(multiview) = multiview {
213                    // Sanity checks, better to panic here than cause a driver crash
214                    assert!(multiview.get() <= 8);
215                    assert!(multiview.get() > 1);
216
217                    // Right now we enable all bits on the view masks and correlation masks.
218                    // This means we're rendering to all views in the subpass, and that all views
219                    // can be rendered concurrently.
220                    mask = [(1 << multiview.get()) - 1];
221
222                    // On Vulkan 1.1 or later, this is an alias for core functionality
223                    multiview_info = vk::RenderPassMultiviewCreateInfoKHR::default()
224                        .view_masks(&mask)
225                        .correlation_masks(&mask);
226                    vk_info = vk_info.push_next(&mut multiview_info);
227                }
228
229                let raw = unsafe {
230                    self.raw
231                        .create_render_pass(&vk_info, None)
232                        .map_err(super::map_host_device_oom_err)?
233                };
234
235                *e.insert(raw)
236            }
237        })
238    }
239
240    fn make_memory_ranges<'a, I: 'a + Iterator<Item = crate::MemoryRange>>(
241        &self,
242        buffer: &'a super::Buffer,
243        ranges: I,
244    ) -> Option<impl 'a + Iterator<Item = vk::MappedMemoryRange<'a>>> {
245        let block = buffer.block.as_ref()?.lock();
246        let mask = self.private_caps.non_coherent_map_mask;
247        Some(ranges.map(move |range| {
248            vk::MappedMemoryRange::default()
249                .memory(*block.memory())
250                .offset((block.offset() + range.start) & !mask)
251                .size((range.end - range.start + mask) & !mask)
252        }))
253    }
254}
255
256impl gpu_alloc::MemoryDevice<vk::DeviceMemory> for super::DeviceShared {
257    unsafe fn allocate_memory(
258        &self,
259        size: u64,
260        memory_type: u32,
261        flags: gpu_alloc::AllocationFlags,
262    ) -> Result<vk::DeviceMemory, gpu_alloc::OutOfMemory> {
263        let mut info = vk::MemoryAllocateInfo::default()
264            .allocation_size(size)
265            .memory_type_index(memory_type);
266
267        let mut info_flags;
268
269        if flags.contains(gpu_alloc::AllocationFlags::DEVICE_ADDRESS) {
270            info_flags = vk::MemoryAllocateFlagsInfo::default()
271                .flags(vk::MemoryAllocateFlags::DEVICE_ADDRESS);
272            info = info.push_next(&mut info_flags);
273        }
274
275        match unsafe { self.raw.allocate_memory(&info, None) } {
276            Ok(memory) => {
277                self.memory_allocations_counter.add(1);
278                Ok(memory)
279            }
280            Err(vk::Result::ERROR_OUT_OF_DEVICE_MEMORY) => {
281                Err(gpu_alloc::OutOfMemory::OutOfDeviceMemory)
282            }
283            Err(vk::Result::ERROR_OUT_OF_HOST_MEMORY) => {
284                Err(gpu_alloc::OutOfMemory::OutOfHostMemory)
285            }
286            // We don't use VK_KHR_external_memory
287            // VK_ERROR_INVALID_EXTERNAL_HANDLE
288            // We don't use VK_KHR_buffer_device_address
289            // VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR
290            Err(err) => handle_unexpected(err),
291        }
292    }
293
294    unsafe fn deallocate_memory(&self, memory: vk::DeviceMemory) {
295        self.memory_allocations_counter.sub(1);
296
297        unsafe { self.raw.free_memory(memory, None) };
298    }
299
300    unsafe fn map_memory(
301        &self,
302        memory: &mut vk::DeviceMemory,
303        offset: u64,
304        size: u64,
305    ) -> Result<ptr::NonNull<u8>, gpu_alloc::DeviceMapError> {
306        match unsafe {
307            self.raw
308                .map_memory(*memory, offset, size, vk::MemoryMapFlags::empty())
309        } {
310            Ok(ptr) => Ok(ptr::NonNull::new(ptr.cast::<u8>())
311                .expect("Pointer to memory mapping must not be null")),
312            Err(vk::Result::ERROR_OUT_OF_DEVICE_MEMORY) => {
313                Err(gpu_alloc::DeviceMapError::OutOfDeviceMemory)
314            }
315            Err(vk::Result::ERROR_OUT_OF_HOST_MEMORY) => {
316                Err(gpu_alloc::DeviceMapError::OutOfHostMemory)
317            }
318            Err(vk::Result::ERROR_MEMORY_MAP_FAILED) => Err(gpu_alloc::DeviceMapError::MapFailed),
319            Err(err) => handle_unexpected(err),
320        }
321    }
322
323    unsafe fn unmap_memory(&self, memory: &mut vk::DeviceMemory) {
324        unsafe { self.raw.unmap_memory(*memory) };
325    }
326
327    unsafe fn invalidate_memory_ranges(
328        &self,
329        _ranges: &[gpu_alloc::MappedMemoryRange<'_, vk::DeviceMemory>],
330    ) -> Result<(), gpu_alloc::OutOfMemory> {
331        // should never be called
332        unimplemented!()
333    }
334
335    unsafe fn flush_memory_ranges(
336        &self,
337        _ranges: &[gpu_alloc::MappedMemoryRange<'_, vk::DeviceMemory>],
338    ) -> Result<(), gpu_alloc::OutOfMemory> {
339        // should never be called
340        unimplemented!()
341    }
342}
343
344impl
345    gpu_descriptor::DescriptorDevice<vk::DescriptorSetLayout, vk::DescriptorPool, vk::DescriptorSet>
346    for super::DeviceShared
347{
348    unsafe fn create_descriptor_pool(
349        &self,
350        descriptor_count: &gpu_descriptor::DescriptorTotalCount,
351        max_sets: u32,
352        flags: gpu_descriptor::DescriptorPoolCreateFlags,
353    ) -> Result<vk::DescriptorPool, gpu_descriptor::CreatePoolError> {
354        //Note: ignoring other types, since they can't appear here
355        let unfiltered_counts = [
356            (vk::DescriptorType::SAMPLER, descriptor_count.sampler),
357            (
358                vk::DescriptorType::SAMPLED_IMAGE,
359                descriptor_count.sampled_image,
360            ),
361            (
362                vk::DescriptorType::STORAGE_IMAGE,
363                descriptor_count.storage_image,
364            ),
365            (
366                vk::DescriptorType::UNIFORM_BUFFER,
367                descriptor_count.uniform_buffer,
368            ),
369            (
370                vk::DescriptorType::UNIFORM_BUFFER_DYNAMIC,
371                descriptor_count.uniform_buffer_dynamic,
372            ),
373            (
374                vk::DescriptorType::STORAGE_BUFFER,
375                descriptor_count.storage_buffer,
376            ),
377            (
378                vk::DescriptorType::STORAGE_BUFFER_DYNAMIC,
379                descriptor_count.storage_buffer_dynamic,
380            ),
381            (
382                vk::DescriptorType::ACCELERATION_STRUCTURE_KHR,
383                descriptor_count.acceleration_structure,
384            ),
385        ];
386
387        let filtered_counts = unfiltered_counts
388            .iter()
389            .cloned()
390            .filter(|&(_, count)| count != 0)
391            .map(|(ty, count)| vk::DescriptorPoolSize {
392                ty,
393                descriptor_count: count,
394            })
395            .collect::<ArrayVec<_, 8>>();
396
397        let mut vk_flags =
398            if flags.contains(gpu_descriptor::DescriptorPoolCreateFlags::UPDATE_AFTER_BIND) {
399                vk::DescriptorPoolCreateFlags::UPDATE_AFTER_BIND
400            } else {
401                vk::DescriptorPoolCreateFlags::empty()
402            };
403        if flags.contains(gpu_descriptor::DescriptorPoolCreateFlags::FREE_DESCRIPTOR_SET) {
404            vk_flags |= vk::DescriptorPoolCreateFlags::FREE_DESCRIPTOR_SET;
405        }
406        let vk_info = vk::DescriptorPoolCreateInfo::default()
407            .max_sets(max_sets)
408            .flags(vk_flags)
409            .pool_sizes(&filtered_counts);
410
411        match unsafe { self.raw.create_descriptor_pool(&vk_info, None) } {
412            Ok(pool) => Ok(pool),
413            Err(vk::Result::ERROR_OUT_OF_HOST_MEMORY) => {
414                Err(gpu_descriptor::CreatePoolError::OutOfHostMemory)
415            }
416            Err(vk::Result::ERROR_OUT_OF_DEVICE_MEMORY) => {
417                Err(gpu_descriptor::CreatePoolError::OutOfDeviceMemory)
418            }
419            Err(vk::Result::ERROR_FRAGMENTATION) => {
420                Err(gpu_descriptor::CreatePoolError::Fragmentation)
421            }
422            Err(err) => handle_unexpected(err),
423        }
424    }
425
426    unsafe fn destroy_descriptor_pool(&self, pool: vk::DescriptorPool) {
427        unsafe { self.raw.destroy_descriptor_pool(pool, None) }
428    }
429
430    unsafe fn alloc_descriptor_sets<'a>(
431        &self,
432        pool: &mut vk::DescriptorPool,
433        layouts: impl ExactSizeIterator<Item = &'a vk::DescriptorSetLayout>,
434        sets: &mut impl Extend<vk::DescriptorSet>,
435    ) -> Result<(), gpu_descriptor::DeviceAllocationError> {
436        let result = unsafe {
437            self.raw.allocate_descriptor_sets(
438                &vk::DescriptorSetAllocateInfo::default()
439                    .descriptor_pool(*pool)
440                    .set_layouts(
441                        &smallvec::SmallVec::<[vk::DescriptorSetLayout; 32]>::from_iter(
442                            layouts.cloned(),
443                        ),
444                    ),
445            )
446        };
447
448        match result {
449            Ok(vk_sets) => {
450                sets.extend(vk_sets);
451                Ok(())
452            }
453            Err(vk::Result::ERROR_OUT_OF_HOST_MEMORY)
454            | Err(vk::Result::ERROR_OUT_OF_POOL_MEMORY) => {
455                Err(gpu_descriptor::DeviceAllocationError::OutOfHostMemory)
456            }
457            Err(vk::Result::ERROR_OUT_OF_DEVICE_MEMORY) => {
458                Err(gpu_descriptor::DeviceAllocationError::OutOfDeviceMemory)
459            }
460            Err(vk::Result::ERROR_FRAGMENTED_POOL) => {
461                Err(gpu_descriptor::DeviceAllocationError::FragmentedPool)
462            }
463            Err(err) => handle_unexpected(err),
464        }
465    }
466
467    unsafe fn dealloc_descriptor_sets<'a>(
468        &self,
469        pool: &mut vk::DescriptorPool,
470        sets: impl Iterator<Item = vk::DescriptorSet>,
471    ) {
472        let result = unsafe {
473            self.raw.free_descriptor_sets(
474                *pool,
475                &smallvec::SmallVec::<[vk::DescriptorSet; 32]>::from_iter(sets),
476            )
477        };
478        match result {
479            Ok(()) => {}
480            Err(err) => handle_unexpected(err),
481        }
482    }
483}
484
485struct CompiledStage {
486    create_info: vk::PipelineShaderStageCreateInfo<'static>,
487    _entry_point: CString,
488    temp_raw_module: Option<vk::ShaderModule>,
489}
490
491impl super::Device {
492    pub(super) unsafe fn create_swapchain(
493        &self,
494        surface: &super::Surface,
495        config: &crate::SurfaceConfiguration,
496        provided_old_swapchain: Option<super::Swapchain>,
497    ) -> Result<super::Swapchain, crate::SurfaceError> {
498        profiling::scope!("Device::create_swapchain");
499        let functor = khr::swapchain::Device::new(&surface.instance.raw, &self.shared.raw);
500
501        let old_swapchain = match provided_old_swapchain {
502            Some(osc) => osc.raw,
503            None => vk::SwapchainKHR::null(),
504        };
505
506        let color_space = if config.format == wgt::TextureFormat::Rgba16Float {
507            // Enable wide color gamut mode
508            // Vulkan swapchain for Android only supports DISPLAY_P3_NONLINEAR_EXT and EXTENDED_SRGB_LINEAR_EXT
509            vk::ColorSpaceKHR::EXTENDED_SRGB_LINEAR_EXT
510        } else {
511            vk::ColorSpaceKHR::SRGB_NONLINEAR
512        };
513
514        let original_format = self.shared.private_caps.map_texture_format(config.format);
515        let mut raw_flags = vk::SwapchainCreateFlagsKHR::empty();
516        let mut raw_view_formats: Vec<vk::Format> = vec![];
517        if !config.view_formats.is_empty() {
518            raw_flags |= vk::SwapchainCreateFlagsKHR::MUTABLE_FORMAT;
519            raw_view_formats = config
520                .view_formats
521                .iter()
522                .map(|f| self.shared.private_caps.map_texture_format(*f))
523                .collect();
524            raw_view_formats.push(original_format);
525        }
526
527        let mut info = vk::SwapchainCreateInfoKHR::default()
528            .flags(raw_flags)
529            .surface(surface.raw)
530            .min_image_count(config.maximum_frame_latency + 1) // TODO: https://github.com/gfx-rs/wgpu/issues/2869
531            .image_format(original_format)
532            .image_color_space(color_space)
533            .image_extent(vk::Extent2D {
534                width: config.extent.width,
535                height: config.extent.height,
536            })
537            .image_array_layers(config.extent.depth_or_array_layers)
538            .image_usage(conv::map_texture_usage(config.usage))
539            .image_sharing_mode(vk::SharingMode::EXCLUSIVE)
540            .pre_transform(vk::SurfaceTransformFlagsKHR::IDENTITY)
541            .composite_alpha(conv::map_composite_alpha_mode(config.composite_alpha_mode))
542            .present_mode(conv::map_present_mode(config.present_mode))
543            .clipped(true)
544            .old_swapchain(old_swapchain);
545
546        let mut format_list_info = vk::ImageFormatListCreateInfo::default();
547        if !raw_view_formats.is_empty() {
548            format_list_info = format_list_info.view_formats(&raw_view_formats);
549            info = info.push_next(&mut format_list_info);
550        }
551
552        let result = {
553            profiling::scope!("vkCreateSwapchainKHR");
554            unsafe { functor.create_swapchain(&info, None) }
555        };
556
557        // doing this before bailing out with error
558        if old_swapchain != vk::SwapchainKHR::null() {
559            unsafe { functor.destroy_swapchain(old_swapchain, None) }
560        }
561
562        let raw = match result {
563            Ok(swapchain) => swapchain,
564            Err(error) => {
565                return Err(match error {
566                    vk::Result::ERROR_SURFACE_LOST_KHR
567                    | vk::Result::ERROR_INITIALIZATION_FAILED => crate::SurfaceError::Lost,
568                    vk::Result::ERROR_NATIVE_WINDOW_IN_USE_KHR => {
569                        crate::SurfaceError::Other("Native window is in use")
570                    }
571                    // We don't use VK_EXT_image_compression_control
572                    // VK_ERROR_COMPRESSION_EXHAUSTED_EXT
573                    other => super::map_host_device_oom_and_lost_err(other).into(),
574                });
575            }
576        };
577
578        let images =
579            unsafe { functor.get_swapchain_images(raw) }.map_err(super::map_host_device_oom_err)?;
580
581        // NOTE: It's important that we define the same number of acquire/present semaphores
582        // as we will need to index into them with the image index.
583        let acquire_semaphores = (0..=images.len())
584            .map(|i| {
585                super::SwapchainAcquireSemaphore::new(&self.shared, i)
586                    .map(Mutex::new)
587                    .map(Arc::new)
588            })
589            .collect::<Result<Vec<_>, _>>()?;
590
591        let present_semaphores = (0..=images.len())
592            .map(|i| Arc::new(Mutex::new(super::SwapchainPresentSemaphores::new(i))))
593            .collect::<Vec<_>>();
594
595        Ok(super::Swapchain {
596            raw,
597            functor,
598            device: Arc::clone(&self.shared),
599            images,
600            config: config.clone(),
601            acquire_semaphores,
602            next_acquire_index: 0,
603            present_semaphores,
604            next_present_time: None,
605        })
606    }
607
608    /// # Safety
609    ///
610    /// - `vk_image` must be created respecting `desc`
611    /// - If `drop_callback` is [`None`], wgpu-hal will take ownership of `vk_image`. If
612    ///   `drop_callback` is [`Some`], `vk_image` must be valid until the callback is called.
613    /// - If the `ImageCreateFlags` does not contain `MUTABLE_FORMAT`, the `view_formats` of `desc` must be empty.
614    pub unsafe fn texture_from_raw(
615        &self,
616        vk_image: vk::Image,
617        desc: &crate::TextureDescriptor,
618        drop_callback: Option<crate::DropCallback>,
619    ) -> super::Texture {
620        let mut raw_flags = vk::ImageCreateFlags::empty();
621        let mut view_formats = vec![];
622        for tf in desc.view_formats.iter() {
623            if *tf == desc.format {
624                continue;
625            }
626            view_formats.push(*tf);
627        }
628        if !view_formats.is_empty() {
629            raw_flags |=
630                vk::ImageCreateFlags::MUTABLE_FORMAT | vk::ImageCreateFlags::EXTENDED_USAGE;
631            view_formats.push(desc.format)
632        }
633        if desc.format.is_multi_planar_format() {
634            raw_flags |= vk::ImageCreateFlags::MUTABLE_FORMAT;
635        }
636
637        let identity = self.shared.texture_identity_factory.next();
638
639        let drop_guard = crate::DropGuard::from_option(drop_callback);
640
641        super::Texture {
642            raw: vk_image,
643            drop_guard,
644            external_memory: None,
645            block: None,
646            format: desc.format,
647            copy_size: desc.copy_extent(),
648            identity,
649        }
650    }
651
652    #[cfg(windows)]
653    fn find_memory_type_index(
654        &self,
655        type_bits_req: u32,
656        flags_req: vk::MemoryPropertyFlags,
657    ) -> Option<usize> {
658        let mem_properties = unsafe {
659            self.shared
660                .instance
661                .raw
662                .get_physical_device_memory_properties(self.shared.physical_device)
663        };
664
665        // https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkPhysicalDeviceMemoryProperties.html
666        for (i, mem_ty) in mem_properties.memory_types_as_slice().iter().enumerate() {
667            let types_bits = 1 << i;
668            let is_required_memory_type = type_bits_req & types_bits != 0;
669            let has_required_properties = mem_ty.property_flags & flags_req == flags_req;
670            if is_required_memory_type && has_required_properties {
671                return Some(i);
672            }
673        }
674
675        None
676    }
677
678    fn create_image_without_memory(
679        &self,
680        desc: &crate::TextureDescriptor,
681        external_memory_image_create_info: Option<&mut vk::ExternalMemoryImageCreateInfo>,
682    ) -> Result<ImageWithoutMemory, crate::DeviceError> {
683        let copy_size = desc.copy_extent();
684
685        let mut raw_flags = vk::ImageCreateFlags::empty();
686        if desc.dimension == wgt::TextureDimension::D3
687            && desc.usage.contains(wgt::TextureUses::COLOR_TARGET)
688        {
689            raw_flags |= vk::ImageCreateFlags::TYPE_2D_ARRAY_COMPATIBLE;
690        }
691        if desc.is_cube_compatible() {
692            raw_flags |= vk::ImageCreateFlags::CUBE_COMPATIBLE;
693        }
694
695        let original_format = self.shared.private_caps.map_texture_format(desc.format);
696        let mut vk_view_formats = vec![];
697        if !desc.view_formats.is_empty() {
698            raw_flags |= vk::ImageCreateFlags::MUTABLE_FORMAT;
699
700            if self.shared.private_caps.image_format_list {
701                vk_view_formats = desc
702                    .view_formats
703                    .iter()
704                    .map(|f| self.shared.private_caps.map_texture_format(*f))
705                    .collect();
706                vk_view_formats.push(original_format)
707            }
708        }
709        if desc.format.is_multi_planar_format() {
710            raw_flags |= vk::ImageCreateFlags::MUTABLE_FORMAT;
711        }
712
713        let mut vk_info = vk::ImageCreateInfo::default()
714            .flags(raw_flags)
715            .image_type(conv::map_texture_dimension(desc.dimension))
716            .format(original_format)
717            .extent(conv::map_copy_extent(&copy_size))
718            .mip_levels(desc.mip_level_count)
719            .array_layers(desc.array_layer_count())
720            .samples(vk::SampleCountFlags::from_raw(desc.sample_count))
721            .tiling(vk::ImageTiling::OPTIMAL)
722            .usage(conv::map_texture_usage(desc.usage))
723            .sharing_mode(vk::SharingMode::EXCLUSIVE)
724            .initial_layout(vk::ImageLayout::UNDEFINED);
725
726        let mut format_list_info = vk::ImageFormatListCreateInfo::default();
727        if !vk_view_formats.is_empty() {
728            format_list_info = format_list_info.view_formats(&vk_view_formats);
729            vk_info = vk_info.push_next(&mut format_list_info);
730        }
731
732        if let Some(ext_info) = external_memory_image_create_info {
733            vk_info = vk_info.push_next(ext_info);
734        }
735
736        let raw = unsafe { self.shared.raw.create_image(&vk_info, None) }.map_err(map_err)?;
737        fn map_err(err: vk::Result) -> crate::DeviceError {
738            // We don't use VK_EXT_image_compression_control
739            // VK_ERROR_COMPRESSION_EXHAUSTED_EXT
740            super::map_host_device_oom_and_ioca_err(err)
741        }
742        let req = unsafe { self.shared.raw.get_image_memory_requirements(raw) };
743
744        Ok(ImageWithoutMemory {
745            raw,
746            requirements: req,
747            copy_size,
748        })
749    }
750
751    /// # Safety
752    ///
753    /// - Vulkan (with VK_KHR_external_memory_win32)
754    /// - The `d3d11_shared_handle` must be valid and respecting `desc`
755    /// - `VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT` flag is used because we need to hold a reference to the handle
756    #[cfg(windows)]
757    pub unsafe fn texture_from_d3d11_shared_handle(
758        &self,
759        d3d11_shared_handle: windows::Win32::Foundation::HANDLE,
760        desc: &crate::TextureDescriptor,
761    ) -> Result<super::Texture, crate::DeviceError> {
762        if !self
763            .shared
764            .features
765            .contains(wgt::Features::VULKAN_EXTERNAL_MEMORY_WIN32)
766        {
767            log::error!("Vulkan driver does not support VK_KHR_external_memory_win32");
768            return Err(crate::DeviceError::Unexpected);
769        }
770
771        let mut external_memory_image_info = vk::ExternalMemoryImageCreateInfo::default()
772            .handle_types(vk::ExternalMemoryHandleTypeFlags::D3D11_TEXTURE);
773
774        let image =
775            self.create_image_without_memory(desc, Some(&mut external_memory_image_info))?;
776
777        // Some external memory types require dedicated allocation
778        // https://docs.vulkan.org/guide/latest/extensions/external.html#_importing_memory
779        let mut dedicated_allocate_info =
780            vk::MemoryDedicatedAllocateInfo::default().image(image.raw);
781
782        let mut import_memory_info = vk::ImportMemoryWin32HandleInfoKHR::default()
783            .handle_type(vk::ExternalMemoryHandleTypeFlags::D3D11_TEXTURE)
784            .handle(d3d11_shared_handle.0 as _);
785        // TODO: We should use `push_next` instead, but currently ash does not provide this method for the `ImportMemoryWin32HandleInfoKHR` type.
786        #[allow(clippy::unnecessary_mut_passed)]
787        {
788            import_memory_info.p_next = <*const _>::cast(&mut dedicated_allocate_info);
789        }
790
791        let mem_type_index = self
792            .find_memory_type_index(
793                image.requirements.memory_type_bits,
794                vk::MemoryPropertyFlags::DEVICE_LOCAL,
795            )
796            .ok_or(crate::DeviceError::Unexpected)?;
797
798        let memory_allocate_info = vk::MemoryAllocateInfo::default()
799            .allocation_size(image.requirements.size)
800            .memory_type_index(mem_type_index as _)
801            .push_next(&mut import_memory_info);
802        let memory = unsafe { self.shared.raw.allocate_memory(&memory_allocate_info, None) }
803            .map_err(super::map_host_device_oom_err)?;
804
805        unsafe { self.shared.raw.bind_image_memory(image.raw, memory, 0) }
806            .map_err(super::map_host_device_oom_err)?;
807
808        if let Some(label) = desc.label {
809            unsafe { self.shared.set_object_name(image.raw, label) };
810        }
811
812        let identity = self.shared.texture_identity_factory.next();
813
814        self.counters.textures.add(1);
815
816        Ok(super::Texture {
817            raw: image.raw,
818            drop_guard: None,
819            external_memory: Some(memory),
820            block: None,
821            format: desc.format,
822            copy_size: image.copy_size,
823            identity,
824        })
825    }
826
827    fn create_shader_module_impl(
828        &self,
829        spv: &[u32],
830        label: &crate::Label<'_>,
831    ) -> Result<vk::ShaderModule, crate::DeviceError> {
832        let vk_info = vk::ShaderModuleCreateInfo::default()
833            .flags(vk::ShaderModuleCreateFlags::empty())
834            .code(spv);
835
836        let raw = unsafe {
837            profiling::scope!("vkCreateShaderModule");
838            self.shared
839                .raw
840                .create_shader_module(&vk_info, None)
841                .map_err(map_err)?
842        };
843        fn map_err(err: vk::Result) -> crate::DeviceError {
844            // We don't use VK_NV_glsl_shader
845            // VK_ERROR_INVALID_SHADER_NV
846            super::map_host_device_oom_err(err)
847        }
848
849        if let Some(label) = label {
850            unsafe { self.shared.set_object_name(raw, label) };
851        }
852
853        Ok(raw)
854    }
855
856    fn compile_stage(
857        &self,
858        stage: &crate::ProgrammableStage<super::ShaderModule>,
859        naga_stage: naga::ShaderStage,
860        binding_map: &naga::back::spv::BindingMap,
861    ) -> Result<CompiledStage, crate::PipelineError> {
862        let stage_flags = crate::auxil::map_naga_stage(naga_stage);
863        let vk_module = match *stage.module {
864            super::ShaderModule::Raw(raw) => raw,
865            super::ShaderModule::Intermediate {
866                ref naga_shader,
867                runtime_checks,
868            } => {
869                let pipeline_options = naga::back::spv::PipelineOptions {
870                    entry_point: stage.entry_point.to_owned(),
871                    shader_stage: naga_stage,
872                };
873                let needs_temp_options = !runtime_checks.bounds_checks
874                    || !runtime_checks.force_loop_bounding
875                    || !binding_map.is_empty()
876                    || naga_shader.debug_source.is_some()
877                    || !stage.zero_initialize_workgroup_memory;
878                let mut temp_options;
879                let options = if needs_temp_options {
880                    temp_options = self.naga_options.clone();
881                    if !runtime_checks.bounds_checks {
882                        temp_options.bounds_check_policies = naga::proc::BoundsCheckPolicies {
883                            index: naga::proc::BoundsCheckPolicy::Unchecked,
884                            buffer: naga::proc::BoundsCheckPolicy::Unchecked,
885                            image_load: naga::proc::BoundsCheckPolicy::Unchecked,
886                            binding_array: naga::proc::BoundsCheckPolicy::Unchecked,
887                        };
888                    }
889                    if !runtime_checks.force_loop_bounding {
890                        temp_options.force_loop_bounding = false;
891                    }
892                    if !binding_map.is_empty() {
893                        temp_options.binding_map = binding_map.clone();
894                    }
895
896                    if let Some(ref debug) = naga_shader.debug_source {
897                        temp_options.debug_info = Some(naga::back::spv::DebugInfo {
898                            source_code: &debug.source_code,
899                            file_name: debug.file_name.as_ref(),
900                            language: naga::back::spv::SourceLanguage::WGSL,
901                        })
902                    }
903                    if !stage.zero_initialize_workgroup_memory {
904                        temp_options.zero_initialize_workgroup_memory =
905                            naga::back::spv::ZeroInitializeWorkgroupMemoryMode::None;
906                    }
907
908                    &temp_options
909                } else {
910                    &self.naga_options
911                };
912
913                let (module, info) = naga::back::pipeline_constants::process_overrides(
914                    &naga_shader.module,
915                    &naga_shader.info,
916                    Some((naga_stage, stage.entry_point)),
917                    stage.constants,
918                )
919                .map_err(|e| {
920                    crate::PipelineError::PipelineConstants(stage_flags, format!("{e}"))
921                })?;
922
923                let spv = {
924                    profiling::scope!("naga::spv::write_vec");
925                    naga::back::spv::write_vec(&module, &info, options, Some(&pipeline_options))
926                }
927                .map_err(|e| crate::PipelineError::Linkage(stage_flags, format!("{e}")))?;
928                self.create_shader_module_impl(&spv, &None)?
929            }
930        };
931
932        let mut flags = vk::PipelineShaderStageCreateFlags::empty();
933        if self.shared.features.contains(wgt::Features::SUBGROUP) {
934            flags |= vk::PipelineShaderStageCreateFlags::ALLOW_VARYING_SUBGROUP_SIZE
935        }
936
937        let entry_point = CString::new(stage.entry_point).unwrap();
938        let mut create_info = vk::PipelineShaderStageCreateInfo::default()
939            .flags(flags)
940            .stage(conv::map_shader_stage(stage_flags))
941            .module(vk_module);
942
943        // Circumvent struct lifetime check because of a self-reference inside CompiledStage
944        create_info.p_name = entry_point.as_ptr();
945
946        Ok(CompiledStage {
947            create_info,
948            _entry_point: entry_point,
949            temp_raw_module: match *stage.module {
950                super::ShaderModule::Raw(_) => None,
951                super::ShaderModule::Intermediate { .. } => Some(vk_module),
952            },
953        })
954    }
955
956    /// Returns the queue family index of the device's internal queue.
957    ///
958    /// This is useful for constructing memory barriers needed for queue family ownership transfer when
959    /// external memory is involved (from/to `VK_QUEUE_FAMILY_EXTERNAL_KHR` and `VK_QUEUE_FAMILY_FOREIGN_EXT`
960    /// for example).
961    pub fn queue_family_index(&self) -> u32 {
962        self.shared.family_index
963    }
964
965    pub fn queue_index(&self) -> u32 {
966        self.shared.queue_index
967    }
968
969    pub fn raw_device(&self) -> &ash::Device {
970        &self.shared.raw
971    }
972
973    pub fn raw_physical_device(&self) -> vk::PhysicalDevice {
974        self.shared.physical_device
975    }
976
977    pub fn raw_queue(&self) -> vk::Queue {
978        self.shared.raw_queue
979    }
980
981    pub fn enabled_device_extensions(&self) -> &[&'static CStr] {
982        &self.shared.enabled_extensions
983    }
984
985    pub fn shared_instance(&self) -> &super::InstanceShared {
986        &self.shared.instance
987    }
988
989    fn error_if_would_oom_on_resource_allocation(
990        &self,
991        needs_host_access: bool,
992        size: u64,
993    ) -> Result<(), crate::DeviceError> {
994        let Some(threshold) = self
995            .shared
996            .instance
997            .memory_budget_thresholds
998            .for_resource_creation
999        else {
1000            return Ok(());
1001        };
1002
1003        if !self
1004            .shared
1005            .enabled_extensions
1006            .contains(&ext::memory_budget::NAME)
1007        {
1008            return Ok(());
1009        }
1010
1011        let get_physical_device_properties = self
1012            .shared
1013            .instance
1014            .get_physical_device_properties
1015            .as_ref()
1016            .unwrap();
1017
1018        let mut memory_budget_properties = vk::PhysicalDeviceMemoryBudgetPropertiesEXT::default();
1019
1020        let mut memory_properties =
1021            vk::PhysicalDeviceMemoryProperties2::default().push_next(&mut memory_budget_properties);
1022
1023        unsafe {
1024            get_physical_device_properties.get_physical_device_memory_properties2(
1025                self.shared.physical_device,
1026                &mut memory_properties,
1027            );
1028        }
1029
1030        let mut host_visible_heaps = [false; vk::MAX_MEMORY_HEAPS];
1031        let mut device_local_heaps = [false; vk::MAX_MEMORY_HEAPS];
1032
1033        let memory_properties = memory_properties.memory_properties;
1034
1035        for i in 0..memory_properties.memory_type_count {
1036            let memory_type = memory_properties.memory_types[i as usize];
1037            let flags = memory_type.property_flags;
1038
1039            if flags.intersects(
1040                vk::MemoryPropertyFlags::LAZILY_ALLOCATED | vk::MemoryPropertyFlags::PROTECTED,
1041            ) {
1042                continue; // not used by gpu-alloc
1043            }
1044
1045            if flags.contains(vk::MemoryPropertyFlags::HOST_VISIBLE) {
1046                host_visible_heaps[memory_type.heap_index as usize] = true;
1047            }
1048
1049            if flags.contains(vk::MemoryPropertyFlags::DEVICE_LOCAL) {
1050                device_local_heaps[memory_type.heap_index as usize] = true;
1051            }
1052        }
1053
1054        let heaps = if needs_host_access {
1055            host_visible_heaps
1056        } else {
1057            device_local_heaps
1058        };
1059
1060        // NOTE: We might end up checking multiple heaps since gpu-alloc doesn't have a way
1061        // for us to query the heap the resource will end up on. But this is unlikely,
1062        // there is usually only one heap on integrated GPUs and two on dedicated GPUs.
1063
1064        for (i, check) in heaps.iter().enumerate() {
1065            if !check {
1066                continue;
1067            }
1068
1069            let heap_usage = memory_budget_properties.heap_usage[i];
1070            let heap_budget = memory_budget_properties.heap_budget[i];
1071
1072            if heap_usage + size >= heap_budget / 100 * threshold as u64 {
1073                return Err(crate::DeviceError::OutOfMemory);
1074            }
1075        }
1076
1077        Ok(())
1078    }
1079}
1080
1081impl crate::Device for super::Device {
1082    type A = super::Api;
1083
1084    unsafe fn create_buffer(
1085        &self,
1086        desc: &crate::BufferDescriptor,
1087    ) -> Result<super::Buffer, crate::DeviceError> {
1088        let vk_info = vk::BufferCreateInfo::default()
1089            .size(desc.size)
1090            .usage(conv::map_buffer_usage(desc.usage))
1091            .sharing_mode(vk::SharingMode::EXCLUSIVE);
1092
1093        let raw = unsafe {
1094            self.shared
1095                .raw
1096                .create_buffer(&vk_info, None)
1097                .map_err(super::map_host_device_oom_and_ioca_err)?
1098        };
1099        let req = unsafe { self.shared.raw.get_buffer_memory_requirements(raw) };
1100
1101        let mut alloc_usage = if desc
1102            .usage
1103            .intersects(wgt::BufferUses::MAP_READ | wgt::BufferUses::MAP_WRITE)
1104        {
1105            let mut flags = gpu_alloc::UsageFlags::HOST_ACCESS;
1106            //TODO: find a way to use `crate::MemoryFlags::PREFER_COHERENT`
1107            flags.set(
1108                gpu_alloc::UsageFlags::DOWNLOAD,
1109                desc.usage.contains(wgt::BufferUses::MAP_READ),
1110            );
1111            flags.set(
1112                gpu_alloc::UsageFlags::UPLOAD,
1113                desc.usage.contains(wgt::BufferUses::MAP_WRITE),
1114            );
1115            flags
1116        } else {
1117            gpu_alloc::UsageFlags::FAST_DEVICE_ACCESS
1118        };
1119        alloc_usage.set(
1120            gpu_alloc::UsageFlags::TRANSIENT,
1121            desc.memory_flags.contains(crate::MemoryFlags::TRANSIENT),
1122        );
1123
1124        let needs_host_access = alloc_usage.contains(gpu_alloc::UsageFlags::HOST_ACCESS);
1125
1126        self.error_if_would_oom_on_resource_allocation(needs_host_access, req.size)
1127            .inspect_err(|_| {
1128                unsafe { self.shared.raw.destroy_buffer(raw, None) };
1129            })?;
1130
1131        let alignment_mask = req.alignment - 1;
1132
1133        let block = unsafe {
1134            self.mem_allocator.lock().alloc(
1135                &*self.shared,
1136                gpu_alloc::Request {
1137                    size: req.size,
1138                    align_mask: alignment_mask,
1139                    usage: alloc_usage,
1140                    memory_types: req.memory_type_bits & self.valid_ash_memory_types,
1141                },
1142            )
1143        }
1144        .inspect_err(|_| {
1145            unsafe { self.shared.raw.destroy_buffer(raw, None) };
1146        })?;
1147
1148        unsafe {
1149            self.shared
1150                .raw
1151                .bind_buffer_memory(raw, *block.memory(), block.offset())
1152        }
1153        .map_err(super::map_host_device_oom_and_ioca_err)
1154        .inspect_err(|_| {
1155            unsafe { self.shared.raw.destroy_buffer(raw, None) };
1156        })?;
1157
1158        if let Some(label) = desc.label {
1159            unsafe { self.shared.set_object_name(raw, label) };
1160        }
1161
1162        self.counters.buffer_memory.add(block.size() as isize);
1163        self.counters.buffers.add(1);
1164
1165        Ok(super::Buffer {
1166            raw,
1167            block: Some(Mutex::new(super::BufferMemoryBacking::Managed(block))),
1168        })
1169    }
1170    unsafe fn destroy_buffer(&self, buffer: super::Buffer) {
1171        unsafe { self.shared.raw.destroy_buffer(buffer.raw, None) };
1172        if let Some(block) = buffer.block {
1173            let block = block.into_inner();
1174            self.counters.buffer_memory.sub(block.size() as isize);
1175            match block {
1176                super::BufferMemoryBacking::Managed(block) => unsafe {
1177                    self.mem_allocator.lock().dealloc(&*self.shared, block)
1178                },
1179                super::BufferMemoryBacking::VulkanMemory { memory, .. } => unsafe {
1180                    self.shared.raw.free_memory(memory, None);
1181                },
1182            }
1183        }
1184
1185        self.counters.buffers.sub(1);
1186    }
1187
1188    unsafe fn add_raw_buffer(&self, _buffer: &super::Buffer) {
1189        self.counters.buffers.add(1);
1190    }
1191
1192    unsafe fn map_buffer(
1193        &self,
1194        buffer: &super::Buffer,
1195        range: crate::MemoryRange,
1196    ) -> Result<crate::BufferMapping, crate::DeviceError> {
1197        if let Some(ref block) = buffer.block {
1198            let size = range.end - range.start;
1199            let mut block = block.lock();
1200            if let super::BufferMemoryBacking::Managed(ref mut block) = *block {
1201                let ptr = unsafe { block.map(&*self.shared, range.start, size as usize)? };
1202                let is_coherent = block
1203                    .props()
1204                    .contains(gpu_alloc::MemoryPropertyFlags::HOST_COHERENT);
1205                Ok(crate::BufferMapping { ptr, is_coherent })
1206            } else {
1207                crate::hal_usage_error("tried to map externally created buffer")
1208            }
1209        } else {
1210            crate::hal_usage_error("tried to map external buffer")
1211        }
1212    }
1213    unsafe fn unmap_buffer(&self, buffer: &super::Buffer) {
1214        if let Some(ref block) = buffer.block {
1215            match &mut *block.lock() {
1216                super::BufferMemoryBacking::Managed(block) => unsafe { block.unmap(&*self.shared) },
1217                super::BufferMemoryBacking::VulkanMemory { .. } => {
1218                    crate::hal_usage_error("tried to unmap externally created buffer")
1219                }
1220            };
1221        } else {
1222            crate::hal_usage_error("tried to unmap external buffer")
1223        }
1224    }
1225
1226    unsafe fn flush_mapped_ranges<I>(&self, buffer: &super::Buffer, ranges: I)
1227    where
1228        I: Iterator<Item = crate::MemoryRange>,
1229    {
1230        if let Some(vk_ranges) = self.shared.make_memory_ranges(buffer, ranges) {
1231            unsafe {
1232                self.shared
1233                    .raw
1234                    .flush_mapped_memory_ranges(
1235                        &smallvec::SmallVec::<[vk::MappedMemoryRange; 32]>::from_iter(vk_ranges),
1236                    )
1237            }
1238            .unwrap();
1239        }
1240    }
1241    unsafe fn invalidate_mapped_ranges<I>(&self, buffer: &super::Buffer, ranges: I)
1242    where
1243        I: Iterator<Item = crate::MemoryRange>,
1244    {
1245        if let Some(vk_ranges) = self.shared.make_memory_ranges(buffer, ranges) {
1246            unsafe {
1247                self.shared
1248                    .raw
1249                    .invalidate_mapped_memory_ranges(&smallvec::SmallVec::<
1250                        [vk::MappedMemoryRange; 32],
1251                    >::from_iter(vk_ranges))
1252            }
1253            .unwrap();
1254        }
1255    }
1256
1257    unsafe fn create_texture(
1258        &self,
1259        desc: &crate::TextureDescriptor,
1260    ) -> Result<super::Texture, crate::DeviceError> {
1261        let image = self.create_image_without_memory(desc, None)?;
1262
1263        self.error_if_would_oom_on_resource_allocation(false, image.requirements.size)
1264            .inspect_err(|_| {
1265                unsafe { self.shared.raw.destroy_image(image.raw, None) };
1266            })?;
1267
1268        let block = unsafe {
1269            self.mem_allocator.lock().alloc(
1270                &*self.shared,
1271                gpu_alloc::Request {
1272                    size: image.requirements.size,
1273                    align_mask: image.requirements.alignment - 1,
1274                    usage: gpu_alloc::UsageFlags::FAST_DEVICE_ACCESS,
1275                    memory_types: image.requirements.memory_type_bits & self.valid_ash_memory_types,
1276                },
1277            )
1278        }
1279        .inspect_err(|_| {
1280            unsafe { self.shared.raw.destroy_image(image.raw, None) };
1281        })?;
1282
1283        self.counters.texture_memory.add(block.size() as isize);
1284
1285        unsafe {
1286            self.shared
1287                .raw
1288                .bind_image_memory(image.raw, *block.memory(), block.offset())
1289        }
1290        .map_err(super::map_host_device_oom_err)
1291        .inspect_err(|_| {
1292            unsafe { self.shared.raw.destroy_image(image.raw, None) };
1293        })?;
1294
1295        if let Some(label) = desc.label {
1296            unsafe { self.shared.set_object_name(image.raw, label) };
1297        }
1298
1299        let identity = self.shared.texture_identity_factory.next();
1300
1301        self.counters.textures.add(1);
1302
1303        Ok(super::Texture {
1304            raw: image.raw,
1305            drop_guard: None,
1306            external_memory: None,
1307            block: Some(block),
1308            format: desc.format,
1309            copy_size: image.copy_size,
1310            identity,
1311        })
1312    }
1313    unsafe fn destroy_texture(&self, texture: super::Texture) {
1314        if texture.drop_guard.is_none() {
1315            unsafe { self.shared.raw.destroy_image(texture.raw, None) };
1316        }
1317        if let Some(memory) = texture.external_memory {
1318            unsafe { self.shared.raw.free_memory(memory, None) };
1319        }
1320        if let Some(block) = texture.block {
1321            self.counters.texture_memory.sub(block.size() as isize);
1322
1323            unsafe { self.mem_allocator.lock().dealloc(&*self.shared, block) };
1324        }
1325
1326        self.counters.textures.sub(1);
1327    }
1328
1329    unsafe fn add_raw_texture(&self, _texture: &super::Texture) {
1330        self.counters.textures.add(1);
1331    }
1332
1333    unsafe fn create_texture_view(
1334        &self,
1335        texture: &super::Texture,
1336        desc: &crate::TextureViewDescriptor,
1337    ) -> Result<super::TextureView, crate::DeviceError> {
1338        let subresource_range = conv::map_subresource_range(&desc.range, texture.format);
1339        let raw_format = self.shared.private_caps.map_texture_format(desc.format);
1340        let mut vk_info = vk::ImageViewCreateInfo::default()
1341            .flags(vk::ImageViewCreateFlags::empty())
1342            .image(texture.raw)
1343            .view_type(conv::map_view_dimension(desc.dimension))
1344            .format(raw_format)
1345            .subresource_range(subresource_range);
1346        let layers =
1347            NonZeroU32::new(subresource_range.layer_count).expect("Unexpected zero layer count");
1348
1349        let mut image_view_info;
1350        if self.shared.private_caps.image_view_usage && !desc.usage.is_empty() {
1351            image_view_info =
1352                vk::ImageViewUsageCreateInfo::default().usage(conv::map_texture_usage(desc.usage));
1353            vk_info = vk_info.push_next(&mut image_view_info);
1354        }
1355
1356        let raw = unsafe { self.shared.raw.create_image_view(&vk_info, None) }
1357            .map_err(super::map_host_device_oom_and_ioca_err)?;
1358
1359        if let Some(label) = desc.label {
1360            unsafe { self.shared.set_object_name(raw, label) };
1361        }
1362
1363        let identity = self.shared.texture_view_identity_factory.next();
1364
1365        self.counters.texture_views.add(1);
1366
1367        Ok(super::TextureView {
1368            raw_texture: texture.raw,
1369            raw,
1370            layers,
1371            format: desc.format,
1372            raw_format,
1373            base_mip_level: desc.range.base_mip_level,
1374            dimension: desc.dimension,
1375            texture_identity: texture.identity,
1376            view_identity: identity,
1377        })
1378    }
1379    unsafe fn destroy_texture_view(&self, view: super::TextureView) {
1380        unsafe { self.shared.raw.destroy_image_view(view.raw, None) };
1381
1382        self.counters.texture_views.sub(1);
1383    }
1384
1385    unsafe fn create_sampler(
1386        &self,
1387        desc: &crate::SamplerDescriptor,
1388    ) -> Result<super::Sampler, crate::DeviceError> {
1389        let mut create_info = vk::SamplerCreateInfo::default()
1390            .flags(vk::SamplerCreateFlags::empty())
1391            .mag_filter(conv::map_filter_mode(desc.mag_filter))
1392            .min_filter(conv::map_filter_mode(desc.min_filter))
1393            .mipmap_mode(conv::map_mip_filter_mode(desc.mipmap_filter))
1394            .address_mode_u(conv::map_address_mode(desc.address_modes[0]))
1395            .address_mode_v(conv::map_address_mode(desc.address_modes[1]))
1396            .address_mode_w(conv::map_address_mode(desc.address_modes[2]))
1397            .min_lod(desc.lod_clamp.start)
1398            .max_lod(desc.lod_clamp.end);
1399
1400        if let Some(fun) = desc.compare {
1401            create_info = create_info
1402                .compare_enable(true)
1403                .compare_op(conv::map_comparison(fun));
1404        }
1405
1406        if desc.anisotropy_clamp != 1 {
1407            // We only enable anisotropy if it is supported, and wgpu-hal interface guarantees
1408            // the clamp is in the range [1, 16] which is always supported if anisotropy is.
1409            create_info = create_info
1410                .anisotropy_enable(true)
1411                .max_anisotropy(desc.anisotropy_clamp as f32);
1412        }
1413
1414        if let Some(color) = desc.border_color {
1415            create_info = create_info.border_color(conv::map_border_color(color));
1416        }
1417
1418        let mut sampler_cache_guard = self.shared.sampler_cache.lock();
1419
1420        let raw = sampler_cache_guard.create_sampler(&self.shared.raw, create_info)?;
1421
1422        // Note: Cached samplers will just continually overwrite the label
1423        //
1424        // https://github.com/gfx-rs/wgpu/issues/6867
1425        if let Some(label) = desc.label {
1426            // SAFETY: we are holding a lock on the sampler cache,
1427            // so we can only be setting the name from one thread.
1428            unsafe { self.shared.set_object_name(raw, label) };
1429        }
1430
1431        drop(sampler_cache_guard);
1432
1433        self.counters.samplers.add(1);
1434
1435        Ok(super::Sampler { raw, create_info })
1436    }
1437    unsafe fn destroy_sampler(&self, sampler: super::Sampler) {
1438        self.shared.sampler_cache.lock().destroy_sampler(
1439            &self.shared.raw,
1440            sampler.create_info,
1441            sampler.raw,
1442        );
1443
1444        self.counters.samplers.sub(1);
1445    }
1446
1447    unsafe fn create_command_encoder(
1448        &self,
1449        desc: &crate::CommandEncoderDescriptor<super::Queue>,
1450    ) -> Result<super::CommandEncoder, crate::DeviceError> {
1451        let vk_info = vk::CommandPoolCreateInfo::default()
1452            .queue_family_index(desc.queue.family_index)
1453            .flags(vk::CommandPoolCreateFlags::TRANSIENT);
1454
1455        let raw = unsafe {
1456            self.shared
1457                .raw
1458                .create_command_pool(&vk_info, None)
1459                .map_err(super::map_host_device_oom_err)?
1460        };
1461
1462        self.counters.command_encoders.add(1);
1463
1464        Ok(super::CommandEncoder {
1465            raw,
1466            device: Arc::clone(&self.shared),
1467            active: vk::CommandBuffer::null(),
1468            bind_point: vk::PipelineBindPoint::default(),
1469            temp: super::Temp::default(),
1470            free: Vec::new(),
1471            discarded: Vec::new(),
1472            rpass_debug_marker_active: false,
1473            end_of_pass_timer_query: None,
1474            framebuffers: Default::default(),
1475            temp_texture_views: Default::default(),
1476            counters: Arc::clone(&self.counters),
1477        })
1478    }
1479
1480    unsafe fn create_bind_group_layout(
1481        &self,
1482        desc: &crate::BindGroupLayoutDescriptor,
1483    ) -> Result<super::BindGroupLayout, crate::DeviceError> {
1484        // Iterate through the entries and accumulate our Vulkan
1485        // DescriptorSetLayoutBindings and DescriptorBindingFlags, as well as
1486        // our binding map and our descriptor counts.
1487        // Note: not bothering with on stack arrays here as it's low frequency
1488        let mut vk_bindings = Vec::new();
1489        let mut binding_flags = Vec::new();
1490        let mut binding_map = Vec::new();
1491        let mut next_binding = 0;
1492        let mut contains_binding_arrays = false;
1493        let mut desc_count = gpu_descriptor::DescriptorTotalCount::default();
1494        for entry in desc.entries {
1495            if entry.count.is_some() {
1496                contains_binding_arrays = true;
1497            }
1498
1499            let partially_bound = desc
1500                .flags
1501                .contains(crate::BindGroupLayoutFlags::PARTIALLY_BOUND);
1502            let mut flags = vk::DescriptorBindingFlags::empty();
1503            if partially_bound && entry.count.is_some() {
1504                flags |= vk::DescriptorBindingFlags::PARTIALLY_BOUND;
1505            }
1506            if entry.count.is_some() {
1507                flags |= vk::DescriptorBindingFlags::UPDATE_AFTER_BIND;
1508            }
1509
1510            let count = entry.count.map_or(1, |c| c.get());
1511            match entry.ty {
1512                wgt::BindingType::ExternalTexture => unimplemented!(),
1513                _ => {
1514                    vk_bindings.push(vk::DescriptorSetLayoutBinding {
1515                        binding: next_binding,
1516                        descriptor_type: conv::map_binding_type(entry.ty),
1517                        descriptor_count: count,
1518                        stage_flags: conv::map_shader_stage(entry.visibility),
1519                        p_immutable_samplers: ptr::null(),
1520                        _marker: Default::default(),
1521                    });
1522                    binding_flags.push(flags);
1523                    binding_map.push((
1524                        entry.binding,
1525                        super::BindingInfo {
1526                            binding: next_binding,
1527                            binding_array_size: entry.count,
1528                        },
1529                    ));
1530                    next_binding += 1;
1531                }
1532            }
1533
1534            match entry.ty {
1535                wgt::BindingType::Buffer {
1536                    ty,
1537                    has_dynamic_offset,
1538                    ..
1539                } => match ty {
1540                    wgt::BufferBindingType::Uniform => {
1541                        if has_dynamic_offset {
1542                            desc_count.uniform_buffer_dynamic += count;
1543                        } else {
1544                            desc_count.uniform_buffer += count;
1545                        }
1546                    }
1547                    wgt::BufferBindingType::Storage { .. } => {
1548                        if has_dynamic_offset {
1549                            desc_count.storage_buffer_dynamic += count;
1550                        } else {
1551                            desc_count.storage_buffer += count;
1552                        }
1553                    }
1554                },
1555                wgt::BindingType::Sampler { .. } => {
1556                    desc_count.sampler += count;
1557                }
1558                wgt::BindingType::Texture { .. } => {
1559                    desc_count.sampled_image += count;
1560                }
1561                wgt::BindingType::StorageTexture { .. } => {
1562                    desc_count.storage_image += count;
1563                }
1564                wgt::BindingType::AccelerationStructure { .. } => {
1565                    desc_count.acceleration_structure += count;
1566                }
1567                wgt::BindingType::ExternalTexture => unimplemented!(),
1568            }
1569        }
1570
1571        let vk_info = vk::DescriptorSetLayoutCreateInfo::default()
1572            .bindings(&vk_bindings)
1573            .flags(if contains_binding_arrays {
1574                vk::DescriptorSetLayoutCreateFlags::UPDATE_AFTER_BIND_POOL
1575            } else {
1576                vk::DescriptorSetLayoutCreateFlags::empty()
1577            });
1578
1579        let mut binding_flag_info =
1580            vk::DescriptorSetLayoutBindingFlagsCreateInfo::default().binding_flags(&binding_flags);
1581
1582        let vk_info = vk_info.push_next(&mut binding_flag_info);
1583
1584        let raw = unsafe {
1585            self.shared
1586                .raw
1587                .create_descriptor_set_layout(&vk_info, None)
1588                .map_err(super::map_host_device_oom_err)?
1589        };
1590
1591        if let Some(label) = desc.label {
1592            unsafe { self.shared.set_object_name(raw, label) };
1593        }
1594
1595        self.counters.bind_group_layouts.add(1);
1596
1597        Ok(super::BindGroupLayout {
1598            raw,
1599            desc_count,
1600            entries: desc.entries.into(),
1601            binding_map,
1602            contains_binding_arrays,
1603        })
1604    }
1605    unsafe fn destroy_bind_group_layout(&self, bg_layout: super::BindGroupLayout) {
1606        unsafe {
1607            self.shared
1608                .raw
1609                .destroy_descriptor_set_layout(bg_layout.raw, None)
1610        };
1611
1612        self.counters.bind_group_layouts.sub(1);
1613    }
1614
1615    unsafe fn create_pipeline_layout(
1616        &self,
1617        desc: &crate::PipelineLayoutDescriptor<super::BindGroupLayout>,
1618    ) -> Result<super::PipelineLayout, crate::DeviceError> {
1619        //Note: not bothering with on stack array here as it's low frequency
1620        let vk_set_layouts = desc
1621            .bind_group_layouts
1622            .iter()
1623            .map(|bgl| bgl.raw)
1624            .collect::<Vec<_>>();
1625        let vk_push_constant_ranges = desc
1626            .push_constant_ranges
1627            .iter()
1628            .map(|pcr| vk::PushConstantRange {
1629                stage_flags: conv::map_shader_stage(pcr.stages),
1630                offset: pcr.range.start,
1631                size: pcr.range.end - pcr.range.start,
1632            })
1633            .collect::<Vec<_>>();
1634
1635        let vk_info = vk::PipelineLayoutCreateInfo::default()
1636            .flags(vk::PipelineLayoutCreateFlags::empty())
1637            .set_layouts(&vk_set_layouts)
1638            .push_constant_ranges(&vk_push_constant_ranges);
1639
1640        let raw = {
1641            profiling::scope!("vkCreatePipelineLayout");
1642            unsafe {
1643                self.shared
1644                    .raw
1645                    .create_pipeline_layout(&vk_info, None)
1646                    .map_err(super::map_host_device_oom_err)?
1647            }
1648        };
1649
1650        if let Some(label) = desc.label {
1651            unsafe { self.shared.set_object_name(raw, label) };
1652        }
1653
1654        let mut binding_map = BTreeMap::new();
1655        for (group, &layout) in desc.bind_group_layouts.iter().enumerate() {
1656            for &(binding, binding_info) in &layout.binding_map {
1657                binding_map.insert(
1658                    naga::ResourceBinding {
1659                        group: group as u32,
1660                        binding,
1661                    },
1662                    naga::back::spv::BindingInfo {
1663                        descriptor_set: group as u32,
1664                        binding: binding_info.binding,
1665                        binding_array_size: binding_info.binding_array_size.map(NonZeroU32::get),
1666                    },
1667                );
1668            }
1669        }
1670
1671        self.counters.pipeline_layouts.add(1);
1672        Ok(super::PipelineLayout { raw, binding_map })
1673    }
1674    unsafe fn destroy_pipeline_layout(&self, pipeline_layout: super::PipelineLayout) {
1675        unsafe {
1676            self.shared
1677                .raw
1678                .destroy_pipeline_layout(pipeline_layout.raw, None)
1679        };
1680
1681        self.counters.pipeline_layouts.sub(1);
1682    }
1683
1684    unsafe fn create_bind_group(
1685        &self,
1686        desc: &crate::BindGroupDescriptor<
1687            super::BindGroupLayout,
1688            super::Buffer,
1689            super::Sampler,
1690            super::TextureView,
1691            super::AccelerationStructure,
1692        >,
1693    ) -> Result<super::BindGroup, crate::DeviceError> {
1694        let desc_set_layout_flags = if desc.layout.contains_binding_arrays {
1695            gpu_descriptor::DescriptorSetLayoutCreateFlags::UPDATE_AFTER_BIND
1696        } else {
1697            gpu_descriptor::DescriptorSetLayoutCreateFlags::empty()
1698        };
1699
1700        let mut vk_sets = unsafe {
1701            self.desc_allocator.lock().allocate(
1702                &*self.shared,
1703                &desc.layout.raw,
1704                desc_set_layout_flags,
1705                &desc.layout.desc_count,
1706                1,
1707            )?
1708        };
1709
1710        let set = vk_sets.pop().unwrap();
1711        if let Some(label) = desc.label {
1712            unsafe { self.shared.set_object_name(*set.raw(), label) };
1713        }
1714
1715        /// Helper for splitting off and initializing a given number of elements on a pre-allocated
1716        /// stack, based on items returned from an [`ExactSizeIterator`].  Typically created from a
1717        /// [`MaybeUninit`] slice (see [`Vec::spare_capacity_mut()`]).
1718        /// The updated [`ExtensionStack`] of remaining uninitialized elements is returned, safely
1719        /// representing that the initialized and remaining elements are two independent mutable
1720        /// borrows.
1721        struct ExtendStack<'a, T> {
1722            remainder: &'a mut [MaybeUninit<T>],
1723        }
1724
1725        impl<'a, T> ExtendStack<'a, T> {
1726            fn from_vec_capacity(vec: &'a mut Vec<T>) -> Self {
1727                Self {
1728                    remainder: vec.spare_capacity_mut(),
1729                }
1730            }
1731
1732            fn extend_one(self, value: T) -> (Self, &'a mut T) {
1733                let (to_init, remainder) = self.remainder.split_first_mut().unwrap();
1734                let init = to_init.write(value);
1735                (Self { remainder }, init)
1736            }
1737
1738            fn extend(
1739                self,
1740                iter: impl IntoIterator<Item = T> + ExactSizeIterator,
1741            ) -> (Self, &'a mut [T]) {
1742                let (to_init, remainder) = self.remainder.split_at_mut(iter.len());
1743
1744                for (value, to_init) in iter.into_iter().zip(to_init.iter_mut()) {
1745                    to_init.write(value);
1746                }
1747
1748                // we can't use the safe (yet unstable) MaybeUninit::write_slice() here because of having an iterator to write
1749
1750                let init = {
1751                    // SAFETY: The loop above has initialized exactly as many items as to_init is
1752                    // long, so it is safe to cast away the MaybeUninit<T> wrapper into T.
1753
1754                    // Additional safety docs from unstable slice_assume_init_mut
1755                    // SAFETY: similar to safety notes for `slice_get_ref`, but we have a
1756                    // mutable reference which is also guaranteed to be valid for writes.
1757                    unsafe { mem::transmute::<&mut [MaybeUninit<T>], &mut [T]>(to_init) }
1758                };
1759                (Self { remainder }, init)
1760            }
1761        }
1762
1763        let mut writes = Vec::with_capacity(desc.entries.len());
1764        let mut buffer_infos = Vec::with_capacity(desc.buffers.len());
1765        let mut buffer_infos = ExtendStack::from_vec_capacity(&mut buffer_infos);
1766        let mut image_infos = Vec::with_capacity(desc.samplers.len() + desc.textures.len());
1767        let mut image_infos = ExtendStack::from_vec_capacity(&mut image_infos);
1768        // TODO: This length could be reduced to just the number of top-level acceleration
1769        // structure bindings, where multiple consecutive TLAS bindings that are set via
1770        // one `WriteDescriptorSet` count towards one "info" struct, not the total number of
1771        // acceleration structure bindings to write:
1772        let mut acceleration_structure_infos =
1773            Vec::with_capacity(desc.acceleration_structures.len());
1774        let mut acceleration_structure_infos =
1775            ExtendStack::from_vec_capacity(&mut acceleration_structure_infos);
1776        let mut raw_acceleration_structures =
1777            Vec::with_capacity(desc.acceleration_structures.len());
1778        let mut raw_acceleration_structures =
1779            ExtendStack::from_vec_capacity(&mut raw_acceleration_structures);
1780
1781        let layout_and_entry_iter = desc.entries.iter().map(|entry| {
1782            let layout = desc
1783                .layout
1784                .entries
1785                .iter()
1786                .find(|layout_entry| layout_entry.binding == entry.binding)
1787                .expect("internal error: no layout entry found with binding slot");
1788            (layout, entry)
1789        });
1790        let mut next_binding = 0;
1791        for (layout, entry) in layout_and_entry_iter {
1792            let write = vk::WriteDescriptorSet::default().dst_set(*set.raw());
1793
1794            match layout.ty {
1795                wgt::BindingType::Sampler(_) => {
1796                    let start = entry.resource_index;
1797                    let end = start + entry.count;
1798                    let local_image_infos;
1799                    (image_infos, local_image_infos) =
1800                        image_infos.extend(desc.samplers[start as usize..end as usize].iter().map(
1801                            |sampler| vk::DescriptorImageInfo::default().sampler(sampler.raw),
1802                        ));
1803                    writes.push(
1804                        write
1805                            .dst_binding(next_binding)
1806                            .descriptor_type(conv::map_binding_type(layout.ty))
1807                            .image_info(local_image_infos),
1808                    );
1809                    next_binding += 1;
1810                }
1811                wgt::BindingType::Texture { .. } | wgt::BindingType::StorageTexture { .. } => {
1812                    let start = entry.resource_index;
1813                    let end = start + entry.count;
1814                    let local_image_infos;
1815                    (image_infos, local_image_infos) =
1816                        image_infos.extend(desc.textures[start as usize..end as usize].iter().map(
1817                            |binding| {
1818                                let layout =
1819                                    conv::derive_image_layout(binding.usage, binding.view.format);
1820                                vk::DescriptorImageInfo::default()
1821                                    .image_view(binding.view.raw)
1822                                    .image_layout(layout)
1823                            },
1824                        ));
1825                    writes.push(
1826                        write
1827                            .dst_binding(next_binding)
1828                            .descriptor_type(conv::map_binding_type(layout.ty))
1829                            .image_info(local_image_infos),
1830                    );
1831                    next_binding += 1;
1832                }
1833                wgt::BindingType::Buffer { .. } => {
1834                    let start = entry.resource_index;
1835                    let end = start + entry.count;
1836                    let local_buffer_infos;
1837                    (buffer_infos, local_buffer_infos) =
1838                        buffer_infos.extend(desc.buffers[start as usize..end as usize].iter().map(
1839                            |binding| {
1840                                vk::DescriptorBufferInfo::default()
1841                                    .buffer(binding.buffer.raw)
1842                                    .offset(binding.offset)
1843                                    .range(
1844                                        binding.size.map_or(vk::WHOLE_SIZE, wgt::BufferSize::get),
1845                                    )
1846                            },
1847                        ));
1848                    writes.push(
1849                        write
1850                            .dst_binding(next_binding)
1851                            .descriptor_type(conv::map_binding_type(layout.ty))
1852                            .buffer_info(local_buffer_infos),
1853                    );
1854                    next_binding += 1;
1855                }
1856                wgt::BindingType::AccelerationStructure { .. } => {
1857                    let start = entry.resource_index;
1858                    let end = start + entry.count;
1859
1860                    let local_raw_acceleration_structures;
1861                    (
1862                        raw_acceleration_structures,
1863                        local_raw_acceleration_structures,
1864                    ) = raw_acceleration_structures.extend(
1865                        desc.acceleration_structures[start as usize..end as usize]
1866                            .iter()
1867                            .map(|acceleration_structure| acceleration_structure.raw),
1868                    );
1869
1870                    let local_acceleration_structure_infos;
1871                    (
1872                        acceleration_structure_infos,
1873                        local_acceleration_structure_infos,
1874                    ) = acceleration_structure_infos.extend_one(
1875                        vk::WriteDescriptorSetAccelerationStructureKHR::default()
1876                            .acceleration_structures(local_raw_acceleration_structures),
1877                    );
1878
1879                    writes.push(
1880                        write
1881                            .dst_binding(next_binding)
1882                            .descriptor_type(conv::map_binding_type(layout.ty))
1883                            .descriptor_count(entry.count)
1884                            .push_next(local_acceleration_structure_infos),
1885                    );
1886                    next_binding += 1;
1887                }
1888                wgt::BindingType::ExternalTexture => unimplemented!(),
1889            }
1890        }
1891
1892        unsafe { self.shared.raw.update_descriptor_sets(&writes, &[]) };
1893
1894        self.counters.bind_groups.add(1);
1895
1896        Ok(super::BindGroup { set })
1897    }
1898
1899    unsafe fn destroy_bind_group(&self, group: super::BindGroup) {
1900        unsafe {
1901            self.desc_allocator
1902                .lock()
1903                .free(&*self.shared, Some(group.set))
1904        };
1905
1906        self.counters.bind_groups.sub(1);
1907    }
1908
1909    unsafe fn create_shader_module(
1910        &self,
1911        desc: &crate::ShaderModuleDescriptor,
1912        shader: crate::ShaderInput,
1913    ) -> Result<super::ShaderModule, crate::ShaderError> {
1914        let shader_module = match shader {
1915            crate::ShaderInput::Naga(naga_shader)
1916                if self
1917                    .shared
1918                    .workarounds
1919                    .contains(super::Workarounds::SEPARATE_ENTRY_POINTS)
1920                    || !naga_shader.module.overrides.is_empty() =>
1921            {
1922                super::ShaderModule::Intermediate {
1923                    naga_shader,
1924                    runtime_checks: desc.runtime_checks,
1925                }
1926            }
1927            crate::ShaderInput::Naga(naga_shader) => {
1928                let mut naga_options = self.naga_options.clone();
1929                naga_options.debug_info =
1930                    naga_shader
1931                        .debug_source
1932                        .as_ref()
1933                        .map(|d| naga::back::spv::DebugInfo {
1934                            source_code: d.source_code.as_ref(),
1935                            file_name: d.file_name.as_ref(),
1936                            language: naga::back::spv::SourceLanguage::WGSL,
1937                        });
1938                if !desc.runtime_checks.bounds_checks {
1939                    naga_options.bounds_check_policies = naga::proc::BoundsCheckPolicies {
1940                        index: naga::proc::BoundsCheckPolicy::Unchecked,
1941                        buffer: naga::proc::BoundsCheckPolicy::Unchecked,
1942                        image_load: naga::proc::BoundsCheckPolicy::Unchecked,
1943                        binding_array: naga::proc::BoundsCheckPolicy::Unchecked,
1944                    };
1945                }
1946                let spv = naga::back::spv::write_vec(
1947                    &naga_shader.module,
1948                    &naga_shader.info,
1949                    &naga_options,
1950                    None,
1951                )
1952                .map_err(|e| crate::ShaderError::Compilation(format!("{e}")))?;
1953                super::ShaderModule::Raw(self.create_shader_module_impl(&spv, &desc.label)?)
1954            }
1955            crate::ShaderInput::SpirV(data) => {
1956                super::ShaderModule::Raw(self.create_shader_module_impl(data, &desc.label)?)
1957            }
1958            crate::ShaderInput::Msl { .. }
1959            | crate::ShaderInput::Dxil { .. }
1960            | crate::ShaderInput::Hlsl { .. }
1961            | crate::ShaderInput::Glsl { .. } => unreachable!(),
1962        };
1963
1964        self.counters.shader_modules.add(1);
1965
1966        Ok(shader_module)
1967    }
1968
1969    unsafe fn destroy_shader_module(&self, module: super::ShaderModule) {
1970        match module {
1971            super::ShaderModule::Raw(raw) => {
1972                unsafe { self.shared.raw.destroy_shader_module(raw, None) };
1973            }
1974            super::ShaderModule::Intermediate { .. } => {}
1975        }
1976
1977        self.counters.shader_modules.sub(1);
1978    }
1979
1980    unsafe fn create_render_pipeline(
1981        &self,
1982        desc: &crate::RenderPipelineDescriptor<
1983            super::PipelineLayout,
1984            super::ShaderModule,
1985            super::PipelineCache,
1986        >,
1987    ) -> Result<super::RenderPipeline, crate::PipelineError> {
1988        let dynamic_states = [
1989            vk::DynamicState::VIEWPORT,
1990            vk::DynamicState::SCISSOR,
1991            vk::DynamicState::BLEND_CONSTANTS,
1992            vk::DynamicState::STENCIL_REFERENCE,
1993        ];
1994        let mut compatible_rp_key = super::RenderPassKey {
1995            sample_count: desc.multisample.count,
1996            multiview: desc.multiview,
1997            ..Default::default()
1998        };
1999        let mut stages = ArrayVec::<_, { crate::MAX_CONCURRENT_SHADER_STAGES }>::new();
2000        let mut vertex_buffers = Vec::new();
2001        let mut vertex_attributes = Vec::new();
2002
2003        if let crate::VertexProcessor::Standard {
2004            vertex_buffers: desc_vertex_buffers,
2005            vertex_stage: _,
2006        } = &desc.vertex_processor
2007        {
2008            vertex_buffers = Vec::with_capacity(desc_vertex_buffers.len());
2009            for (i, vb) in desc_vertex_buffers.iter().enumerate() {
2010                vertex_buffers.push(vk::VertexInputBindingDescription {
2011                    binding: i as u32,
2012                    stride: vb.array_stride as u32,
2013                    input_rate: match vb.step_mode {
2014                        wgt::VertexStepMode::Vertex => vk::VertexInputRate::VERTEX,
2015                        wgt::VertexStepMode::Instance => vk::VertexInputRate::INSTANCE,
2016                    },
2017                });
2018                for at in vb.attributes {
2019                    vertex_attributes.push(vk::VertexInputAttributeDescription {
2020                        location: at.shader_location,
2021                        binding: i as u32,
2022                        format: conv::map_vertex_format(at.format),
2023                        offset: at.offset as u32,
2024                    });
2025                }
2026            }
2027        }
2028
2029        let vk_vertex_input = vk::PipelineVertexInputStateCreateInfo::default()
2030            .vertex_binding_descriptions(&vertex_buffers)
2031            .vertex_attribute_descriptions(&vertex_attributes);
2032
2033        let vk_input_assembly = vk::PipelineInputAssemblyStateCreateInfo::default()
2034            .topology(conv::map_topology(desc.primitive.topology))
2035            .primitive_restart_enable(desc.primitive.strip_index_format.is_some());
2036
2037        let mut compiled_vs = None;
2038        let mut compiled_ms = None;
2039        let mut compiled_ts = None;
2040        match &desc.vertex_processor {
2041            crate::VertexProcessor::Standard {
2042                vertex_buffers: _,
2043                vertex_stage,
2044            } => {
2045                compiled_vs = Some(self.compile_stage(
2046                    vertex_stage,
2047                    naga::ShaderStage::Vertex,
2048                    &desc.layout.binding_map,
2049                )?);
2050                stages.push(compiled_vs.as_ref().unwrap().create_info);
2051            }
2052            crate::VertexProcessor::Mesh {
2053                task_stage,
2054                mesh_stage,
2055            } => {
2056                if let Some(t) = task_stage.as_ref() {
2057                    compiled_ts = Some(self.compile_stage(
2058                        t,
2059                        naga::ShaderStage::Task,
2060                        &desc.layout.binding_map,
2061                    )?);
2062                    stages.push(compiled_ts.as_ref().unwrap().create_info);
2063                }
2064                compiled_ms = Some(self.compile_stage(
2065                    mesh_stage,
2066                    naga::ShaderStage::Mesh,
2067                    &desc.layout.binding_map,
2068                )?);
2069                stages.push(compiled_ms.as_ref().unwrap().create_info);
2070            }
2071        }
2072        let compiled_fs = match desc.fragment_stage {
2073            Some(ref stage) => {
2074                let compiled = self.compile_stage(
2075                    stage,
2076                    naga::ShaderStage::Fragment,
2077                    &desc.layout.binding_map,
2078                )?;
2079                stages.push(compiled.create_info);
2080                Some(compiled)
2081            }
2082            None => None,
2083        };
2084
2085        let mut vk_rasterization = vk::PipelineRasterizationStateCreateInfo::default()
2086            .polygon_mode(conv::map_polygon_mode(desc.primitive.polygon_mode))
2087            .front_face(conv::map_front_face(desc.primitive.front_face))
2088            .line_width(1.0)
2089            .depth_clamp_enable(desc.primitive.unclipped_depth);
2090        if let Some(face) = desc.primitive.cull_mode {
2091            vk_rasterization = vk_rasterization.cull_mode(conv::map_cull_face(face))
2092        }
2093        let mut vk_rasterization_conservative_state =
2094            vk::PipelineRasterizationConservativeStateCreateInfoEXT::default()
2095                .conservative_rasterization_mode(
2096                    vk::ConservativeRasterizationModeEXT::OVERESTIMATE,
2097                );
2098        if desc.primitive.conservative {
2099            vk_rasterization = vk_rasterization.push_next(&mut vk_rasterization_conservative_state);
2100        }
2101
2102        let mut vk_depth_stencil = vk::PipelineDepthStencilStateCreateInfo::default();
2103        if let Some(ref ds) = desc.depth_stencil {
2104            let vk_format = self.shared.private_caps.map_texture_format(ds.format);
2105            let vk_layout = if ds.is_read_only(desc.primitive.cull_mode) {
2106                vk::ImageLayout::DEPTH_STENCIL_READ_ONLY_OPTIMAL
2107            } else {
2108                vk::ImageLayout::DEPTH_STENCIL_ATTACHMENT_OPTIMAL
2109            };
2110            compatible_rp_key.depth_stencil = Some(super::DepthStencilAttachmentKey {
2111                base: super::AttachmentKey::compatible(vk_format, vk_layout),
2112                stencil_ops: crate::AttachmentOps::all(),
2113            });
2114
2115            if ds.is_depth_enabled() {
2116                vk_depth_stencil = vk_depth_stencil
2117                    .depth_test_enable(true)
2118                    .depth_write_enable(ds.depth_write_enabled)
2119                    .depth_compare_op(conv::map_comparison(ds.depth_compare));
2120            }
2121            if ds.stencil.is_enabled() {
2122                let s = &ds.stencil;
2123                let front = conv::map_stencil_face(&s.front, s.read_mask, s.write_mask);
2124                let back = conv::map_stencil_face(&s.back, s.read_mask, s.write_mask);
2125                vk_depth_stencil = vk_depth_stencil
2126                    .stencil_test_enable(true)
2127                    .front(front)
2128                    .back(back);
2129            }
2130
2131            if ds.bias.is_enabled() {
2132                vk_rasterization = vk_rasterization
2133                    .depth_bias_enable(true)
2134                    .depth_bias_constant_factor(ds.bias.constant as f32)
2135                    .depth_bias_clamp(ds.bias.clamp)
2136                    .depth_bias_slope_factor(ds.bias.slope_scale);
2137            }
2138        }
2139
2140        let vk_viewport = vk::PipelineViewportStateCreateInfo::default()
2141            .flags(vk::PipelineViewportStateCreateFlags::empty())
2142            .scissor_count(1)
2143            .viewport_count(1);
2144
2145        let vk_sample_mask = [
2146            desc.multisample.mask as u32,
2147            (desc.multisample.mask >> 32) as u32,
2148        ];
2149        let vk_multisample = vk::PipelineMultisampleStateCreateInfo::default()
2150            .rasterization_samples(vk::SampleCountFlags::from_raw(desc.multisample.count))
2151            .alpha_to_coverage_enable(desc.multisample.alpha_to_coverage_enabled)
2152            .sample_mask(&vk_sample_mask);
2153
2154        let mut vk_attachments = Vec::with_capacity(desc.color_targets.len());
2155        for cat in desc.color_targets {
2156            let (key, attarchment) = if let Some(cat) = cat.as_ref() {
2157                let mut vk_attachment = vk::PipelineColorBlendAttachmentState::default()
2158                    .color_write_mask(vk::ColorComponentFlags::from_raw(cat.write_mask.bits()));
2159                if let Some(ref blend) = cat.blend {
2160                    let (color_op, color_src, color_dst) = conv::map_blend_component(&blend.color);
2161                    let (alpha_op, alpha_src, alpha_dst) = conv::map_blend_component(&blend.alpha);
2162                    vk_attachment = vk_attachment
2163                        .blend_enable(true)
2164                        .color_blend_op(color_op)
2165                        .src_color_blend_factor(color_src)
2166                        .dst_color_blend_factor(color_dst)
2167                        .alpha_blend_op(alpha_op)
2168                        .src_alpha_blend_factor(alpha_src)
2169                        .dst_alpha_blend_factor(alpha_dst);
2170                }
2171
2172                let vk_format = self.shared.private_caps.map_texture_format(cat.format);
2173                (
2174                    Some(super::ColorAttachmentKey {
2175                        base: super::AttachmentKey::compatible(
2176                            vk_format,
2177                            vk::ImageLayout::COLOR_ATTACHMENT_OPTIMAL,
2178                        ),
2179                        resolve: None,
2180                    }),
2181                    vk_attachment,
2182                )
2183            } else {
2184                (None, vk::PipelineColorBlendAttachmentState::default())
2185            };
2186
2187            compatible_rp_key.colors.push(key);
2188            vk_attachments.push(attarchment);
2189        }
2190
2191        let vk_color_blend =
2192            vk::PipelineColorBlendStateCreateInfo::default().attachments(&vk_attachments);
2193
2194        let vk_dynamic_state =
2195            vk::PipelineDynamicStateCreateInfo::default().dynamic_states(&dynamic_states);
2196
2197        let raw_pass = self.shared.make_render_pass(compatible_rp_key)?;
2198
2199        let vk_infos = [{
2200            vk::GraphicsPipelineCreateInfo::default()
2201                .layout(desc.layout.raw)
2202                .stages(&stages)
2203                .vertex_input_state(&vk_vertex_input)
2204                .input_assembly_state(&vk_input_assembly)
2205                .rasterization_state(&vk_rasterization)
2206                .viewport_state(&vk_viewport)
2207                .multisample_state(&vk_multisample)
2208                .depth_stencil_state(&vk_depth_stencil)
2209                .color_blend_state(&vk_color_blend)
2210                .dynamic_state(&vk_dynamic_state)
2211                .render_pass(raw_pass)
2212        }];
2213
2214        let pipeline_cache = desc
2215            .cache
2216            .map(|it| it.raw)
2217            .unwrap_or(vk::PipelineCache::null());
2218
2219        let mut raw_vec = {
2220            profiling::scope!("vkCreateGraphicsPipelines");
2221            unsafe {
2222                self.shared
2223                    .raw
2224                    .create_graphics_pipelines(pipeline_cache, &vk_infos, None)
2225                    .map_err(|(_, e)| super::map_pipeline_err(e))
2226            }?
2227        };
2228
2229        let raw = raw_vec.pop().unwrap();
2230        if let Some(label) = desc.label {
2231            unsafe { self.shared.set_object_name(raw, label) };
2232        }
2233
2234        if let Some(CompiledStage {
2235            temp_raw_module: Some(raw_module),
2236            ..
2237        }) = compiled_vs
2238        {
2239            unsafe { self.shared.raw.destroy_shader_module(raw_module, None) };
2240        }
2241        if let Some(CompiledStage {
2242            temp_raw_module: Some(raw_module),
2243            ..
2244        }) = compiled_ts
2245        {
2246            unsafe { self.shared.raw.destroy_shader_module(raw_module, None) };
2247        }
2248        if let Some(CompiledStage {
2249            temp_raw_module: Some(raw_module),
2250            ..
2251        }) = compiled_ms
2252        {
2253            unsafe { self.shared.raw.destroy_shader_module(raw_module, None) };
2254        }
2255        if let Some(CompiledStage {
2256            temp_raw_module: Some(raw_module),
2257            ..
2258        }) = compiled_fs
2259        {
2260            unsafe { self.shared.raw.destroy_shader_module(raw_module, None) };
2261        }
2262
2263        self.counters.render_pipelines.add(1);
2264
2265        Ok(super::RenderPipeline { raw })
2266    }
2267
2268    unsafe fn destroy_render_pipeline(&self, pipeline: super::RenderPipeline) {
2269        unsafe { self.shared.raw.destroy_pipeline(pipeline.raw, None) };
2270
2271        self.counters.render_pipelines.sub(1);
2272    }
2273
2274    unsafe fn create_compute_pipeline(
2275        &self,
2276        desc: &crate::ComputePipelineDescriptor<
2277            super::PipelineLayout,
2278            super::ShaderModule,
2279            super::PipelineCache,
2280        >,
2281    ) -> Result<super::ComputePipeline, crate::PipelineError> {
2282        let compiled = self.compile_stage(
2283            &desc.stage,
2284            naga::ShaderStage::Compute,
2285            &desc.layout.binding_map,
2286        )?;
2287
2288        let vk_infos = [{
2289            vk::ComputePipelineCreateInfo::default()
2290                .layout(desc.layout.raw)
2291                .stage(compiled.create_info)
2292        }];
2293
2294        let pipeline_cache = desc
2295            .cache
2296            .map(|it| it.raw)
2297            .unwrap_or(vk::PipelineCache::null());
2298
2299        let mut raw_vec = {
2300            profiling::scope!("vkCreateComputePipelines");
2301            unsafe {
2302                self.shared
2303                    .raw
2304                    .create_compute_pipelines(pipeline_cache, &vk_infos, None)
2305                    .map_err(|(_, e)| super::map_pipeline_err(e))
2306            }?
2307        };
2308
2309        let raw = raw_vec.pop().unwrap();
2310        if let Some(label) = desc.label {
2311            unsafe { self.shared.set_object_name(raw, label) };
2312        }
2313
2314        if let Some(raw_module) = compiled.temp_raw_module {
2315            unsafe { self.shared.raw.destroy_shader_module(raw_module, None) };
2316        }
2317
2318        self.counters.compute_pipelines.add(1);
2319
2320        Ok(super::ComputePipeline { raw })
2321    }
2322
2323    unsafe fn destroy_compute_pipeline(&self, pipeline: super::ComputePipeline) {
2324        unsafe { self.shared.raw.destroy_pipeline(pipeline.raw, None) };
2325
2326        self.counters.compute_pipelines.sub(1);
2327    }
2328
2329    unsafe fn create_pipeline_cache(
2330        &self,
2331        desc: &crate::PipelineCacheDescriptor<'_>,
2332    ) -> Result<super::PipelineCache, crate::PipelineCacheError> {
2333        let mut info = vk::PipelineCacheCreateInfo::default();
2334        if let Some(data) = desc.data {
2335            info = info.initial_data(data)
2336        }
2337        profiling::scope!("vkCreatePipelineCache");
2338        let raw = unsafe { self.shared.raw.create_pipeline_cache(&info, None) }
2339            .map_err(super::map_host_device_oom_err)?;
2340
2341        Ok(super::PipelineCache { raw })
2342    }
2343    fn pipeline_cache_validation_key(&self) -> Option<[u8; 16]> {
2344        Some(self.shared.pipeline_cache_validation_key)
2345    }
2346    unsafe fn destroy_pipeline_cache(&self, cache: super::PipelineCache) {
2347        unsafe { self.shared.raw.destroy_pipeline_cache(cache.raw, None) }
2348    }
2349    unsafe fn create_query_set(
2350        &self,
2351        desc: &wgt::QuerySetDescriptor<crate::Label>,
2352    ) -> Result<super::QuerySet, crate::DeviceError> {
2353        // Assume each query is 256 bytes.
2354        // On an AMD W6800 with driver version 32.0.12030.9, occlusion queries are 256.
2355        self.error_if_would_oom_on_resource_allocation(true, desc.count as u64 * 256)?;
2356
2357        let (vk_type, pipeline_statistics) = match desc.ty {
2358            wgt::QueryType::Occlusion => (
2359                vk::QueryType::OCCLUSION,
2360                vk::QueryPipelineStatisticFlags::empty(),
2361            ),
2362            wgt::QueryType::PipelineStatistics(statistics) => (
2363                vk::QueryType::PIPELINE_STATISTICS,
2364                conv::map_pipeline_statistics(statistics),
2365            ),
2366            wgt::QueryType::Timestamp => (
2367                vk::QueryType::TIMESTAMP,
2368                vk::QueryPipelineStatisticFlags::empty(),
2369            ),
2370        };
2371
2372        let vk_info = vk::QueryPoolCreateInfo::default()
2373            .query_type(vk_type)
2374            .query_count(desc.count)
2375            .pipeline_statistics(pipeline_statistics);
2376
2377        let raw = unsafe { self.shared.raw.create_query_pool(&vk_info, None) }
2378            .map_err(super::map_host_device_oom_err)?;
2379        if let Some(label) = desc.label {
2380            unsafe { self.shared.set_object_name(raw, label) };
2381        }
2382
2383        self.counters.query_sets.add(1);
2384
2385        Ok(super::QuerySet { raw })
2386    }
2387
2388    unsafe fn destroy_query_set(&self, set: super::QuerySet) {
2389        unsafe { self.shared.raw.destroy_query_pool(set.raw, None) };
2390
2391        self.counters.query_sets.sub(1);
2392    }
2393
2394    unsafe fn create_fence(&self) -> Result<super::Fence, crate::DeviceError> {
2395        self.counters.fences.add(1);
2396
2397        Ok(if self.shared.private_caps.timeline_semaphores {
2398            let mut sem_type_info =
2399                vk::SemaphoreTypeCreateInfo::default().semaphore_type(vk::SemaphoreType::TIMELINE);
2400            let vk_info = vk::SemaphoreCreateInfo::default().push_next(&mut sem_type_info);
2401            let raw = unsafe { self.shared.raw.create_semaphore(&vk_info, None) }
2402                .map_err(super::map_host_device_oom_err)?;
2403
2404            super::Fence::TimelineSemaphore(raw)
2405        } else {
2406            super::Fence::FencePool {
2407                last_completed: 0,
2408                active: Vec::new(),
2409                free: Vec::new(),
2410            }
2411        })
2412    }
2413    unsafe fn destroy_fence(&self, fence: super::Fence) {
2414        match fence {
2415            super::Fence::TimelineSemaphore(raw) => {
2416                unsafe { self.shared.raw.destroy_semaphore(raw, None) };
2417            }
2418            super::Fence::FencePool {
2419                active,
2420                free,
2421                last_completed: _,
2422            } => {
2423                for (_, raw) in active {
2424                    unsafe { self.shared.raw.destroy_fence(raw, None) };
2425                }
2426                for raw in free {
2427                    unsafe { self.shared.raw.destroy_fence(raw, None) };
2428                }
2429            }
2430        }
2431
2432        self.counters.fences.sub(1);
2433    }
2434    unsafe fn get_fence_value(
2435        &self,
2436        fence: &super::Fence,
2437    ) -> Result<crate::FenceValue, crate::DeviceError> {
2438        fence.get_latest(
2439            &self.shared.raw,
2440            self.shared.extension_fns.timeline_semaphore.as_ref(),
2441        )
2442    }
2443    unsafe fn wait(
2444        &self,
2445        fence: &super::Fence,
2446        wait_value: crate::FenceValue,
2447        timeout: Option<Duration>,
2448    ) -> Result<bool, crate::DeviceError> {
2449        let timeout_ns = timeout
2450            .unwrap_or(Duration::MAX)
2451            .as_nanos()
2452            .min(u64::MAX as _) as u64;
2453        self.shared.wait_for_fence(fence, wait_value, timeout_ns)
2454    }
2455
2456    unsafe fn start_graphics_debugger_capture(&self) -> bool {
2457        #[cfg(feature = "renderdoc")]
2458        {
2459            // Renderdoc requires us to give us the pointer that vkInstance _points to_.
2460            let raw_vk_instance =
2461                vk::Handle::as_raw(self.shared.instance.raw.handle()) as *mut *mut _;
2462            let raw_vk_instance_dispatch_table = unsafe { *raw_vk_instance };
2463            unsafe {
2464                self.render_doc
2465                    .start_frame_capture(raw_vk_instance_dispatch_table, ptr::null_mut())
2466            }
2467        }
2468        #[cfg(not(feature = "renderdoc"))]
2469        false
2470    }
2471    unsafe fn stop_graphics_debugger_capture(&self) {
2472        #[cfg(feature = "renderdoc")]
2473        {
2474            // Renderdoc requires us to give us the pointer that vkInstance _points to_.
2475            let raw_vk_instance =
2476                vk::Handle::as_raw(self.shared.instance.raw.handle()) as *mut *mut _;
2477            let raw_vk_instance_dispatch_table = unsafe { *raw_vk_instance };
2478
2479            unsafe {
2480                self.render_doc
2481                    .end_frame_capture(raw_vk_instance_dispatch_table, ptr::null_mut())
2482            }
2483        }
2484    }
2485
2486    unsafe fn pipeline_cache_get_data(&self, cache: &super::PipelineCache) -> Option<Vec<u8>> {
2487        let data = unsafe { self.raw_device().get_pipeline_cache_data(cache.raw) };
2488        data.ok()
2489    }
2490
2491    unsafe fn get_acceleration_structure_build_sizes<'a>(
2492        &self,
2493        desc: &crate::GetAccelerationStructureBuildSizesDescriptor<'a, super::Buffer>,
2494    ) -> crate::AccelerationStructureBuildSizes {
2495        const CAPACITY: usize = 8;
2496
2497        let ray_tracing_functions = self
2498            .shared
2499            .extension_fns
2500            .ray_tracing
2501            .as_ref()
2502            .expect("Feature `RAY_TRACING` not enabled");
2503
2504        let (geometries, primitive_counts) = match *desc.entries {
2505            crate::AccelerationStructureEntries::Instances(ref instances) => {
2506                let instance_data = vk::AccelerationStructureGeometryInstancesDataKHR::default();
2507
2508                let geometry = vk::AccelerationStructureGeometryKHR::default()
2509                    .geometry_type(vk::GeometryTypeKHR::INSTANCES)
2510                    .geometry(vk::AccelerationStructureGeometryDataKHR {
2511                        instances: instance_data,
2512                    });
2513
2514                (
2515                    smallvec::smallvec![geometry],
2516                    smallvec::smallvec![instances.count],
2517                )
2518            }
2519            crate::AccelerationStructureEntries::Triangles(ref in_geometries) => {
2520                let mut primitive_counts =
2521                    smallvec::SmallVec::<[u32; CAPACITY]>::with_capacity(in_geometries.len());
2522                let mut geometries = smallvec::SmallVec::<
2523                    [vk::AccelerationStructureGeometryKHR; CAPACITY],
2524                >::with_capacity(in_geometries.len());
2525
2526                for triangles in in_geometries {
2527                    let mut triangle_data =
2528                        vk::AccelerationStructureGeometryTrianglesDataKHR::default()
2529                            .index_type(vk::IndexType::NONE_KHR)
2530                            .vertex_format(conv::map_vertex_format(triangles.vertex_format))
2531                            .max_vertex(triangles.vertex_count)
2532                            .vertex_stride(triangles.vertex_stride)
2533                            // The vulkan spec suggests we could pass a non-zero invalid address here if fetching
2534                            // the real address has significant overhead, but we pass the real one to be on the
2535                            // safe side for now.
2536                            // from https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetAccelerationStructureBuildSizesKHR.html
2537                            // > The srcAccelerationStructure, dstAccelerationStructure, and mode members
2538                            // > of pBuildInfo are ignored. Any VkDeviceOrHostAddressKHR or VkDeviceOrHostAddressConstKHR
2539                            // > members of pBuildInfo are ignored by this command, except that the hostAddress
2540                            // > member of VkAccelerationStructureGeometryTrianglesDataKHR::transformData will
2541                            // > be examined to check if it is NULL.
2542                            .transform_data(vk::DeviceOrHostAddressConstKHR {
2543                                device_address: if desc
2544                                    .flags
2545                                    .contains(wgt::AccelerationStructureFlags::USE_TRANSFORM)
2546                                {
2547                                    unsafe {
2548                                        ray_tracing_functions
2549                                            .buffer_device_address
2550                                            .get_buffer_device_address(
2551                                                &vk::BufferDeviceAddressInfo::default().buffer(
2552                                                    triangles
2553                                                        .transform
2554                                                        .as_ref()
2555                                                        .unwrap()
2556                                                        .buffer
2557                                                        .raw,
2558                                                ),
2559                                            )
2560                                    }
2561                                } else {
2562                                    0
2563                                },
2564                            });
2565
2566                    let pritive_count = if let Some(ref indices) = triangles.indices {
2567                        triangle_data =
2568                            triangle_data.index_type(conv::map_index_format(indices.format));
2569                        indices.count / 3
2570                    } else {
2571                        triangles.vertex_count / 3
2572                    };
2573
2574                    let geometry = vk::AccelerationStructureGeometryKHR::default()
2575                        .geometry_type(vk::GeometryTypeKHR::TRIANGLES)
2576                        .geometry(vk::AccelerationStructureGeometryDataKHR {
2577                            triangles: triangle_data,
2578                        })
2579                        .flags(conv::map_acceleration_structure_geometry_flags(
2580                            triangles.flags,
2581                        ));
2582
2583                    geometries.push(geometry);
2584                    primitive_counts.push(pritive_count);
2585                }
2586                (geometries, primitive_counts)
2587            }
2588            crate::AccelerationStructureEntries::AABBs(ref in_geometries) => {
2589                let mut primitive_counts =
2590                    smallvec::SmallVec::<[u32; CAPACITY]>::with_capacity(in_geometries.len());
2591                let mut geometries = smallvec::SmallVec::<
2592                    [vk::AccelerationStructureGeometryKHR; CAPACITY],
2593                >::with_capacity(in_geometries.len());
2594                for aabb in in_geometries {
2595                    let aabbs_data = vk::AccelerationStructureGeometryAabbsDataKHR::default()
2596                        .stride(aabb.stride);
2597
2598                    let geometry = vk::AccelerationStructureGeometryKHR::default()
2599                        .geometry_type(vk::GeometryTypeKHR::AABBS)
2600                        .geometry(vk::AccelerationStructureGeometryDataKHR { aabbs: aabbs_data })
2601                        .flags(conv::map_acceleration_structure_geometry_flags(aabb.flags));
2602
2603                    geometries.push(geometry);
2604                    primitive_counts.push(aabb.count);
2605                }
2606                (geometries, primitive_counts)
2607            }
2608        };
2609
2610        let ty = match *desc.entries {
2611            crate::AccelerationStructureEntries::Instances(_) => {
2612                vk::AccelerationStructureTypeKHR::TOP_LEVEL
2613            }
2614            _ => vk::AccelerationStructureTypeKHR::BOTTOM_LEVEL,
2615        };
2616
2617        let geometry_info = vk::AccelerationStructureBuildGeometryInfoKHR::default()
2618            .ty(ty)
2619            .flags(conv::map_acceleration_structure_flags(desc.flags))
2620            .geometries(&geometries);
2621
2622        let mut raw = Default::default();
2623        unsafe {
2624            ray_tracing_functions
2625                .acceleration_structure
2626                .get_acceleration_structure_build_sizes(
2627                    vk::AccelerationStructureBuildTypeKHR::DEVICE,
2628                    &geometry_info,
2629                    &primitive_counts,
2630                    &mut raw,
2631                )
2632        }
2633
2634        crate::AccelerationStructureBuildSizes {
2635            acceleration_structure_size: raw.acceleration_structure_size,
2636            update_scratch_size: raw.update_scratch_size,
2637            build_scratch_size: raw.build_scratch_size,
2638        }
2639    }
2640
2641    unsafe fn get_acceleration_structure_device_address(
2642        &self,
2643        acceleration_structure: &super::AccelerationStructure,
2644    ) -> wgt::BufferAddress {
2645        let ray_tracing_functions = self
2646            .shared
2647            .extension_fns
2648            .ray_tracing
2649            .as_ref()
2650            .expect("Feature `RAY_TRACING` not enabled");
2651
2652        unsafe {
2653            ray_tracing_functions
2654                .acceleration_structure
2655                .get_acceleration_structure_device_address(
2656                    &vk::AccelerationStructureDeviceAddressInfoKHR::default()
2657                        .acceleration_structure(acceleration_structure.raw),
2658                )
2659        }
2660    }
2661
2662    unsafe fn create_acceleration_structure(
2663        &self,
2664        desc: &crate::AccelerationStructureDescriptor,
2665    ) -> Result<super::AccelerationStructure, crate::DeviceError> {
2666        let ray_tracing_functions = self
2667            .shared
2668            .extension_fns
2669            .ray_tracing
2670            .as_ref()
2671            .expect("Feature `RAY_TRACING` not enabled");
2672
2673        let vk_buffer_info = vk::BufferCreateInfo::default()
2674            .size(desc.size)
2675            .usage(
2676                vk::BufferUsageFlags::ACCELERATION_STRUCTURE_STORAGE_KHR
2677                    | vk::BufferUsageFlags::SHADER_DEVICE_ADDRESS,
2678            )
2679            .sharing_mode(vk::SharingMode::EXCLUSIVE);
2680
2681        unsafe {
2682            let raw_buffer = self
2683                .shared
2684                .raw
2685                .create_buffer(&vk_buffer_info, None)
2686                .map_err(super::map_host_device_oom_and_ioca_err)?;
2687            let req = self.shared.raw.get_buffer_memory_requirements(raw_buffer);
2688
2689            self.error_if_would_oom_on_resource_allocation(false, req.size)
2690                .inspect_err(|_| {
2691                    self.shared.raw.destroy_buffer(raw_buffer, None);
2692                })?;
2693
2694            let block = self
2695                .mem_allocator
2696                .lock()
2697                .alloc(
2698                    &*self.shared,
2699                    gpu_alloc::Request {
2700                        size: req.size,
2701                        align_mask: req.alignment - 1,
2702                        usage: gpu_alloc::UsageFlags::FAST_DEVICE_ACCESS,
2703                        memory_types: req.memory_type_bits & self.valid_ash_memory_types,
2704                    },
2705                )
2706                .inspect_err(|_| {
2707                    self.shared.raw.destroy_buffer(raw_buffer, None);
2708                })?;
2709
2710            self.shared
2711                .raw
2712                .bind_buffer_memory(raw_buffer, *block.memory(), block.offset())
2713                .map_err(super::map_host_device_oom_and_ioca_err)
2714                .inspect_err(|_| {
2715                    self.shared.raw.destroy_buffer(raw_buffer, None);
2716                })?;
2717
2718            if let Some(label) = desc.label {
2719                self.shared.set_object_name(raw_buffer, label);
2720            }
2721
2722            let vk_info = vk::AccelerationStructureCreateInfoKHR::default()
2723                .buffer(raw_buffer)
2724                .offset(0)
2725                .size(desc.size)
2726                .ty(conv::map_acceleration_structure_format(desc.format));
2727
2728            let raw_acceleration_structure = ray_tracing_functions
2729                .acceleration_structure
2730                .create_acceleration_structure(&vk_info, None)
2731                .map_err(super::map_host_oom_and_ioca_err)
2732                .inspect_err(|_| {
2733                    self.shared.raw.destroy_buffer(raw_buffer, None);
2734                })?;
2735
2736            if let Some(label) = desc.label {
2737                self.shared
2738                    .set_object_name(raw_acceleration_structure, label);
2739            }
2740
2741            let pool = if desc.allow_compaction {
2742                let vk_info = vk::QueryPoolCreateInfo::default()
2743                    .query_type(vk::QueryType::ACCELERATION_STRUCTURE_COMPACTED_SIZE_KHR)
2744                    .query_count(1);
2745
2746                let raw = self
2747                    .shared
2748                    .raw
2749                    .create_query_pool(&vk_info, None)
2750                    .map_err(super::map_host_device_oom_err)
2751                    .inspect_err(|_| {
2752                        ray_tracing_functions
2753                            .acceleration_structure
2754                            .destroy_acceleration_structure(raw_acceleration_structure, None);
2755                        self.shared.raw.destroy_buffer(raw_buffer, None);
2756                    })?;
2757                Some(raw)
2758            } else {
2759                None
2760            };
2761
2762            Ok(super::AccelerationStructure {
2763                raw: raw_acceleration_structure,
2764                buffer: raw_buffer,
2765                block: Mutex::new(block),
2766                compacted_size_query: pool,
2767            })
2768        }
2769    }
2770
2771    unsafe fn destroy_acceleration_structure(
2772        &self,
2773        acceleration_structure: super::AccelerationStructure,
2774    ) {
2775        let ray_tracing_functions = self
2776            .shared
2777            .extension_fns
2778            .ray_tracing
2779            .as_ref()
2780            .expect("Feature `RAY_TRACING` not enabled");
2781
2782        unsafe {
2783            ray_tracing_functions
2784                .acceleration_structure
2785                .destroy_acceleration_structure(acceleration_structure.raw, None);
2786            self.shared
2787                .raw
2788                .destroy_buffer(acceleration_structure.buffer, None);
2789            self.mem_allocator
2790                .lock()
2791                .dealloc(&*self.shared, acceleration_structure.block.into_inner());
2792            if let Some(query) = acceleration_structure.compacted_size_query {
2793                self.shared.raw.destroy_query_pool(query, None)
2794            }
2795        }
2796    }
2797
2798    fn get_internal_counters(&self) -> wgt::HalCounters {
2799        self.counters
2800            .memory_allocations
2801            .set(self.shared.memory_allocations_counter.read());
2802
2803        self.counters.as_ref().clone()
2804    }
2805
2806    fn tlas_instance_to_bytes(&self, instance: TlasInstance) -> Vec<u8> {
2807        const MAX_U24: u32 = (1u32 << 24u32) - 1u32;
2808        let temp = RawTlasInstance {
2809            transform: instance.transform,
2810            custom_data_and_mask: (instance.custom_data & MAX_U24)
2811                | (u32::from(instance.mask) << 24),
2812            shader_binding_table_record_offset_and_flags: 0,
2813            acceleration_structure_reference: instance.blas_address,
2814        };
2815        bytemuck::bytes_of(&temp).to_vec()
2816    }
2817
2818    fn check_if_oom(&self) -> Result<(), crate::DeviceError> {
2819        let Some(threshold) = self
2820            .shared
2821            .instance
2822            .memory_budget_thresholds
2823            .for_device_loss
2824        else {
2825            return Ok(());
2826        };
2827
2828        if !self
2829            .shared
2830            .enabled_extensions
2831            .contains(&ext::memory_budget::NAME)
2832        {
2833            return Ok(());
2834        }
2835
2836        let get_physical_device_properties = self
2837            .shared
2838            .instance
2839            .get_physical_device_properties
2840            .as_ref()
2841            .unwrap();
2842
2843        let mut memory_budget_properties = vk::PhysicalDeviceMemoryBudgetPropertiesEXT::default();
2844
2845        let mut memory_properties =
2846            vk::PhysicalDeviceMemoryProperties2::default().push_next(&mut memory_budget_properties);
2847
2848        unsafe {
2849            get_physical_device_properties.get_physical_device_memory_properties2(
2850                self.shared.physical_device,
2851                &mut memory_properties,
2852            );
2853        }
2854
2855        let memory_properties = memory_properties.memory_properties;
2856
2857        for i in 0..memory_properties.memory_heap_count {
2858            let heap_usage = memory_budget_properties.heap_usage[i as usize];
2859            let heap_budget = memory_budget_properties.heap_budget[i as usize];
2860
2861            if heap_usage >= heap_budget / 100 * threshold as u64 {
2862                return Err(crate::DeviceError::OutOfMemory);
2863            }
2864        }
2865
2866        Ok(())
2867    }
2868}
2869
2870impl super::DeviceShared {
2871    pub(super) fn new_binary_semaphore(
2872        &self,
2873        name: &str,
2874    ) -> Result<vk::Semaphore, crate::DeviceError> {
2875        unsafe {
2876            let semaphore = self
2877                .raw
2878                .create_semaphore(&vk::SemaphoreCreateInfo::default(), None)
2879                .map_err(super::map_host_device_oom_err)?;
2880
2881            self.set_object_name(semaphore, name);
2882
2883            Ok(semaphore)
2884        }
2885    }
2886
2887    pub(super) fn wait_for_fence(
2888        &self,
2889        fence: &super::Fence,
2890        wait_value: crate::FenceValue,
2891        timeout_ns: u64,
2892    ) -> Result<bool, crate::DeviceError> {
2893        profiling::scope!("Device::wait");
2894        match *fence {
2895            super::Fence::TimelineSemaphore(raw) => {
2896                let semaphores = [raw];
2897                let values = [wait_value];
2898                let vk_info = vk::SemaphoreWaitInfo::default()
2899                    .semaphores(&semaphores)
2900                    .values(&values);
2901                let result = match self.extension_fns.timeline_semaphore {
2902                    Some(super::ExtensionFn::Extension(ref ext)) => unsafe {
2903                        ext.wait_semaphores(&vk_info, timeout_ns)
2904                    },
2905                    Some(super::ExtensionFn::Promoted) => unsafe {
2906                        self.raw.wait_semaphores(&vk_info, timeout_ns)
2907                    },
2908                    None => unreachable!(),
2909                };
2910                match result {
2911                    Ok(()) => Ok(true),
2912                    Err(vk::Result::TIMEOUT) => Ok(false),
2913                    Err(other) => Err(super::map_host_device_oom_and_lost_err(other)),
2914                }
2915            }
2916            super::Fence::FencePool {
2917                last_completed,
2918                ref active,
2919                free: _,
2920            } => {
2921                if wait_value <= last_completed {
2922                    Ok(true)
2923                } else {
2924                    match active.iter().find(|&&(value, _)| value >= wait_value) {
2925                        Some(&(_, raw)) => {
2926                            match unsafe { self.raw.wait_for_fences(&[raw], true, timeout_ns) } {
2927                                Ok(()) => Ok(true),
2928                                Err(vk::Result::TIMEOUT) => Ok(false),
2929                                Err(other) => Err(super::map_host_device_oom_and_lost_err(other)),
2930                            }
2931                        }
2932                        None => {
2933                            crate::hal_usage_error(format!(
2934                                "no signals reached value {wait_value}"
2935                            ));
2936                        }
2937                    }
2938                }
2939            }
2940        }
2941    }
2942}
2943
2944impl From<gpu_alloc::AllocationError> for crate::DeviceError {
2945    fn from(error: gpu_alloc::AllocationError) -> Self {
2946        use gpu_alloc::AllocationError as Ae;
2947        match error {
2948            Ae::OutOfDeviceMemory | Ae::OutOfHostMemory | Ae::TooManyObjects => Self::OutOfMemory,
2949            Ae::NoCompatibleMemoryTypes => crate::hal_usage_error(error),
2950        }
2951    }
2952}
2953impl From<gpu_alloc::MapError> for crate::DeviceError {
2954    fn from(error: gpu_alloc::MapError) -> Self {
2955        use gpu_alloc::MapError as Me;
2956        match error {
2957            Me::OutOfDeviceMemory | Me::OutOfHostMemory | Me::MapFailed => Self::OutOfMemory,
2958            Me::NonHostVisible | Me::AlreadyMapped => crate::hal_usage_error(error),
2959        }
2960    }
2961}
2962impl From<gpu_descriptor::AllocationError> for crate::DeviceError {
2963    fn from(error: gpu_descriptor::AllocationError) -> Self {
2964        use gpu_descriptor::AllocationError as Ae;
2965        match error {
2966            Ae::OutOfDeviceMemory | Ae::OutOfHostMemory | Ae::Fragmentation => Self::OutOfMemory,
2967        }
2968    }
2969}
2970
2971/// We usually map unexpected vulkan errors to the [`crate::DeviceError::Unexpected`]
2972/// variant to be more robust even in cases where the driver is not
2973/// complying with the spec.
2974///
2975/// However, we implement a few Trait methods that don't have an equivalent
2976/// error variant. In those cases we use this function.
2977fn handle_unexpected(err: vk::Result) -> ! {
2978    panic!("Unexpected Vulkan error: `{err}`")
2979}
2980
2981struct ImageWithoutMemory {
2982    raw: vk::Image,
2983    requirements: vk::MemoryRequirements,
2984    copy_size: crate::CopyExtent,
2985}