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