• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright © 2021 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  */
23 
24 #include "vk_image.h"
25 
26 #if DETECT_OS_LINUX || DETECT_OS_BSD
27 #include <drm-uapi/drm_fourcc.h>
28 #endif
29 
30 #include "vk_alloc.h"
31 #include "vk_common_entrypoints.h"
32 #include "vk_device.h"
33 #include "vk_format.h"
34 #include "vk_format_info.h"
35 #include "vk_log.h"
36 #include "vk_physical_device.h"
37 #include "vk_render_pass.h"
38 #include "vk_util.h"
39 #include "vulkan/wsi/wsi_common.h"
40 
41 #if DETECT_OS_ANDROID
42 #include "vk_android.h"
43 #include <vulkan/vulkan_android.h>
44 #endif
45 
46 void
vk_image_init(struct vk_device * device,struct vk_image * image,const VkImageCreateInfo * pCreateInfo)47 vk_image_init(struct vk_device *device,
48               struct vk_image *image,
49               const VkImageCreateInfo *pCreateInfo)
50 {
51    vk_object_base_init(device, &image->base, VK_OBJECT_TYPE_IMAGE);
52 
53    assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO);
54    assert(pCreateInfo->mipLevels > 0);
55    assert(pCreateInfo->arrayLayers > 0);
56    assert(pCreateInfo->samples > 0);
57    assert(pCreateInfo->extent.width > 0);
58    assert(pCreateInfo->extent.height > 0);
59    assert(pCreateInfo->extent.depth > 0);
60 
61    if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)
62       assert(pCreateInfo->imageType == VK_IMAGE_TYPE_2D);
63    if (pCreateInfo->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)
64       assert(pCreateInfo->imageType == VK_IMAGE_TYPE_3D);
65 
66    image->create_flags = pCreateInfo->flags;
67    image->image_type = pCreateInfo->imageType;
68    vk_image_set_format(image, pCreateInfo->format);
69    image->extent = vk_image_sanitize_extent(image, pCreateInfo->extent);
70    image->mip_levels = pCreateInfo->mipLevels;
71    image->array_layers = pCreateInfo->arrayLayers;
72    image->samples = pCreateInfo->samples;
73    image->tiling = pCreateInfo->tiling;
74    image->usage = pCreateInfo->usage;
75    image->sharing_mode = pCreateInfo->sharingMode;
76 
77    if (image->aspects & VK_IMAGE_ASPECT_STENCIL_BIT) {
78       const VkImageStencilUsageCreateInfo *stencil_usage_info =
79          vk_find_struct_const(pCreateInfo->pNext,
80                               IMAGE_STENCIL_USAGE_CREATE_INFO);
81       image->stencil_usage =
82          stencil_usage_info ? stencil_usage_info->stencilUsage :
83                               pCreateInfo->usage;
84    } else {
85       image->stencil_usage = 0;
86    }
87 
88    const VkExternalMemoryImageCreateInfo *ext_mem_info =
89       vk_find_struct_const(pCreateInfo->pNext, EXTERNAL_MEMORY_IMAGE_CREATE_INFO);
90    if (ext_mem_info)
91       image->external_handle_types = ext_mem_info->handleTypes;
92    else
93       image->external_handle_types = 0;
94 
95    const struct wsi_image_create_info *wsi_info =
96       vk_find_struct_const(pCreateInfo->pNext, WSI_IMAGE_CREATE_INFO_MESA);
97    image->wsi_legacy_scanout = wsi_info && wsi_info->scanout;
98 
99 #if DETECT_OS_LINUX || DETECT_OS_BSD
100    image->drm_format_mod = ((1ULL << 56) - 1) /* DRM_FORMAT_MOD_INVALID */;
101 #endif
102 
103 #if DETECT_OS_ANDROID
104    if (image->external_handle_types &
105              VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)
106       image->android_buffer_type = ANDROID_BUFFER_HARDWARE;
107 
108    const VkNativeBufferANDROID *native_buffer =
109       vk_find_struct_const(pCreateInfo->pNext, NATIVE_BUFFER_ANDROID);
110 
111    if (native_buffer != NULL) {
112       assert(image->android_buffer_type == ANDROID_BUFFER_NONE);
113       image->android_buffer_type = ANDROID_BUFFER_NATIVE;
114    }
115 
116    const VkExternalFormatANDROID *ext_format =
117       vk_find_struct_const(pCreateInfo->pNext, EXTERNAL_FORMAT_ANDROID);
118    if (ext_format && ext_format->externalFormat != 0) {
119       assert(image->format == VK_FORMAT_UNDEFINED);
120       assert(image->external_handle_types &
121              VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID);
122       vk_image_set_format(image, (VkFormat)ext_format->externalFormat);
123    }
124 
125    image->ahb_format = vk_image_format_to_ahb_format(image->format);
126 #endif
127 
128    const VkImageCompressionControlEXT *compr_info =
129       vk_find_struct_const(pCreateInfo->pNext, IMAGE_COMPRESSION_CONTROL_EXT);
130    if (compr_info)
131       image->compr_flags = compr_info->flags;
132 }
133 
134 void *
vk_image_create(struct vk_device * device,const VkImageCreateInfo * pCreateInfo,const VkAllocationCallbacks * alloc,size_t size)135 vk_image_create(struct vk_device *device,
136                 const VkImageCreateInfo *pCreateInfo,
137                 const VkAllocationCallbacks *alloc,
138                 size_t size)
139 {
140    struct vk_image *image =
141       vk_zalloc2(&device->alloc, alloc, size, 8,
142                  VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
143    if (image == NULL)
144       return NULL;
145 
146    vk_image_init(device, image, pCreateInfo);
147 
148    return image;
149 }
150 
151 void
vk_image_finish(struct vk_image * image)152 vk_image_finish(struct vk_image *image)
153 {
154    vk_object_base_finish(&image->base);
155 }
156 
157 void
vk_image_destroy(struct vk_device * device,const VkAllocationCallbacks * alloc,struct vk_image * image)158 vk_image_destroy(struct vk_device *device,
159                  const VkAllocationCallbacks *alloc,
160                  struct vk_image *image)
161 {
162 #if DETECT_OS_ANDROID
163    if (image->anb_memory) {
164       device->dispatch_table.FreeMemory(
165          (VkDevice)device, image->anb_memory, alloc);
166    }
167 #endif
168    vk_object_free(device, alloc, image);
169 }
170 
171 #if DETECT_OS_LINUX || DETECT_OS_BSD
172 VKAPI_ATTR VkResult VKAPI_CALL
vk_common_GetImageDrmFormatModifierPropertiesEXT(UNUSED VkDevice device,VkImage _image,VkImageDrmFormatModifierPropertiesEXT * pProperties)173 vk_common_GetImageDrmFormatModifierPropertiesEXT(UNUSED VkDevice device,
174                                                  VkImage _image,
175                                                  VkImageDrmFormatModifierPropertiesEXT *pProperties)
176 {
177    VK_FROM_HANDLE(vk_image, image, _image);
178 
179    assert(pProperties->sType ==
180           VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT);
181 
182    assert(image->tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT);
183    pProperties->drmFormatModifier = image->drm_format_mod;
184 
185    return VK_SUCCESS;
186 }
187 #endif
188 
189 VKAPI_ATTR void VKAPI_CALL
vk_common_GetImageSubresourceLayout(VkDevice _device,VkImage _image,const VkImageSubresource * pSubresource,VkSubresourceLayout * pLayout)190 vk_common_GetImageSubresourceLayout(VkDevice _device, VkImage _image,
191                                     const VkImageSubresource *pSubresource,
192                                     VkSubresourceLayout *pLayout)
193 {
194    VK_FROM_HANDLE(vk_device, device, _device);
195 
196    const VkImageSubresource2KHR subresource = {
197       .sType = VK_STRUCTURE_TYPE_IMAGE_SUBRESOURCE_2_KHR,
198       .imageSubresource = *pSubresource,
199    };
200 
201    VkSubresourceLayout2KHR layout = {
202       .sType = VK_STRUCTURE_TYPE_SUBRESOURCE_LAYOUT_2_KHR
203    };
204 
205    device->dispatch_table.GetImageSubresourceLayout2KHR(_device, _image,
206                                                         &subresource, &layout);
207 
208    *pLayout = layout.subresourceLayout;
209 }
210 
211 void
vk_image_set_format(struct vk_image * image,VkFormat format)212 vk_image_set_format(struct vk_image *image, VkFormat format)
213 {
214    image->format = format;
215    image->aspects = vk_format_aspects(format);
216 }
217 
218 VkImageUsageFlags
vk_image_usage(const struct vk_image * image,VkImageAspectFlags aspect_mask)219 vk_image_usage(const struct vk_image *image,
220                VkImageAspectFlags aspect_mask)
221 {
222    /* From the Vulkan 1.2.131 spec:
223     *
224     *    "If the image was has a depth-stencil format and was created with
225     *    a VkImageStencilUsageCreateInfo structure included in the pNext
226     *    chain of VkImageCreateInfo, the usage is calculated based on the
227     *    subresource.aspectMask provided:
228     *
229     *     - If aspectMask includes only VK_IMAGE_ASPECT_STENCIL_BIT, the
230     *       implicit usage is equal to
231     *       VkImageStencilUsageCreateInfo::stencilUsage.
232     *
233     *     - If aspectMask includes only VK_IMAGE_ASPECT_DEPTH_BIT, the
234     *       implicit usage is equal to VkImageCreateInfo::usage.
235     *
236     *     - If both aspects are included in aspectMask, the implicit usage
237     *       is equal to the intersection of VkImageCreateInfo::usage and
238     *       VkImageStencilUsageCreateInfo::stencilUsage.
239     */
240    if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
241       return image->stencil_usage;
242    } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT |
243                               VK_IMAGE_ASPECT_STENCIL_BIT)) {
244       return image->usage & image->stencil_usage;
245    } else {
246       /* This also handles the color case */
247       return image->usage;
248    }
249 }
250 
251 #define VK_IMAGE_ASPECT_ANY_COLOR_MASK_MESA ( \
252    VK_IMAGE_ASPECT_COLOR_BIT | \
253    VK_IMAGE_ASPECT_PLANE_0_BIT | \
254    VK_IMAGE_ASPECT_PLANE_1_BIT | \
255    VK_IMAGE_ASPECT_PLANE_2_BIT)
256 
257 /** Expands the given aspect mask relative to the image
258  *
259  * If the image has color plane aspects VK_IMAGE_ASPECT_COLOR_BIT has been
260  * requested, this returns the aspects of the underlying image.
261  *
262  * For example,
263  *
264  *    VK_IMAGE_ASPECT_COLOR_BIT
265  *
266  * will be converted to
267  *
268  *    VK_IMAGE_ASPECT_PLANE_0_BIT |
269  *    VK_IMAGE_ASPECT_PLANE_1_BIT |
270  *    VK_IMAGE_ASPECT_PLANE_2_BIT
271  *
272  * for an image of format VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM.
273  */
274 VkImageAspectFlags
vk_image_expand_aspect_mask(const struct vk_image * image,VkImageAspectFlags aspect_mask)275 vk_image_expand_aspect_mask(const struct vk_image *image,
276                             VkImageAspectFlags aspect_mask)
277 {
278    if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
279       assert(image->aspects & VK_IMAGE_ASPECT_ANY_COLOR_MASK_MESA);
280       return image->aspects;
281    } else {
282       assert(aspect_mask && !(aspect_mask & ~image->aspects));
283       return aspect_mask;
284    }
285 }
286 
287 VkExtent3D
vk_image_extent_to_elements(const struct vk_image * image,VkExtent3D extent)288 vk_image_extent_to_elements(const struct vk_image *image, VkExtent3D extent)
289 {
290    const struct util_format_description *fmt =
291       vk_format_description(image->format);
292 
293    extent = vk_image_sanitize_extent(image, extent);
294    extent.width = DIV_ROUND_UP(extent.width, fmt->block.width);
295    extent.height = DIV_ROUND_UP(extent.height, fmt->block.height);
296    extent.depth = DIV_ROUND_UP(extent.depth, fmt->block.depth);
297 
298    return extent;
299 }
300 
301 VkOffset3D
vk_image_offset_to_elements(const struct vk_image * image,VkOffset3D offset)302 vk_image_offset_to_elements(const struct vk_image *image, VkOffset3D offset)
303 {
304    const struct util_format_description *fmt =
305       vk_format_description(image->format);
306 
307    offset = vk_image_sanitize_offset(image, offset);
308 
309    assert(offset.x % fmt->block.width == 0);
310    assert(offset.y % fmt->block.height == 0);
311    assert(offset.z % fmt->block.depth == 0);
312 
313    offset.x /= fmt->block.width;
314    offset.y /= fmt->block.height;
315    offset.z /= fmt->block.depth;
316 
317    return offset;
318 }
319 
320 struct vk_image_buffer_layout
vk_image_buffer_copy_layout(const struct vk_image * image,const VkBufferImageCopy2 * region)321 vk_image_buffer_copy_layout(const struct vk_image *image,
322                             const VkBufferImageCopy2* region)
323 {
324    VkExtent3D extent = vk_image_sanitize_extent(image, region->imageExtent);
325 
326    const uint32_t row_length = region->bufferRowLength ?
327                                region->bufferRowLength : extent.width;
328    const uint32_t image_height = region->bufferImageHeight ?
329                                  region->bufferImageHeight : extent.height;
330 
331    const VkImageAspectFlags aspect = region->imageSubresource.aspectMask;
332    VkFormat format = vk_format_get_aspect_format(image->format, aspect);
333    const struct util_format_description *fmt = vk_format_description(format);
334 
335    assert(fmt->block.bits % 8 == 0);
336    const uint32_t element_size_B = fmt->block.bits / 8;
337 
338    const uint32_t row_stride_B =
339       DIV_ROUND_UP(row_length, fmt->block.width) * element_size_B;
340    const uint64_t image_stride_B =
341       DIV_ROUND_UP(image_height, fmt->block.height) * (uint64_t)row_stride_B;
342 
343    return (struct vk_image_buffer_layout) {
344       .row_length = row_length,
345       .image_height = image_height,
346       .element_size_B = element_size_B,
347       .row_stride_B = row_stride_B,
348       .image_stride_B = image_stride_B,
349    };
350 }
351 
352 struct vk_image_buffer_layout
vk_memory_to_image_copy_layout(const struct vk_image * image,const VkMemoryToImageCopyEXT * region)353 vk_memory_to_image_copy_layout(const struct vk_image *image,
354                                const VkMemoryToImageCopyEXT* region)
355 {
356    const VkBufferImageCopy2 bic = {
357       .bufferOffset = 0,
358       .bufferRowLength = region->memoryRowLength,
359       .bufferImageHeight = region->memoryImageHeight,
360       .imageSubresource = region->imageSubresource,
361       .imageOffset = region->imageOffset,
362       .imageExtent = region->imageExtent,
363    };
364    return vk_image_buffer_copy_layout(image, &bic);
365 }
366 
367 struct vk_image_buffer_layout
vk_image_to_memory_copy_layout(const struct vk_image * image,const VkImageToMemoryCopyEXT * region)368 vk_image_to_memory_copy_layout(const struct vk_image *image,
369                                const VkImageToMemoryCopyEXT* region)
370 {
371    const VkBufferImageCopy2 bic = {
372       .bufferOffset = 0,
373       .bufferRowLength = region->memoryRowLength,
374       .bufferImageHeight = region->memoryImageHeight,
375       .imageSubresource = region->imageSubresource,
376       .imageOffset = region->imageOffset,
377       .imageExtent = region->imageExtent,
378    };
379    return vk_image_buffer_copy_layout(image, &bic);
380 }
381 
382 static VkComponentSwizzle
remap_swizzle(VkComponentSwizzle swizzle,VkComponentSwizzle component)383 remap_swizzle(VkComponentSwizzle swizzle, VkComponentSwizzle component)
384 {
385    return swizzle == VK_COMPONENT_SWIZZLE_IDENTITY ? component : swizzle;
386 }
387 
388 void
vk_image_view_init(struct vk_device * device,struct vk_image_view * image_view,bool driver_internal,const VkImageViewCreateInfo * pCreateInfo)389 vk_image_view_init(struct vk_device *device,
390                    struct vk_image_view *image_view,
391                    bool driver_internal,
392                    const VkImageViewCreateInfo *pCreateInfo)
393 {
394    vk_object_base_init(device, &image_view->base, VK_OBJECT_TYPE_IMAGE_VIEW);
395 
396    assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO);
397    VK_FROM_HANDLE(vk_image, image, pCreateInfo->image);
398 
399    image_view->create_flags = pCreateInfo->flags;
400    image_view->image = image;
401    image_view->view_type = pCreateInfo->viewType;
402 
403    image_view->format = pCreateInfo->format;
404    if (image_view->format == VK_FORMAT_UNDEFINED)
405       image_view->format = image->format;
406 
407    if (!driver_internal) {
408       switch (image_view->view_type) {
409       case VK_IMAGE_VIEW_TYPE_1D:
410       case VK_IMAGE_VIEW_TYPE_1D_ARRAY:
411          assert(image->image_type == VK_IMAGE_TYPE_1D);
412          break;
413       case VK_IMAGE_VIEW_TYPE_2D:
414       case VK_IMAGE_VIEW_TYPE_2D_ARRAY:
415          if (image->create_flags & (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT |
416                                     VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT))
417             assert(image->image_type == VK_IMAGE_TYPE_3D);
418          else
419             assert(image->image_type == VK_IMAGE_TYPE_2D);
420          break;
421       case VK_IMAGE_VIEW_TYPE_3D:
422          assert(image->image_type == VK_IMAGE_TYPE_3D);
423          break;
424       case VK_IMAGE_VIEW_TYPE_CUBE:
425       case VK_IMAGE_VIEW_TYPE_CUBE_ARRAY:
426          assert(image->image_type == VK_IMAGE_TYPE_2D);
427          assert(image->create_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT);
428          break;
429       default:
430          unreachable("Invalid image view type");
431       }
432    }
433 
434    const VkImageSubresourceRange *range = &pCreateInfo->subresourceRange;
435 
436    if (driver_internal) {
437       image_view->aspects = range->aspectMask;
438       image_view->view_format = image_view->format;
439    } else {
440       image_view->aspects =
441          vk_image_expand_aspect_mask(image, range->aspectMask);
442 
443       assert(!(image_view->aspects & ~image->aspects));
444       const VkImageUsageFlags video = VK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR |
445                                       VK_IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR |
446                                       VK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR |
447                                       VK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR |
448                                       VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR |
449                                       VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR;
450 
451       /* From the Vulkan 1.2.184 spec:
452        *
453        *    "If the image has a multi-planar format and
454        *    subresourceRange.aspectMask is VK_IMAGE_ASPECT_COLOR_BIT, and image
455        *    has been created with a usage value not containing any of the
456        *    VK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR,
457        *    VK_IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR,
458        *    VK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR,
459        *    VK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR,
460        *    VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR, and
461        *    VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR flags, then the format must
462        *    be identical to the image format, and the sampler to be used with the
463        *    image view must enable sampler Y′CBCR conversion."
464        *
465        */
466       if ((image->aspects & VK_IMAGE_ASPECT_PLANE_1_BIT) &&
467           (range->aspectMask == VK_IMAGE_ASPECT_COLOR_BIT) &&
468           !(image->usage & video))
469          assert(image_view->format == image->format);
470 
471       /* From the Vulkan 1.2.184 spec:
472        *
473        *    "Each depth/stencil format is only compatible with itself."
474        */
475       if (image_view->aspects & (VK_IMAGE_ASPECT_DEPTH_BIT |
476                                  VK_IMAGE_ASPECT_STENCIL_BIT))
477          assert(image_view->format == image->format);
478 
479       if (!(image->create_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT))
480          assert(image_view->format == image->format);
481 
482       /* Restrict the format to only the planes chosen.
483        *
484        * For combined depth and stencil images, this means the depth-only or
485        * stencil-only format if only one aspect is chosen and the full
486        * combined format if both aspects are chosen.
487        *
488        * For single-plane color images, we just take the format as-is.  For
489        * multi-plane views of multi-plane images, this means we want the full
490        * multi-plane format.  For single-plane views of multi-plane images, we
491        * want a format compatible with the one plane.  Fortunately, this is
492        * already what the client gives us.  The Vulkan 1.2.184 spec says:
493        *
494        *    "If image was created with the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT
495        *    and the image has a multi-planar format, and if
496        *    subresourceRange.aspectMask is VK_IMAGE_ASPECT_PLANE_0_BIT,
497        *    VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT,
498        *    format must be compatible with the corresponding plane of the
499        *    image, and the sampler to be used with the image view must not
500        *    enable sampler Y′CBCR conversion."
501        */
502       if (image_view->aspects == VK_IMAGE_ASPECT_STENCIL_BIT) {
503          image_view->view_format = vk_format_stencil_only(image_view->format);
504       } else if (image_view->aspects == VK_IMAGE_ASPECT_DEPTH_BIT) {
505          image_view->view_format = vk_format_depth_only(image_view->format);
506       } else {
507          image_view->view_format = image_view->format;
508       }
509    }
510 
511    image_view->swizzle = (VkComponentMapping) {
512       .r = remap_swizzle(pCreateInfo->components.r, VK_COMPONENT_SWIZZLE_R),
513       .g = remap_swizzle(pCreateInfo->components.g, VK_COMPONENT_SWIZZLE_G),
514       .b = remap_swizzle(pCreateInfo->components.b, VK_COMPONENT_SWIZZLE_B),
515       .a = remap_swizzle(pCreateInfo->components.a, VK_COMPONENT_SWIZZLE_A),
516    };
517 
518    assert(range->layerCount > 0);
519    assert(range->baseMipLevel < image->mip_levels);
520 
521    image_view->base_mip_level = range->baseMipLevel;
522    image_view->level_count = vk_image_subresource_level_count(image, range);
523    image_view->base_array_layer = range->baseArrayLayer;
524 
525    const VkImageViewMinLodCreateInfoEXT *min_lod_info =
526       vk_find_struct_const(pCreateInfo, IMAGE_VIEW_MIN_LOD_CREATE_INFO_EXT);
527    image_view->min_lod = min_lod_info ? min_lod_info->minLod : 0.0f;
528 
529    /* From the Vulkan 1.3.215 spec:
530     *
531     *    VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456
532     *
533     *    "minLod must be less or equal to the index of the last mipmap level
534     *    accessible to the view."
535     */
536    assert(image_view->min_lod <= image_view->base_mip_level +
537                                  image_view->level_count - 1);
538 
539    image_view->extent =
540       vk_image_mip_level_extent(image, image_view->base_mip_level);
541 
542    /* From the Vulkan 1.4.304 spec:
543     *
544     *     VUID-VkImageViewCreateInfo-image-02724
545     *
546     *     "If image is a 3D image created with
547     *     VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, and viewType is
548     *     VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY,
549     *     subresourceRange.baseArrayLayer must be less than the depth computed
550     *     from baseMipLevel and extent.depth specified in VkImageCreateInfo
551     *     when image was created, according to the formula defined in Image
552     *     Mip Level Sizing"
553     */
554    if (image->image_type == VK_IMAGE_TYPE_3D &&
555        (image_view->view_type == VK_IMAGE_VIEW_TYPE_2D ||
556         image_view->view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
557       image_view->layer_count =
558          range->layerCount == VK_REMAINING_ARRAY_LAYERS ?
559          image_view->extent.depth - range->baseArrayLayer :
560          range->layerCount;
561    } else {
562       image_view->layer_count = vk_image_subresource_layer_count(image, range);
563    }
564 
565    if (vk_format_is_compressed(image->format) &&
566        !vk_format_is_compressed(image_view->format)) {
567       const struct util_format_description *fmt =
568          vk_format_description(image->format);
569 
570       /* Non-compressed view of compressed image only works for single MIP
571        * views.
572        */
573       assert(image_view->level_count == 1);
574       image_view->extent.width =
575          DIV_ROUND_UP(image_view->extent.width, fmt->block.width);
576       image_view->extent.height =
577          DIV_ROUND_UP(image_view->extent.height, fmt->block.height);
578       image_view->extent.depth =
579          DIV_ROUND_UP(image_view->extent.depth, fmt->block.depth);
580    }
581 
582    /* By default storage uses the same as the image properties, but it can be
583     * overriden with VkImageViewSlicedCreateInfoEXT.
584     */
585    image_view->storage.z_slice_offset = 0;
586    image_view->storage.z_slice_count = image_view->extent.depth;
587 
588    const VkImageViewSlicedCreateInfoEXT *sliced_info =
589       vk_find_struct_const(pCreateInfo, IMAGE_VIEW_SLICED_CREATE_INFO_EXT);
590    assert(image_view->base_mip_level + image_view->level_count
591           <= image->mip_levels);
592    switch (image->image_type) {
593    default:
594       unreachable("bad VkImageType");
595    case VK_IMAGE_TYPE_1D:
596    case VK_IMAGE_TYPE_2D:
597       assert(image_view->base_array_layer + image_view->layer_count
598              <= image->array_layers);
599       break;
600    case VK_IMAGE_TYPE_3D:
601       if (sliced_info && image_view->view_type == VK_IMAGE_VIEW_TYPE_3D) {
602          unsigned total = image_view->extent.depth;
603          image_view->storage.z_slice_offset = sliced_info->sliceOffset;
604          assert(image_view->storage.z_slice_offset < total);
605          if (sliced_info->sliceCount == VK_REMAINING_3D_SLICES_EXT) {
606             image_view->storage.z_slice_count = total - image_view->storage.z_slice_offset;
607          } else {
608             image_view->storage.z_slice_count = sliced_info->sliceCount;
609          }
610       } else if (image_view->view_type != VK_IMAGE_VIEW_TYPE_3D) {
611          image_view->storage.z_slice_offset = image_view->base_array_layer;
612          image_view->storage.z_slice_count = image_view->layer_count;
613       }
614       assert(image_view->storage.z_slice_offset + image_view->storage.z_slice_count
615              <= image->extent.depth);
616       assert(image_view->base_array_layer + image_view->layer_count
617              <= image_view->extent.depth);
618       break;
619    }
620 
621    /* If we are creating a color view from a depth/stencil image we compute
622     * usage from the underlying depth/stencil aspects.
623     */
624    const VkImageUsageFlags image_usage =
625       vk_image_usage(image, image_view->aspects);
626    const VkImageViewUsageCreateInfo *usage_info =
627       vk_find_struct_const(pCreateInfo, IMAGE_VIEW_USAGE_CREATE_INFO);
628    image_view->usage = usage_info ? usage_info->usage : image_usage;
629    assert(driver_internal || !(image_view->usage & ~image_usage));
630 }
631 
632 void
vk_image_view_finish(struct vk_image_view * image_view)633 vk_image_view_finish(struct vk_image_view *image_view)
634 {
635    vk_object_base_finish(&image_view->base);
636 }
637 
638 void *
vk_image_view_create(struct vk_device * device,bool driver_internal,const VkImageViewCreateInfo * pCreateInfo,const VkAllocationCallbacks * alloc,size_t size)639 vk_image_view_create(struct vk_device *device,
640                      bool driver_internal,
641                      const VkImageViewCreateInfo *pCreateInfo,
642                      const VkAllocationCallbacks *alloc,
643                      size_t size)
644 {
645    struct vk_image_view *image_view =
646       vk_zalloc2(&device->alloc, alloc, size, 8,
647                  VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
648    if (image_view == NULL)
649       return NULL;
650 
651    vk_image_view_init(device, image_view, driver_internal, pCreateInfo);
652 
653    return image_view;
654 }
655 
656 void
vk_image_view_destroy(struct vk_device * device,const VkAllocationCallbacks * alloc,struct vk_image_view * image_view)657 vk_image_view_destroy(struct vk_device *device,
658                       const VkAllocationCallbacks *alloc,
659                       struct vk_image_view *image_view)
660 {
661    vk_object_free(device, alloc, image_view);
662 }
663 
664 bool
vk_image_layout_is_read_only(VkImageLayout layout,VkImageAspectFlagBits aspect)665 vk_image_layout_is_read_only(VkImageLayout layout,
666                              VkImageAspectFlagBits aspect)
667 {
668    assert(util_bitcount(aspect) == 1);
669 
670    switch (layout) {
671    case VK_IMAGE_LAYOUT_UNDEFINED:
672    case VK_IMAGE_LAYOUT_PREINITIALIZED:
673       return true; /* These are only used for layout transitions */
674 
675    case VK_IMAGE_LAYOUT_GENERAL:
676    case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
677    case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
678    case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
679    case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
680    case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL:
681    case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL:
682    case VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL:
683    case VK_IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT:
684    case VK_IMAGE_LAYOUT_RENDERING_LOCAL_READ_KHR:
685       return false;
686 
687    case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
688    case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
689    case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
690    case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR:
691    case VK_IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR:
692    case VK_IMAGE_LAYOUT_FRAGMENT_DENSITY_MAP_OPTIMAL_EXT:
693    case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL:
694    case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL:
695    case VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL:
696       return true;
697 
698    case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
699       return aspect == VK_IMAGE_ASPECT_DEPTH_BIT;
700 
701    case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
702       return aspect == VK_IMAGE_ASPECT_STENCIL_BIT;
703 
704    case VK_IMAGE_LAYOUT_MAX_ENUM:
705    case VK_IMAGE_LAYOUT_VIDEO_DECODE_DST_KHR:
706    case VK_IMAGE_LAYOUT_VIDEO_DECODE_SRC_KHR:
707    case VK_IMAGE_LAYOUT_VIDEO_DECODE_DPB_KHR:
708    case VK_IMAGE_LAYOUT_VIDEO_ENCODE_DST_KHR:
709    case VK_IMAGE_LAYOUT_VIDEO_ENCODE_SRC_KHR:
710    case VK_IMAGE_LAYOUT_VIDEO_ENCODE_DPB_KHR:
711    case VK_IMAGE_LAYOUT_VIDEO_ENCODE_QUANTIZATION_MAP_KHR:
712       unreachable("Invalid image layout.");
713    }
714 
715    unreachable("Invalid image layout.");
716 }
717 
718 bool
vk_image_layout_is_depth_only(VkImageLayout layout)719 vk_image_layout_is_depth_only(VkImageLayout layout)
720 {
721    switch (layout) {
722    case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL:
723    case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL:
724       return true;
725 
726    default:
727       return false;
728    }
729 }
730 
731 static VkResult
vk_image_create_get_format_list_uncompressed(struct vk_device * device,const VkImageCreateInfo * pCreateInfo,const VkAllocationCallbacks * pAllocator,VkFormat ** formats,uint32_t * format_count)732 vk_image_create_get_format_list_uncompressed(struct vk_device *device,
733                                              const VkImageCreateInfo *pCreateInfo,
734                                              const VkAllocationCallbacks *pAllocator,
735                                              VkFormat **formats,
736                                              uint32_t *format_count)
737 {
738    const struct vk_format_class_info *class =
739       vk_format_get_class_info(pCreateInfo->format);
740 
741    *formats = NULL;
742    *format_count = 0;
743 
744    if (class->format_count < 2)
745       return VK_SUCCESS;
746 
747    *formats = vk_alloc2(&device->alloc, pAllocator,
748                         sizeof(VkFormat) * class->format_count,
749                         alignof(VkFormat), VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
750    if (*formats == NULL)
751       return vk_error(device, VK_ERROR_OUT_OF_HOST_MEMORY);
752 
753    memcpy(*formats, class->formats, sizeof(VkFormat) * class->format_count);
754    *format_count = class->format_count;
755 
756    return VK_SUCCESS;
757 }
758 
759 static VkResult
vk_image_create_get_format_list_compressed(struct vk_device * device,const VkImageCreateInfo * pCreateInfo,const VkAllocationCallbacks * pAllocator,VkFormat ** formats,uint32_t * format_count)760 vk_image_create_get_format_list_compressed(struct vk_device *device,
761                                            const VkImageCreateInfo *pCreateInfo,
762                                            const VkAllocationCallbacks *pAllocator,
763                                            VkFormat **formats,
764                                            uint32_t *format_count)
765 {
766    if ((pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) == 0) {
767       return vk_image_create_get_format_list_uncompressed(device,
768                                                           pCreateInfo,
769                                                           pAllocator,
770                                                           formats,
771                                                           format_count);
772    }
773 
774    const struct vk_format_class_info *class =
775       vk_format_get_class_info(pCreateInfo->format);
776    const struct vk_format_class_info *uncompr_class = NULL;
777 
778    switch (vk_format_get_blocksizebits(pCreateInfo->format)) {
779    case 64:
780       uncompr_class = vk_format_class_get_info(MESA_VK_FORMAT_CLASS_64_BIT);
781       break;
782    case 128:
783       uncompr_class = vk_format_class_get_info(MESA_VK_FORMAT_CLASS_128_BIT);
784       break;
785    }
786 
787    if (!uncompr_class)
788       return vk_error(device, VK_ERROR_FORMAT_NOT_SUPPORTED);
789 
790    uint32_t fmt_count = class->format_count + uncompr_class->format_count;
791 
792    *formats = vk_alloc2(&device->alloc, pAllocator,
793                         sizeof(VkFormat) * fmt_count,
794                         alignof(VkFormat), VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
795    if (*formats == NULL)
796       return vk_error(device, VK_ERROR_OUT_OF_HOST_MEMORY);
797 
798    memcpy(*formats, class->formats, sizeof(VkFormat) * class->format_count);
799    memcpy(*formats + class->format_count, uncompr_class->formats,
800           sizeof(VkFormat) * uncompr_class->format_count);
801    *format_count = class->format_count + uncompr_class->format_count;
802 
803    return VK_SUCCESS;
804 }
805 
806 /* Get a list of compatible formats when VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT
807  * or VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT is set. This list is
808  * either retrieved from a VkImageFormatListCreateInfo passed to the creation
809  * chain, or forged from the default compatible list specified in the
810  * "formats-compatibility-classes" section of the spec.
811  *
812  * The value returned in *formats must be freed with
813  * vk_free2(&device->alloc, pAllocator), and should not live past the
814  * vkCreateImage() call (allocated in the COMMAND scope).
815  */
816 VkResult
vk_image_create_get_format_list(struct vk_device * device,const VkImageCreateInfo * pCreateInfo,const VkAllocationCallbacks * pAllocator,VkFormat ** formats,uint32_t * format_count)817 vk_image_create_get_format_list(struct vk_device *device,
818                                 const VkImageCreateInfo *pCreateInfo,
819                                 const VkAllocationCallbacks *pAllocator,
820                                 VkFormat **formats,
821                                 uint32_t *format_count)
822 {
823    *formats = NULL;
824    *format_count = 0;
825 
826    if (!(pCreateInfo->flags &
827          (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT |
828           VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT))) {
829       return VK_SUCCESS;
830    }
831 
832    /* "Each depth/stencil format is only compatible with itself." */
833    if (vk_format_is_depth_or_stencil(pCreateInfo->format))
834       return VK_SUCCESS;
835 
836    const VkImageFormatListCreateInfo *format_list = (const VkImageFormatListCreateInfo *)
837       vk_find_struct_const(pCreateInfo->pNext, IMAGE_FORMAT_LIST_CREATE_INFO);
838 
839    if (format_list) {
840       if (!format_list->viewFormatCount)
841          return VK_SUCCESS;
842 
843       *formats = vk_alloc2(&device->alloc, pAllocator,
844                            sizeof(VkFormat) * format_list->viewFormatCount,
845                            alignof(VkFormat), VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
846       if (*formats == NULL)
847          return vk_error(device, VK_ERROR_OUT_OF_HOST_MEMORY);
848 
849       memcpy(*formats, format_list->pViewFormats, sizeof(VkFormat) * format_list->viewFormatCount);
850       *format_count = format_list->viewFormatCount;
851       return VK_SUCCESS;
852    }
853 
854    if (vk_format_is_compressed(pCreateInfo->format))
855       return vk_image_create_get_format_list_compressed(device,
856                                                         pCreateInfo,
857                                                         pAllocator,
858                                                         formats,
859                                                         format_count);
860 
861    return vk_image_create_get_format_list_uncompressed(device,
862                                                        pCreateInfo,
863                                                        pAllocator,
864                                                        formats,
865                                                        format_count);
866 }
867 
868 /* From the Vulkan Specification 1.2.166 - VkAttachmentReference2:
869  *
870  *   "If layout only specifies the layout of the depth aspect of the
871  *    attachment, the layout of the stencil aspect is specified by the
872  *    stencilLayout member of a VkAttachmentReferenceStencilLayout structure
873  *    included in the pNext chain. Otherwise, layout describes the layout for
874  *    all relevant image aspects."
875  */
876 VkImageLayout
vk_att_ref_stencil_layout(const VkAttachmentReference2 * att_ref,const VkAttachmentDescription2 * attachments)877 vk_att_ref_stencil_layout(const VkAttachmentReference2 *att_ref,
878                           const VkAttachmentDescription2 *attachments)
879 {
880    /* From VUID-VkAttachmentReference2-attachment-04755:
881     *  "If attachment is not VK_ATTACHMENT_UNUSED, and the format of the
882     *   referenced attachment is a depth/stencil format which includes both
883     *   depth and stencil aspects [...]
884     */
885    if (att_ref->attachment == VK_ATTACHMENT_UNUSED ||
886        !vk_format_has_stencil(attachments[att_ref->attachment].format))
887       return VK_IMAGE_LAYOUT_UNDEFINED;
888 
889    const VkAttachmentReferenceStencilLayout *stencil_ref =
890       vk_find_struct_const(att_ref->pNext, ATTACHMENT_REFERENCE_STENCIL_LAYOUT);
891 
892    if (stencil_ref)
893       return stencil_ref->stencilLayout;
894 
895    /* From VUID-VkAttachmentReference2-attachment-04755:
896     *  "If attachment is not VK_ATTACHMENT_UNUSED, and the format of the
897     *   referenced attachment is a depth/stencil format which includes both
898     *   depth and stencil aspects, and layout is
899     *   VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or
900     *   VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, the pNext chain must include
901     *   a VkAttachmentReferenceStencilLayout structure."
902     */
903    assert(!vk_image_layout_is_depth_only(att_ref->layout));
904 
905    return att_ref->layout;
906 }
907 
908 /* From the Vulkan Specification 1.2.184:
909  *
910  *   "If the pNext chain includes a VkAttachmentDescriptionStencilLayout
911  *    structure, then the stencilInitialLayout and stencilFinalLayout members
912  *    specify the initial and final layouts of the stencil aspect of a
913  *    depth/stencil format, and initialLayout and finalLayout only apply to the
914  *    depth aspect. For depth-only formats, the
915  *    VkAttachmentDescriptionStencilLayout structure is ignored. For
916  *    stencil-only formats, the initial and final layouts of the stencil aspect
917  *    are taken from the VkAttachmentDescriptionStencilLayout structure if
918  *    present, or initialLayout and finalLayout if not present."
919  *
920  *   "If format is a depth/stencil format, and either initialLayout or
921  *    finalLayout does not specify a layout for the stencil aspect, then the
922  *    application must specify the initial and final layouts of the stencil
923  *    aspect by including a VkAttachmentDescriptionStencilLayout structure in
924  *    the pNext chain."
925  */
926 VkImageLayout
vk_att_desc_stencil_layout(const VkAttachmentDescription2 * att_desc,bool final)927 vk_att_desc_stencil_layout(const VkAttachmentDescription2 *att_desc, bool final)
928 {
929    if (!vk_format_has_stencil(att_desc->format))
930       return VK_IMAGE_LAYOUT_UNDEFINED;
931 
932    const VkAttachmentDescriptionStencilLayout *stencil_desc =
933       vk_find_struct_const(att_desc->pNext, ATTACHMENT_DESCRIPTION_STENCIL_LAYOUT);
934 
935    if (stencil_desc) {
936       return final ?
937          stencil_desc->stencilFinalLayout :
938          stencil_desc->stencilInitialLayout;
939    }
940 
941    const VkImageLayout main_layout =
942       final ? att_desc->finalLayout : att_desc->initialLayout;
943 
944    /* From VUID-VkAttachmentDescription2-format-03302/03303:
945     *  "If format is a depth/stencil format which includes both depth and
946     *   stencil aspects, and initial/finalLayout is
947     *   VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or
948     *   VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, the pNext chain must include
949     *   a VkAttachmentDescriptionStencilLayout structure."
950     */
951    assert(!vk_image_layout_is_depth_only(main_layout));
952 
953    return main_layout;
954 }
955 
956 VkImageUsageFlags
vk_image_layout_to_usage_flags(VkImageLayout layout,VkImageAspectFlagBits aspect)957 vk_image_layout_to_usage_flags(VkImageLayout layout,
958                                VkImageAspectFlagBits aspect)
959 {
960    assert(util_bitcount(aspect) == 1);
961 
962    switch (layout) {
963    case VK_IMAGE_LAYOUT_UNDEFINED:
964    case VK_IMAGE_LAYOUT_PREINITIALIZED:
965       return 0u;
966 
967    case VK_IMAGE_LAYOUT_GENERAL:
968       return ~0u;
969 
970    case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
971       assert(aspect & VK_IMAGE_ASPECT_ANY_COLOR_MASK_MESA);
972       return VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
973 
974    case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
975       assert(aspect & (VK_IMAGE_ASPECT_DEPTH_BIT |
976                        VK_IMAGE_ASPECT_STENCIL_BIT));
977       return VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
978 
979    case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL:
980       assert(aspect & VK_IMAGE_ASPECT_DEPTH_BIT);
981       return vk_image_layout_to_usage_flags(
982          VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, aspect);
983 
984    case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL:
985       assert(aspect & VK_IMAGE_ASPECT_STENCIL_BIT);
986       return vk_image_layout_to_usage_flags(
987          VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, aspect);
988 
989    case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
990       assert(aspect & (VK_IMAGE_ASPECT_DEPTH_BIT |
991                        VK_IMAGE_ASPECT_STENCIL_BIT));
992       return VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
993              VK_IMAGE_USAGE_SAMPLED_BIT |
994              VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
995 
996    case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL:
997       assert(aspect & VK_IMAGE_ASPECT_DEPTH_BIT);
998       return vk_image_layout_to_usage_flags(
999          VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, aspect);
1000 
1001    case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL:
1002       assert(aspect & VK_IMAGE_ASPECT_STENCIL_BIT);
1003       return vk_image_layout_to_usage_flags(
1004          VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, aspect);
1005 
1006    case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
1007       return VK_IMAGE_USAGE_SAMPLED_BIT |
1008              VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1009 
1010    case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
1011       return VK_IMAGE_USAGE_TRANSFER_SRC_BIT;
1012 
1013    case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
1014       return VK_IMAGE_USAGE_TRANSFER_DST_BIT;
1015 
1016    case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
1017       if (aspect == VK_IMAGE_ASPECT_DEPTH_BIT) {
1018          return vk_image_layout_to_usage_flags(
1019             VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, aspect);
1020       } else if (aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
1021          return vk_image_layout_to_usage_flags(
1022             VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, aspect);
1023       } else {
1024          assert(!"Must be a depth/stencil aspect");
1025          return 0;
1026       }
1027 
1028    case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
1029       if (aspect == VK_IMAGE_ASPECT_DEPTH_BIT) {
1030          return vk_image_layout_to_usage_flags(
1031             VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, aspect);
1032       } else if (aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
1033          return vk_image_layout_to_usage_flags(
1034             VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, aspect);
1035       } else {
1036          assert(!"Must be a depth/stencil aspect");
1037          return 0;
1038       }
1039 
1040    case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR:
1041       assert(aspect == VK_IMAGE_ASPECT_COLOR_BIT);
1042       /* This needs to be handled specially by the caller */
1043       return 0;
1044 
1045    case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
1046       assert(aspect == VK_IMAGE_ASPECT_COLOR_BIT);
1047       return vk_image_layout_to_usage_flags(VK_IMAGE_LAYOUT_GENERAL, aspect);
1048 
1049    case VK_IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR:
1050       assert(aspect == VK_IMAGE_ASPECT_COLOR_BIT);
1051       return VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR;
1052 
1053    case VK_IMAGE_LAYOUT_FRAGMENT_DENSITY_MAP_OPTIMAL_EXT:
1054       assert(aspect == VK_IMAGE_ASPECT_COLOR_BIT);
1055       return VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT;
1056 
1057    case VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL:
1058       if (aspect == VK_IMAGE_ASPECT_DEPTH_BIT ||
1059           aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
1060          return VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
1061       } else {
1062          assert(aspect == VK_IMAGE_ASPECT_COLOR_BIT);
1063          return VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
1064       }
1065 
1066    case VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL:
1067       return VK_IMAGE_USAGE_SAMPLED_BIT |
1068              VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1069 
1070    case VK_IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT:
1071    case VK_IMAGE_LAYOUT_RENDERING_LOCAL_READ_KHR:
1072       if (aspect == VK_IMAGE_ASPECT_DEPTH_BIT ||
1073           aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
1074          return VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1075                 VK_IMAGE_USAGE_SAMPLED_BIT |
1076                 VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
1077                 VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT;
1078       } else {
1079          assert(aspect == VK_IMAGE_ASPECT_COLOR_BIT);
1080          return VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
1081                 VK_IMAGE_USAGE_SAMPLED_BIT |
1082                 VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
1083                 VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT;
1084       }
1085 
1086    case VK_IMAGE_LAYOUT_VIDEO_DECODE_DST_KHR:
1087       return VK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR;
1088    case VK_IMAGE_LAYOUT_VIDEO_DECODE_SRC_KHR:
1089       return VK_IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR;
1090    case VK_IMAGE_LAYOUT_VIDEO_DECODE_DPB_KHR:
1091       return VK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR;
1092    case VK_IMAGE_LAYOUT_VIDEO_ENCODE_DST_KHR:
1093       return VK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR;
1094    case VK_IMAGE_LAYOUT_VIDEO_ENCODE_SRC_KHR:
1095       return VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR;
1096    case VK_IMAGE_LAYOUT_VIDEO_ENCODE_DPB_KHR:
1097       return VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR;
1098    case VK_IMAGE_LAYOUT_VIDEO_ENCODE_QUANTIZATION_MAP_KHR:
1099       return VK_IMAGE_USAGE_VIDEO_ENCODE_QUANTIZATION_DELTA_MAP_BIT_KHR;
1100    case VK_IMAGE_LAYOUT_MAX_ENUM:
1101       unreachable("Invalid image layout.");
1102    }
1103 
1104    unreachable("Invalid image layout.");
1105 }
1106