blob: d424770608faea5646d9436ce2ed49e71e146a9c [file] [log] [blame]
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001/* Copyright (c) 2015-2021 The Khronos Group Inc.
2 * Copyright (c) 2015-2021 Valve Corporation
3 * Copyright (c) 2015-2021 LunarG, Inc.
4 * Copyright (C) 2015-2021 Google Inc.
Tony-LunarG5a066372021-01-21 10:31:34 -07005 * Modifications Copyright (C) 2020-2021 Advanced Micro Devices, Inc. All rights reserved.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07006 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060020 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070021 * Shannon McPherson <shannon@lunarg.com>
Tobias Hector6663c9b2020-11-05 10:18:02 +000022 * Author: Tobias Hector <tobias.hector@amd.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070023 */
24
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060025#include <cmath>
26#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020028#include <string>
Jeremy Gebben579aaca2021-02-15 13:36:18 -070029#include <iostream>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070040#include "core_error_location.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070041#include "shader_validation.h"
42#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070043#include "buffer_validation.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070044#include "sync_vuid_maps.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070045
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070046// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070047static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070048 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070049 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
50 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070051 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
52 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
53 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00193", // copy2 & !image_to_buffer
54 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00193", // copy2 & image_to_buffer
55 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070056 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070057 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
58 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
59 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01558",
60 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01558",
61 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070062 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070063 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
64 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
65 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01559",
66 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01559",
67 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070068 {"00197", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070069 "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
70 "VUID-vkCmdCopyImageToBuffer-imageOffset-00197",
71 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00197",
72 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
73 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070074 {"00198", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070075 "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
76 "VUID-vkCmdCopyImageToBuffer-imageOffset-00198",
77 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00198",
78 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00198",
79 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070080 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070081 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
82 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
83 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00199",
84 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00199",
85 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070086 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070087 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
88 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
89 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00200",
90 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00200",
91 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070092 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070093 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
94 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
95 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00201",
96 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00201",
97 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070098 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070099 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
100 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
101 "VUID-VkCopyBufferToImageInfo2KHR-bufferRowLength-00203",
102 "VUID-VkCopyImageToBufferInfo2KHR-bufferRowLength-00203",
103 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700104 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700105 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
106 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
107 "VUID-VkCopyBufferToImageInfo2KHR-bufferImageHeight-00204",
108 "VUID-VkCopyImageToBufferInfo2KHR-bufferImageHeight-00204",
109 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700110 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700111 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
112 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
113 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00205",
114 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00205",
115 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700116 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700117 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
118 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
119 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00206",
120 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00206",
121 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700122 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700123 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
124 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
125 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00207",
126 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00207",
127 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700128 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700129 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
130 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
131 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00208",
132 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00208",
133 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700134 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700135 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
136 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
137 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00209",
138 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00209",
139 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700140 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700141 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
142 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
143 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-00211",
144 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-00211",
145 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700146 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700147 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
148 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
149 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-01560",
150 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-01560",
151 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700152 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700153 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
154 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
155 "VUID-VkCopyBufferToImageInfo2KHR-baseArrayLayer-00213",
156 "VUID-VkCopyImageToBufferInfo2KHR-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800157 }},
158 {"04052", {
159 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
160 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
161 "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04052",
162 "VUID-VkCopyImageToBufferInfo2KHR-commandBuffer-04052",
163 }},
164 {"04053", {
165 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
166 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
167 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-04053",
168 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700169 }}
170 };
171 // clang-format on
172
173 uint8_t index = 0;
174 index |= (image_to_buffer) ? 0x1 : 0;
175 index |= (copy2) ? 0x2 : 0;
176 return copy_imagebuffer_vuid.at(id).at(index);
177}
178
David McFarland2853f2f2020-11-30 15:50:39 -0400179// Transfer VkImageSubresourceRange into VkImageSubresourceLayers struct
180static VkImageSubresourceLayers LayersFromRange(const VkImageSubresourceRange &subresource_range) {
181 VkImageSubresourceLayers subresource_layers;
182 subresource_layers.aspectMask = subresource_range.aspectMask;
183 subresource_layers.baseArrayLayer = subresource_range.baseArrayLayer;
184 subresource_layers.layerCount = subresource_range.layerCount;
185 subresource_layers.mipLevel = subresource_range.baseMipLevel;
186 return subresource_layers;
187}
188
John Zulauff660ad62019-03-23 07:16:05 -0600189// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
190static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
191 VkImageSubresourceRange subresource_range;
192 subresource_range.aspectMask = subresource_layers.aspectMask;
193 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
194 subresource_range.layerCount = subresource_layers.layerCount;
195 subresource_range.baseMipLevel = subresource_layers.mipLevel;
196 subresource_range.levelCount = 1;
197 return subresource_range;
198}
199
John Zulaufb58415b2019-12-09 15:02:32 -0700200static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
201 const auto format = create_info.format;
202 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200203
204#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700205 const VkExternalFormatANDROID *external_format_android = LvlFindInChain<VkExternalFormatANDROID>(&create_info);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700206 bool is_external_format_conversion = (external_format_android != nullptr && external_format_android->externalFormat != 0);
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200207#else
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700208 bool is_external_format_conversion = false;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200209#endif
210
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700211 if (FormatIsColor(format) || FormatIsMultiplane(format) || is_external_format_conversion) {
John Zulaufb58415b2019-12-09 15:02:32 -0700212 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
213 } else {
214 init_range.aspectMask =
215 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
216 }
217 return NormalizeSubresourceRange(create_info, init_range);
218}
219
locke-lunarg296a3c92020-03-25 01:04:29 -0600220IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -0600221 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -0700222 safe_create_info(pCreateInfo),
223 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -0600224 valid(false),
225 acquired(false),
226 shared_presentable(false),
227 layout_locked(false),
228 get_sparse_reqs_called(false),
229 sparse_metadata_required(false),
230 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -0600231 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700232 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -0600233 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700234 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -0600235 create_from_swapchain(VK_NULL_HANDLE),
236 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -0600237 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700238 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -0700239 disjoint(false),
240 plane0_memory_requirements_checked(false),
241 plane1_memory_requirements_checked(false),
242 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -0600243 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -0600244 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -0600245 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
John Zulauf29d00532021-03-04 13:28:54 -0700246 swapchain_fake_address(0U),
unknown08c57af2019-06-21 16:33:35 -0600247 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600248 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700249 uint32_t *queue_family_indices = new uint32_t[createInfo.queueFamilyIndexCount];
John Zulauff660ad62019-03-23 07:16:05 -0600250 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700251 queue_family_indices[i] = pCreateInfo->pQueueFamilyIndices[i];
John Zulauff660ad62019-03-23 07:16:05 -0600252 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700253 createInfo.pQueueFamilyIndices = queue_family_indices;
John Zulauff660ad62019-03-23 07:16:05 -0600254 }
255
256 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
257 sparse = true;
258 }
Locked8af3732019-05-10 09:47:56 -0600259
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700260 auto *external_memory_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700261 if (external_memory_info) {
262 external_memory_handle = external_memory_info->handleTypes;
sfricke-samsunge2441192019-11-06 14:07:57 -0800263 }
John Zulauff660ad62019-03-23 07:16:05 -0600264}
265
unknown2c877272019-07-11 12:56:50 -0600266bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
267 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
268 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
269 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
270 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
271 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
272 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600273 return is_equal &&
274 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600275}
276
Jeff Bolz82f854d2019-09-17 14:56:47 -0500277// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
278bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
279 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
280 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
281 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
282 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
283 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600284 is_compatible = is_compatible &&
285 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
286 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500287
288 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
289 createInfo.extent.height <= other_createInfo.extent.height &&
290 createInfo.extent.depth <= other_createInfo.extent.depth &&
291 createInfo.arrayLayers <= other_createInfo.arrayLayers;
292 return is_compatible;
293}
294
John Zulaufd13b38e2021-03-05 08:17:38 -0700295bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) const {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700296 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700297 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700298 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700299 }
locke-lunarg5f59e782019-12-19 10:32:23 -0700300 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
301 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600302 IsCreateInfoEqual(other_image_state->createInfo)) {
303 return true;
304 }
unknowne1661522019-07-11 13:04:18 -0600305 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
306 return true;
307 }
unknown2c877272019-07-11 12:56:50 -0600308 return false;
309}
310
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500311IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
312 : image_view(iv),
313 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700314 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600315 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500316 samplerConversion(VK_NULL_HANDLE),
317 image_state(im) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700318 auto *conversion_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700319 if (conversion_info) samplerConversion = conversion_info->conversion;
John Zulauff660ad62019-03-23 07:16:05 -0600320 if (image_state) {
321 // A light normalization of the createInfo range
322 auto &sub_res_range = create_info.subresourceRange;
323 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
324 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
325
326 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700327 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500328 samples = image_state->createInfo.samples;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200329
330 if (image_state->has_ahb_format) {
331 // When the image has a external format the views format must be VK_FORMAT_UNDEFINED and it is required to use a sampler
332 // Ycbcr conversion. Thus we can't extract any meaningful information from the format parameter. As a Sampler Ycbcr
333 // conversion must be used the shader type is always float.
334 descriptor_format_bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
335 } else {
336 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
337 }
John Zulauff660ad62019-03-23 07:16:05 -0600338 }
339}
340
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700341static VkImageLayout NormalizeImageLayout(VkImageLayout layout, VkImageLayout non_normal, VkImageLayout normal) {
342 return (layout == non_normal) ? normal : layout;
343}
344
345static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
346 return NormalizeImageLayout(layout, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
347 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL);
348}
349
350static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
351 return NormalizeImageLayout(layout, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
352 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL);
353}
354
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700355static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
356 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
357 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
358 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
359 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
360 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
361 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
362 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
363 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
364 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
365 }
366 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
367 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
368 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
369 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
370 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
371 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
372 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
373 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
374 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
375 }
376 }
377 return layout;
378}
379
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700380static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
381 bool matches = (a == b);
382 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700383 a = NormalizeSynchronization2Layout(aspect_mask, a);
384 b = NormalizeSynchronization2Layout(aspect_mask, b);
385 matches = (a == b);
386 if (!matches) {
387 // Relaxed rules when referencing *only* the depth or stencil aspects
388 if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
389 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
390 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
391 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
392 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700393 }
394 }
395 return matches;
396}
397
398// Utility type for ForRange callbacks
399struct LayoutUseCheckAndMessage {
400 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
401 const ImageSubresourceLayoutMap *layout_map;
402 const VkImageAspectFlags aspect_mask;
403 const char *message;
404 VkImageLayout layout;
405
406 LayoutUseCheckAndMessage() = delete;
407 LayoutUseCheckAndMessage(const ImageSubresourceLayoutMap *layout_map_, const VkImageAspectFlags aspect_mask_ = 0)
408 : layout_map(layout_map_), aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
409 bool Check(const VkImageSubresource &subres, VkImageLayout check, VkImageLayout current_layout, VkImageLayout initial_layout) {
410 message = nullptr;
411 layout = kInvalidLayout; // Success status
412 if (current_layout != kInvalidLayout && !ImageLayoutMatches(aspect_mask, check, current_layout)) {
413 message = "previous known";
414 layout = current_layout;
415 } else if ((initial_layout != kInvalidLayout) && !ImageLayoutMatches(aspect_mask, check, initial_layout)) {
416 // To check the relaxed rule matching we need to see how the initial use was used
417 const auto initial_layout_state = layout_map->GetSubresourceInitialLayoutState(subres);
418 assert(initial_layout_state); // If we have an initial layout, we better have a state for it
419 if (!((initial_layout_state->aspect_mask & kDepthOrStencil) &&
420 ImageLayoutMatches(initial_layout_state->aspect_mask, check, initial_layout))) {
421 message = "previously used";
422 layout = initial_layout;
423 }
424 }
425 return layout == kInvalidLayout;
426 }
427};
428
locke-lunarg540b2252020-08-03 13:23:36 -0600429bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600430 if (image_view == compare_view.image_view) {
431 return true;
432 }
locke-lunargdc287022020-08-21 12:03:57 -0600433 if (image_state->image != compare_view.image_state->image) {
434 return false;
435 }
locke-lunarg540b2252020-08-03 13:23:36 -0600436 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
437 return false;
438 }
439
440 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600441 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600442 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600443 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600444 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600445 }
446
447 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600448 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600449 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600450 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600451 }
452
453 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600454 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600455 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600456 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600457 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600458 }
459
460 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600461 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600462 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600463 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600464 }
locke-lunargdc287022020-08-21 12:03:57 -0600465 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600466}
467
Dave Houltond9611312018-11-19 17:03:36 -0700468uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
469 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700470 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700471}
472
473uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
474
475uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
476
John Zulauf2d60a452021-03-04 15:12:03 -0700477bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
478 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image_state.image);
John Zulauf2076e812020-01-08 14:55:54 -0700479 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700480 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
481 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
482
John Zulauf2076e812020-01-08 14:55:54 -0700483 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
484
485 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
John Zulauf2d60a452021-03-04 15:12:03 -0700486 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700487 return false;
488 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700489
John Zulauf79f06582021-02-27 18:38:39 -0700490 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700491 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700492 }
493 return true;
494}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700495
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600496// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600497void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600498 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
499 VkImageLayout expected_layout) {
500 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
501 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600502 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600503 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700504 }
John Zulaufd13b38e2021-03-05 08:17:38 -0700505 for (const auto *alias_state : image_state.aliasing_images) {
506 assert(alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700507 // The map state of the aliases should all be in sync, so no need to check the return value
508 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
509 assert(subresource_map);
510 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
511 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700512}
John Zulauff660ad62019-03-23 07:16:05 -0600513
514// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600515void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600516 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500517 return;
518 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500519 IMAGE_STATE *image_state = view_state.image_state.get();
520 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700521 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulaufd13b38e2021-03-05 08:17:38 -0700522 for (const auto *alias_state : image_state->aliasing_images) {
523 assert(alias_state);
524 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700525 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
526 }
John Zulauff660ad62019-03-23 07:16:05 -0600527}
528
529// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600530void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600531 const VkImageSubresourceRange &range, VkImageLayout layout) {
532 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
533 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600534 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulaufd13b38e2021-03-05 08:17:38 -0700535 for (const auto *alias_state : image_state.aliasing_images) {
536 assert(alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700537 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
538 assert(subresource_map);
539 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
540 }
John Zulauff660ad62019-03-23 07:16:05 -0600541}
542
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600543void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600544 VkImageLayout layout) {
545 const IMAGE_STATE *image_state = GetImageState(image);
546 if (!image_state) return;
547 SetImageInitialLayout(cb_node, *image_state, range, layout);
548};
549
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600550void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600551 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
552 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600553}
Dave Houltonddd65c52018-05-08 14:58:01 -0600554
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600555// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700556void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
557 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500558 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600559
John Zulauff660ad62019-03-23 07:16:05 -0600560 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600561 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
562 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600563 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state.create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
Dave Houltonddd65c52018-05-08 14:58:01 -0600564 sub_range.baseArrayLayer = 0;
565 sub_range.layerCount = image_state->createInfo.extent.depth;
566 }
567
Piers Daniell4fde9b72019-11-27 16:19:46 -0700568 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
569 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
570 SetImageLayout(cb_node, *image_state, sub_range, layout);
571 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
572 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
573 } else {
574 SetImageLayout(cb_node, *image_state, sub_range, layout);
575 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600576}
577
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700578bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
579 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700580 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600581 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100582 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700583 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100584 const char *vuid;
585 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700586 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100587
588 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600589 LogObjectList objlist(image);
590 objlist.add(renderpass);
591 objlist.add(framebuffer);
592 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700593 skip |=
594 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
595 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
596 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
597 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100598 return skip;
599 }
600
601 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700602 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200603 if (stencil_usage_info) {
604 image_usage |= stencil_usage_info->stencilUsage;
605 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100606
607 // Check for layouts that mismatch image usages in the framebuffer
608 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800609 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600610 LogObjectList objlist(image);
611 objlist.add(renderpass);
612 objlist.add(framebuffer);
613 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700614 skip |= LogError(objlist, vuid,
615 "%s: Layout/usage mismatch for attachment %u in %s"
616 " - the %s is %s but the image attached to %s via %s"
617 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
618 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
619 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
620 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100621 }
622
623 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
624 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800625 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600626 LogObjectList objlist(image);
627 objlist.add(renderpass);
628 objlist.add(framebuffer);
629 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700630 skip |= LogError(objlist, vuid,
631 "%s: Layout/usage mismatch for attachment %u in %s"
632 " - the %s is %s but the image attached to %s via %s"
633 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
634 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
635 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
636 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100637 }
638
639 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800640 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600641 LogObjectList objlist(image);
642 objlist.add(renderpass);
643 objlist.add(framebuffer);
644 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700645 skip |= LogError(objlist, vuid,
646 "%s: Layout/usage mismatch for attachment %u in %s"
647 " - the %s is %s but the image attached to %s via %s"
648 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
649 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
650 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
651 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100652 }
653
654 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800655 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600656 LogObjectList objlist(image);
657 objlist.add(renderpass);
658 objlist.add(framebuffer);
659 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700660 skip |= LogError(objlist, vuid,
661 "%s: Layout/usage mismatch for attachment %u in %s"
662 " - the %s is %s but the image attached to %s via %s"
663 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
664 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
665 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
666 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100667 }
668
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600669 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100670 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
671 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
672 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
673 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
674 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800675 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600676 LogObjectList objlist(image);
677 objlist.add(renderpass);
678 objlist.add(framebuffer);
679 objlist.add(image_view);
680 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700681 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700682 " - the %s is %s but the image attached to %s via %s"
683 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700684 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700685 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
686 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100687 }
688 } else {
689 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
690 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
691 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
692 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600693 LogObjectList objlist(image);
694 objlist.add(renderpass);
695 objlist.add(framebuffer);
696 objlist.add(image_view);
697 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700698 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700699 " - the %s is %s but the image attached to %s via %s"
700 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700701 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700702 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
703 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100704 }
705 }
706 return skip;
707}
708
John Zulauf17a01bb2019-08-09 16:41:19 -0600709bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700710 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600711 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600712 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700713 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
714 auto const &framebuffer_info = framebuffer_state->createInfo;
715 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100716
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700717 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100718 auto framebuffer = framebuffer_state->framebuffer;
719
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700720 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700721 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
722 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700723 }
John Zulauf8e308292018-09-21 11:34:37 -0600724
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700725 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800726 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700727 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100728 }
729
Tobias Hectorc9057422019-07-23 12:15:52 +0100730 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700731 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
732 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100733 auto image_view = attachments[i];
734 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100735
Tobias Hectorc9057422019-07-23 12:15:52 +0100736 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600737 LogObjectList objlist(pRenderPassBegin->renderPass);
738 objlist.add(framebuffer_state->framebuffer);
739 objlist.add(image_view);
740 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700741 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
742 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
743 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100744 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100745 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100746
747 const VkImage image = view_state->create_info.image;
748 const IMAGE_STATE *image_state = GetImageState(image);
749
750 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600751 LogObjectList objlist(pRenderPassBegin->renderPass);
752 objlist.add(framebuffer_state->framebuffer);
753 objlist.add(image_view);
754 objlist.add(image);
755 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700756 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
757 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
758 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100759 continue;
760 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700761 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
762 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100763
Piers Daniell7f894f62020-01-09 16:33:48 -0700764 // Default to expecting stencil in the same layout.
765 auto attachment_stencil_initial_layout = attachment_initial_layout;
766
767 // If a separate layout is specified, look for that.
768 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700769 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700770 if (attachment_description_stencil_layout) {
771 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
772 }
773
Tobias Hectorc9057422019-07-23 12:15:52 +0100774 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
775 // in common with the non-const version.)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700776 const ImageSubresourceLayoutMap *subresource_map = (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED)
777 ? GetImageSubresourceLayoutMap(const_p_cb, image)
778 : nullptr;
Tobias Hectorc9057422019-07-23 12:15:52 +0100779
780 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
781 LayoutUseCheckAndMessage layout_check(subresource_map);
782 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700783 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700784 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
785 // the next "constant value" range
786 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700787 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700788
John Zulauf5e617452019-11-19 14:44:16 -0700789 // Allow for differing depth and stencil layouts
790 VkImageLayout check_layout = attachment_initial_layout;
791 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
792
793 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700794 subres_skip |= LogError(
795 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700796 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
797 "and the %s layout of the attachment is %s. The layouts must match, or the render "
798 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700799 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100800 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700801 }
John Zulauf5e617452019-11-19 14:44:16 -0700802
Tobias Hectorc9057422019-07-23 12:15:52 +0100803 skip |= subres_skip;
804 }
805
806 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
807 framebuffer, render_pass, i, "initial layout");
808
809 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
810 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100811 }
812
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700813 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
814 auto &subpass = render_pass_info->pSubpasses[j];
815 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100816 auto &attachment_ref = subpass.pInputAttachments[k];
817 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
818 auto image_view = attachments[attachment_ref.attachment];
819 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100820
Tobias Hectorc9057422019-07-23 12:15:52 +0100821 if (view_state) {
822 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700823 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
824 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100825 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100826 }
827 }
828 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100829
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700830 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100831 auto &attachment_ref = subpass.pColorAttachments[k];
832 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
833 auto image_view = attachments[attachment_ref.attachment];
834 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100835
Tobias Hectorc9057422019-07-23 12:15:52 +0100836 if (view_state) {
837 auto image = view_state->create_info.image;
838 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
839 framebuffer, render_pass, attachment_ref.attachment,
840 "color attachment layout");
841 if (subpass.pResolveAttachments) {
842 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
843 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
844 attachment_ref.attachment, "resolve attachment layout");
845 }
846 }
847 }
848 }
849
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700850 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100851 auto &attachment_ref = *subpass.pDepthStencilAttachment;
852 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
853 auto image_view = attachments[attachment_ref.attachment];
854 auto view_state = GetImageViewState(image_view);
855
856 if (view_state) {
857 auto image = view_state->create_info.image;
858 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
859 framebuffer, render_pass, attachment_ref.attachment,
860 "input attachment layout");
861 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100862 }
863 }
864 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700865 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600866 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700867}
868
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600869void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700870 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700871 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinski8d46f802020-12-07 16:33:54 -0700872 IMAGE_VIEW_STATE *image_view = GetActiveAttachmentImageViewState(pCB, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600873 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700874 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700875 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700876 if (attachment_reference_stencil_layout) {
877 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
878 }
879
880 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600881 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700882 }
883}
884
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600885void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
886 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700887 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700888
889 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700890 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700891 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700892 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700893 }
894 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700895 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700896 }
897 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700898 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700899 }
900 }
901}
902
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700903// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
904// 1. Transition into initialLayout state
905// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600906void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700907 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700908 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700909 auto const rpci = render_pass_state->createInfo.ptr();
910 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -0700911 auto *view_state = GetActiveAttachmentImageViewState(cb_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600912 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700913 IMAGE_STATE *image_state = view_state->image_state.get();
914 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700915 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700916 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700917 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700918 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
919 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
920 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
921 SetImageInitialLayout(cb_state, *image_state, sub_range, initial_layout);
922 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
923 SetImageInitialLayout(cb_state, *image_state, sub_range, stencil_initial_layout);
924 } else {
925 SetImageInitialLayout(cb_state, *image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700926 }
John Zulauf8e308292018-09-21 11:34:37 -0600927 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700928 }
929 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700930 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700931}
932
Dave Houlton10b39482017-03-16 13:18:15 -0600933bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600934 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600935 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600936 }
937 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600938 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600939 }
940 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600941 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600942 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800943 if (0 != (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700944 if (FormatPlaneCount(format) == 1) return false;
945 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600946 return true;
947}
948
Mike Weiblen62d08a32017-03-07 22:18:27 -0700949// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700950bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700951 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700952 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700953 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700954 switch (layout) {
955 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700956 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700957 break;
958 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700959 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700960 break;
961 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700962 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700963 break;
964 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700965 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700966 break;
967 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700968 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700969 break;
970 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700971 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700972 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600973 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700974 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500975 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700976 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700977 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700978 break;
979 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700980 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700981 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700982 default:
983 // Other VkImageLayout values do not have VUs defined in this context.
984 break;
985 }
986
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700987 if (is_error) {
988 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
989
990 skip |=
991 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
992 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700993 }
994 return skip;
995}
996
997// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700998template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700999bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001000 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001001 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001002 using sync_vuid_maps::GetImageBarrierVUID;
1003 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +02001004 // Scoreboard for checking for duplicate and inconsistent barriers to images
1005 struct ImageBarrierScoreboardEntry {
1006 uint32_t index;
1007 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
1008 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001009 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +02001010 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001011 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
1012 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
1013 // when creating maps full of maps.
1014 struct ImageBarrierScoreboardSubresMap {
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001015 layer_data::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001016 };
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001017 using ImageBarrierScoreboardImageMap = layer_data::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
Petr Krausad0096a2019-08-09 18:35:04 +02001018
John Zulauf463c51e2018-05-31 13:29:20 -06001019 // Scoreboard for duplicate layout transition barriers within the list
1020 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
1021 ImageBarrierScoreboardImageMap layout_transitions;
1022
Mike Weiblen62d08a32017-03-07 22:18:27 -07001023 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001024 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +02001025 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -07001026
John Zulauf463c51e2018-05-31 13:29:20 -06001027 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
1028 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
1029 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +02001030 if (img_barrier.oldLayout != img_barrier.newLayout) {
1031 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
1032 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -06001033 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001034 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +02001035 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -06001036 if (subres_it != subres_map.end()) {
1037 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001038 auto entry_layout =
1039 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
1040 auto old_layout =
1041 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
1042 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +02001043 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001044 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001045 skip = LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001046 cb_state->commandBuffer, vuid,
1047 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -06001048 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
1049 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001050 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +02001051 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
1052 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -06001053 }
1054 entry = new_entry;
1055 } else {
Petr Krausad0096a2019-08-09 18:35:04 +02001056 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001057 }
1058 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001059 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001060 }
1061 }
1062
Petr Krausad0096a2019-08-09 18:35:04 +02001063 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001064 if (image_state) {
1065 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001066 skip |=
1067 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
1068 skip |=
1069 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001070
1071 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
1072 if (image_state->layout_locked) {
1073 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001074 skip |= LogError(
1075 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001076 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001077 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001078 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1079 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001080 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001081
John Zulaufa4472282019-08-22 14:44:34 -06001082 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -07001083 const VkFormat image_format = image_create_info.format;
1084 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -06001085 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001086 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -07001087 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001088 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06001089 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001090 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
1091 skip |= LogError(img_barrier.image, vuid,
1092 "%s references %s of format %s that must have either the depth or stencil "
1093 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1094 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1095 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001096 }
1097 } else {
1098 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1099 if ((aspect_mask & ds_mask) != (ds_mask)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001100 auto error = device_extensions.vk_khr_separate_depth_stencil_layouts
1101 ? ImageError::kNotSeparateDepthAndStencilAspect
1102 : ImageError::kNotDepthAndStencilAspect;
1103 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -07001104 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001105 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001106 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001107 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001108 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001109 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001110 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001111 }
John Zulauff660ad62019-03-23 07:16:05 -06001112
Petr Krausad0096a2019-08-09 18:35:04 +02001113 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1114 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001115 // TODO: Set memory invalid which is in mem_tracker currently
1116 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1117 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001118 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001119 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001120 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001121 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001122 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1123 // the next "constant value" range
1124 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001125 const auto &value = *pos;
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001126 auto old_layout =
1127 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
1128 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001129 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
1130 subres_skip = LogError(cb_state->commandBuffer, vuid,
1131 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
1132 "%s layout is %s.",
1133 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1134 value.subresource.aspectMask, value.subresource.mipLevel,
1135 value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1136 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001137 }
John Zulauf5e617452019-11-19 14:44:16 -07001138 }
John Zulauff660ad62019-03-23 07:16:05 -06001139 skip |= subres_skip;
1140 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001141
1142 // checks color format and (single-plane or non-disjoint)
1143 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1144 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001145 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001146 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001147 auto error = device_extensions.vk_khr_sampler_ycbcr_conversion ? ImageError::kNotColorAspect
1148 : ImageError::kNotColorAspectYcbcr;
1149 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -07001150 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001151 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -07001152 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001153 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001154 string_VkFormat(image_format), aspect_mask);
1155 }
1156 }
1157
1158 VkImageAspectFlags valid_disjoint_mask =
1159 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
sfricke-samsung71bc6572020-04-29 15:49:43 -07001160 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001161 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001162 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
1163 skip |= LogError(img_barrier.image, vuid,
1164 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -07001165 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001166 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001167 string_VkFormat(image_format), aspect_mask);
1168 }
1169
1170 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001171 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1172 skip |= LogError(img_barrier.image, vuid,
1173 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -07001174 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001175 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001176 string_VkFormat(image_format), aspect_mask);
1177 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001178 }
1179 }
1180 return skip;
1181}
1182
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001183template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001184bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001185 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001186 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001187 auto pool = cb_state->command_pool.get();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001188 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001189 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001190 if (!IsTransferOp(barrier)) {
1191 return skip;
1192 }
1193 const TransferBarrier *barrier_record = nullptr;
1194 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, barrier) &&
1195 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1196 const auto found = barrier_sets.release.find(barrier);
1197 if (found != barrier_sets.release.cend()) {
1198 barrier_record = &(*found);
1199 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001200 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001201 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, barrier) &&
1202 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1203 const auto found = barrier_sets.acquire.find(barrier);
1204 if (found != barrier_sets.acquire.cend()) {
1205 barrier_record = &(*found);
1206 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001207 }
1208 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001209 if (barrier_record != nullptr) {
1210 skip |=
1211 LogWarning(cb_state->commandBuffer, TransferBarrier::ErrMsgDuplicateQFOInCB(),
1212 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1213 " duplicates existing barrier recorded in this command buffer.",
1214 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1215 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1216 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001217 return skip;
1218}
1219
John Zulaufa4472282019-08-22 14:44:34 -06001220VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1221 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1222}
1223
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001224VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1225 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1226}
1227
John Zulaufa4472282019-08-22 14:44:34 -06001228const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1229 return device_state.GetImageState(barrier.image);
1230}
1231
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001232const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1233 return device_state.GetImageState(barrier.image);
1234}
1235
John Zulaufa4472282019-08-22 14:44:34 -06001236VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1237 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1238}
1239
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001240VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1241 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1242}
1243
John Zulaufa4472282019-08-22 14:44:34 -06001244const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1245 return device_state.GetBufferState(barrier.buffer);
1246}
1247
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001248const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1249 return device_state.GetBufferState(barrier.buffer);
1250}
John Zulaufa4472282019-08-22 14:44:34 -06001251
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001252template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001253void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001254 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001255 auto pool = cb_state->command_pool.get();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001256 if (IsTransferOp(barrier)) {
1257 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, barrier) &&
1258 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1259 barrier_sets.release.emplace(barrier);
1260 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, barrier) &&
1261 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1262 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001263 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001264 }
John Zulaufa4472282019-08-22 14:44:34 -06001265
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001266 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1267 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001268 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1269 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001270 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1271
1272 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001273 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1274 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1275 auto handle_state = BarrierHandleState(*this, barrier);
1276 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1277 if (!mode_concurrent) {
1278 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001279 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001280 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001281 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1282 const QUEUE_STATE *queue_state) {
1283 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001284 src_queue_family, dst_queue_family);
1285 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001286 }
1287 }
1288}
1289
Jeremy Gebbeneb791f32021-04-07 11:52:59 -06001290// Check if all barriers are of a given operation type.
1291template <typename Barrier, typename OpCheck>
1292bool AllTransferOp(const COMMAND_POOL_STATE *pool, OpCheck &op_check, uint32_t count, const Barrier *barriers) {
1293 if (!pool) return false;
1294
1295 for (uint32_t b = 0; b < count; b++) {
1296 if (!op_check(pool, barriers[b])) return false;
1297 }
1298 return true;
1299}
1300
1301// Look at the barriers to see if we they are all release or all acquire, the result impacts queue properties validation
1302template <typename BufBarrier, typename ImgBarrier>
1303BarrierOperationsType CoreChecks::ComputeBarrierOperationsType(const CMD_BUFFER_STATE *cb_state, uint32_t buffer_barrier_count,
1304 const BufBarrier *buffer_barriers, uint32_t image_barrier_count,
1305 const ImgBarrier *image_barriers) const {
1306 auto pool = cb_state->command_pool.get();
1307 BarrierOperationsType op_type = kGeneral;
1308
1309 // Look at the barrier details only if they exist
1310 // Note: AllTransferOp returns true for count == 0
1311 if ((buffer_barrier_count + image_barrier_count) != 0) {
1312 if (AllTransferOp(pool, TempIsReleaseOp<BufBarrier>, buffer_barrier_count, buffer_barriers) &&
1313 AllTransferOp(pool, TempIsReleaseOp<ImgBarrier>, image_barrier_count, image_barriers)) {
1314 op_type = kAllRelease;
1315 } else if (AllTransferOp(pool, IsAcquireOp<BufBarrier>, buffer_barrier_count, buffer_barriers) &&
1316 AllTransferOp(pool, IsAcquireOp<ImgBarrier>, image_barrier_count, image_barriers)) {
1317 op_type = kAllAcquire;
1318 }
1319 }
1320
1321 return op_type;
1322}
1323// explictly instantiate so these can be used in core_validation.cpp
1324template BarrierOperationsType CoreChecks::ComputeBarrierOperationsType(const CMD_BUFFER_STATE *cb_state,
1325 uint32_t buffer_barrier_count,
1326 const VkBufferMemoryBarrier *buffer_barriers,
1327 uint32_t image_barrier_count,
1328 const VkImageMemoryBarrier *image_barriers) const;
1329template BarrierOperationsType CoreChecks::ComputeBarrierOperationsType(const CMD_BUFFER_STATE *cb_state,
1330 uint32_t buffer_barrier_count,
1331 const VkBufferMemoryBarrier2KHR *buffer_barriers,
1332 uint32_t image_barrier_count,
1333 const VkImageMemoryBarrier2KHR *image_barriers) const;
1334
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001335// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001336template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001337bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001338 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1339 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001340 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1341 using sync_vuid_maps::GetImageBarrierVUID;
1342 using sync_vuid_maps::ImageError;
1343
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001344 bool skip = false;
1345 const auto *fb_state = framebuffer;
1346 assert(fb_state);
1347 const auto img_bar_image = img_barrier.image;
1348 bool image_match = false;
1349 bool sub_image_found = false; // Do we find a corresponding subpass description
1350 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1351 uint32_t attach_index = 0;
1352 // Verify that a framebuffer image matches barrier image
1353 const auto attachment_count = fb_state->createInfo.attachmentCount;
1354 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
1355 auto view_state = GetActiveAttachmentImageViewState(cb_state, attachment, primary_cb_state);
1356 if (view_state && (img_bar_image == view_state->create_info.image)) {
1357 image_match = true;
1358 attach_index = attachment;
1359 break;
1360 }
1361 }
1362 if (image_match) { // Make sure subpass is referring to matching attachment
1363 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1364 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1365 sub_image_found = true;
1366 }
1367 if (!sub_image_found && device_extensions.vk_khr_depth_stencil_resolve) {
1368 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1369 if (resolve && resolve->pDepthStencilResolveAttachment &&
1370 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1371 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1372 sub_image_found = true;
1373 }
1374 }
1375 if (!sub_image_found) {
1376 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1377 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1378 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1379 sub_image_found = true;
1380 break;
1381 }
1382 if (!sub_image_found && sub_desc.pResolveAttachments &&
1383 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1384 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1385 sub_image_found = true;
1386 break;
1387 }
1388 }
1389 }
1390 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001391 auto img_loc = loc.dot(Field::image);
1392 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1393 skip |=
1394 LogError(rp_handle, vuid,
1395 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1396 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1397 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001398 }
1399 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001400 auto img_loc = loc.dot(Field::image);
1401 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1402 skip |= LogError(fb_state->framebuffer, vuid, "%s Barrier for %s does not match an image from the current %s.",
1403 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
1404 report_data->FormatHandle(fb_state->framebuffer).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001405 }
1406 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001407 auto layout_loc = loc.dot(Field::oldLayout);
1408 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1409 skip |= LogError(cb_state->commandBuffer, vuid,
1410 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001411 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001412 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001413 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1414 } else {
1415 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1416 LogObjectList objlist(rp_handle);
1417 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001418 auto layout_loc = loc.dot(Field::oldLayout);
1419 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1420 skip |= LogError(objlist, vuid,
1421 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001422 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001423 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001424 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1425 string_VkImageLayout(img_barrier.oldLayout));
1426 }
1427 }
1428 return skip;
1429}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001430// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001431template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001432 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1433 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1434 const VkImageMemoryBarrier &img_barrier,
1435 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001436template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001437 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1438 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1439 const VkImageMemoryBarrier2KHR &img_barrier,
1440 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001441
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001442template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001443void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001444 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001445 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1446 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1447 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1448 const auto active_subpass = cb_state->activeSubpass;
1449 const auto rp_state = cb_state->activeRenderPass;
1450 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001451 // Secondary CB case w/o FB specified delay validation
1452 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001453 core_error::LocationCapture loc_capture(loc);
John Zulaufb4438f02021-02-20 20:22:16 -07001454 const auto render_pass = rp_state->renderPass;
1455 cb_state->cmd_execute_commands_functions.emplace_back(
1456 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1457 const FRAMEBUFFER_STATE *fb) {
1458 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1459 render_pass, barrier, primary_cb);
1460 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001461 }
1462}
1463
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001464void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001465 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1466 const VkImageMemoryBarrier *pImageMemBarriers) {
1467 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001468 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001469 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1470 }
1471 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001472 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001473 const auto &img_barrier = pImageMemBarriers[i];
1474 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1475 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1476 }
1477}
1478
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001479void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001480 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001481 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001482 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1483 }
1484 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001485 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001486 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1487 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1488 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1489 }
1490}
1491
1492template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001493bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001494 const char *operation, const TransferBarrier &barrier,
1495 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001496 // Record to the scoreboard or report that we have a duplication
1497 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001498 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001499 if (!inserted.second && inserted.first->second != cb_state) {
1500 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001501 LogObjectList objlist(cb_state->commandBuffer);
1502 objlist.add(barrier.handle);
1503 objlist.add(inserted.first->second->commandBuffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001504 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001505 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1506 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001507 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001508 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1509 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001510 }
1511 return skip;
1512}
1513
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001514template <typename TransferBarrier>
1515bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1516 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1517 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001518 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001519 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TransferBarrier());
1520 const char *barrier_name = TransferBarrier::BarrierName();
1521 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001522 // No release should have an extant duplicate (WARNING)
1523 for (const auto &release : cb_barriers.release) {
1524 // Check the global pending release barriers
1525 const auto set_it = global_release_barriers.find(release.handle);
1526 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001527 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001528 const auto found = set_for_handle.find(release);
1529 if (found != set_for_handle.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001530 skip |= LogWarning(cb_state->commandBuffer, TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001531 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1532 " to dstQueueFamilyIndex %" PRIu32
1533 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1534 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1535 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001536 }
1537 }
1538 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1539 }
1540 // Each acquire must have a matching release (ERROR)
1541 for (const auto &acquire : cb_barriers.acquire) {
1542 const auto set_it = global_release_barriers.find(acquire.handle);
1543 bool matching_release_found = false;
1544 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001545 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001546 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1547 }
1548 if (!matching_release_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001549 skip |= LogError(cb_state->commandBuffer, TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001550 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1551 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1552 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1553 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001554 }
1555 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1556 }
1557 return skip;
1558}
1559
John Zulauf3b04ebd2019-07-18 14:08:11 -06001560bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001561 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1562 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001563 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001564 skip |=
1565 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1566 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1567 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001568 return skip;
1569}
1570
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001571template <typename TransferBarrier>
1572void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1573 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001574 // Add release barriers from this submit to the global map
1575 for (const auto &release : cb_barriers.release) {
1576 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1577 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1578 global_release_barriers[release.handle].insert(release);
1579 }
1580
1581 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1582 for (const auto &acquire : cb_barriers.acquire) {
1583 // NOTE: We're not using [] because we don't want to create entries for missing releases
1584 auto set_it = global_release_barriers.find(acquire.handle);
1585 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001586 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001587 set_for_handle.erase(acquire);
1588 if (set_for_handle.size() == 0) { // Clean up empty sets
1589 global_release_barriers.erase(set_it);
1590 }
1591 }
1592 }
1593}
1594
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001595void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001596 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1597 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1598 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001599}
1600
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001601template <typename ImgBarrier>
1602void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1603 // For ownership transfers, the barrier is specified twice; as a release
1604 // operation on the yielding queue family, and as an acquire operation
1605 // on the acquiring queue family. This barrier may also include a layout
1606 // transition, which occurs 'between' the two operations. For validation
1607 // purposes it doesn't seem important which side performs the layout
1608 // transition, but it must not be performed twice. We'll arbitrarily
1609 // choose to perform it as part of the acquire operation.
1610 //
1611 // However, we still need to record initial layout for the "initial layout" validation
1612 for (uint32_t i = 0; i < barrier_count; i++) {
1613 const auto &mem_barrier = barriers[i];
John Zulauf2be3fe02019-12-30 09:48:02 -07001614 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001615 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001616 if (image_state) {
1617 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1618 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001619 }
1620}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001621// explictly instantiate this template so it can be used in core_validation.cpp
1622template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1623 const VkImageMemoryBarrier *barrier);
1624template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1625 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001626
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001627VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1628
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001629template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001630void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001631 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001632 if (enabled_features.synchronization2_features.synchronization2) {
1633 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1634 return;
1635 }
1636 }
unknown86bcb3a2019-07-11 13:05:36 -06001637 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1638 const auto &image_create_info = image_state->createInfo;
1639
Mike Schuchardt2df08912020-12-15 16:28:09 -08001640 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag bit, where <extent.depth> and
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001641 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
unknown86bcb3a2019-07-11 13:05:36 -06001642 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001643 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001644 normalized_isr.baseArrayLayer = 0;
1645 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1646 }
1647
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001648 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1649 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001650
1651 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001652 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001653 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1654 }
1655
John Zulauf2be3fe02019-12-30 09:48:02 -07001656 if (is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001657 SetImageInitialLayout(cb_state, *image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001658 } else {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001659 SetImageLayout(cb_state, *image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001660 }
unknown86bcb3a2019-07-11 13:05:36 -06001661}
1662
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001663bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1664 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1665 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1666 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001667 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001668 assert(cb_node);
1669 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001670 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001671 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001672
John Zulauff660ad62019-03-23 07:16:05 -06001673 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1674 if (subresource_map) {
1675 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001676 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001677 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1678 // the next "constant value" range
1679 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001680 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001681 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001682 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1683 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1684 "%s layout %s.",
1685 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1686 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1687 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001688 }
John Zulauf5e617452019-11-19 14:44:16 -07001689 }
John Zulauff660ad62019-03-23 07:16:05 -06001690 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001691 }
John Zulauff660ad62019-03-23 07:16:05 -06001692
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001693 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1694 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1695 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001696 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1697 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001698 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1699 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1700 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001701 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001702 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001703 if (image_state->shared_presentable) {
1704 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001705 skip |=
1706 LogError(device, layout_invalid_msg_code,
1707 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1708 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001709 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001710 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001711 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001712 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001713 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1714 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1715 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1716 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001717 }
1718 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001719 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001720}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001721bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001722 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1723 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001724 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001725 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1726 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1727}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001728
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001729void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001730 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001731 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1732 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001733
Mike Schuchardt2df08912020-12-15 16:28:09 -08001734 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001735 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001736 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001737 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001738 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001739 VkImageLayout stencil_layout = kInvalidLayout;
1740 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001741 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001742 if (attachment_description_stencil_layout) {
1743 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1744 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001745 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001746 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001747 }
1748 }
1749}
Dave Houltone19e20d2018-02-02 16:32:41 -07001750
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001751#ifdef VK_USE_PLATFORM_ANDROID_KHR
1752// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1753// This could also move into a seperate core_validation_android.cpp file... ?
1754
1755//
1756// AHB-specific validation within non-AHB APIs
1757//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001758bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001759 bool skip = false;
1760
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001761 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001762 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001763 if (0 != ext_fmt_android->externalFormat) {
1764 if (VK_FORMAT_UNDEFINED != create_info->format) {
1765 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001766 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1767 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1768 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001769 }
1770
1771 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001772 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1773 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1774 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001775 }
1776
1777 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001778 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1779 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001780 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001781 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001782 }
1783
1784 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001785 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1786 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1787 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001788 }
1789 }
1790
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001791 if ((0 != ext_fmt_android->externalFormat) &&
1792 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001793 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001794 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1795 ") which has "
1796 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1797 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001798 }
1799 }
1800
Dave Houltond9611312018-11-19 17:03:36 -07001801 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001802 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001803 skip |=
1804 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1805 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1806 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001807 }
1808 }
1809
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001810 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001811 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1812 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001813 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001814 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1815 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1816 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1817 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001818 }
1819
1820 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001821 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1822 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1823 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1824 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1825 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001826 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001827 }
1828
1829 return skip;
1830}
1831
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001832bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001833 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001834 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001835
1836 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001837 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001838 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1839 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001840 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001841 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001842 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001843
Dave Houltond9611312018-11-19 17:03:36 -07001844 // Chain must include a compatible ycbcr conversion
1845 bool conv_found = false;
1846 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001847 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001848 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001849 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001850 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001851 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001852 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001853 }
Dave Houltond9611312018-11-19 17:03:36 -07001854 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001855 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001856 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001857 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1858 "an externalFormat (%" PRIu64
1859 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1860 "with the same external format.",
1861 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001862 }
1863
1864 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001865 if (IsIdentitySwizzle(create_info->components) == false) {
1866 skip |= LogError(
1867 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1868 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1869 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1870 "= %s.",
1871 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1872 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001873 }
1874 }
Dave Houltond9611312018-11-19 17:03:36 -07001875
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001876 return skip;
1877}
1878
John Zulaufa26d3c82019-08-14 16:09:08 -06001879bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001880 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001881
John Zulaufa26d3c82019-08-14 16:09:08 -06001882 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001883 if (image_state != nullptr) {
1884 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1885 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1886 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1887 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1888 "bound to memory.");
1889 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001890 }
1891 return skip;
1892}
1893
1894#else
1895
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001896bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001897 return false;
1898}
1899
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001900bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001901
John Zulaufa26d3c82019-08-14 16:09:08 -06001902bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001903
1904#endif // VK_USE_PLATFORM_ANDROID_KHR
1905
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001906bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1907 bool skip = false;
1908
1909 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1910 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1911 const VkImageTiling image_tiling = pCreateInfo->tiling;
1912 const VkFormat image_format = pCreateInfo->format;
1913
1914 if (image_format == VK_FORMAT_UNDEFINED) {
1915 // VU 01975 states format can't be undefined unless an android externalFormat
1916#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001917 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001918 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1919 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1920 if (it != ahb_ext_formats_map.end()) {
1921 tiling_features = it->second;
1922 }
1923 }
1924#endif
1925 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1926 uint64_t drm_format_modifier = 0;
1927 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001928 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001929 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001930 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001931
1932 if (drm_explicit != nullptr) {
1933 drm_format_modifier = drm_explicit->drmFormatModifier;
1934 } else {
1935 // VUID 02261 makes sure its only explict or implict in parameter checking
1936 assert(drm_implicit != nullptr);
1937 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1938 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1939 }
1940 }
1941
1942 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1943 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1944 nullptr};
1945 format_properties_2.pNext = (void *)&drm_properties_list;
1946 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001947 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1948 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1949 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1950 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001951
1952 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1953 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1954 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1955 }
1956 }
1957 } else {
1958 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1959 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1960 : format_properties.optimalTilingFeatures;
1961 }
1962
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001963 // Lack of disjoint format feature support while using the flag
1964 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1965 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1966 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1967 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1968 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1969 string_VkFormat(pCreateInfo->format));
1970 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001971
1972 return skip;
1973}
1974
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001975bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001976 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001977 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001978
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001979 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001980 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001981 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1982 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001983 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1984 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001985 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001986 }
1987
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001988 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1989 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001990 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1991 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1992 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001993 }
1994
1995 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001996 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1997 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1998 "height (%d) and arrayLayers (%d) must be >= 6.",
1999 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06002000 }
Dave Houlton130c0212018-01-29 13:39:56 -07002001 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002002
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06002003 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07002004 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
2005 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
2006 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002007 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002008 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
2009 "device maxFramebufferWidth (%u).",
2010 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07002011 }
2012
2013 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002014 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002015 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
2016 "device maxFramebufferHeight (%u).",
2017 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07002018 }
2019
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02002020 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002021 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
2022 static_cast<float>(device_limits->maxFramebufferWidth) /
2023 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07002024 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
2025 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002026 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
2027 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
2028 "ceiling of device "
2029 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
2030 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
2031 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07002032 }
2033
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002034 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
2035 static_cast<float>(device_limits->maxFramebufferHeight) /
2036 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07002037 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
2038 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002039 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
2040 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
2041 "ceiling of device "
2042 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
2043 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
2044 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07002045 }
2046 }
2047
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002048 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06002049 VkResult result = VK_SUCCESS;
2050 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
2051 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
2052 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
2053 &format_limits);
2054 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002055 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
2056 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002057 if (modifier_list) {
2058 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002059 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002060 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002061 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002062 image_format_info.type = pCreateInfo->imageType;
2063 image_format_info.format = pCreateInfo->format;
2064 image_format_info.tiling = pCreateInfo->tiling;
2065 image_format_info.usage = pCreateInfo->usage;
2066 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002067 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002068
2069 result =
2070 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
2071 format_limits = image_format_properties.imageFormatProperties;
2072
2073 /* The application gives a list of modifier and the driver
2074 * selects one. If one is wrong, stop there.
2075 */
2076 if (result != VK_SUCCESS) break;
2077 }
2078 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002079 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002080 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002081 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002082 image_format_info.type = pCreateInfo->imageType;
2083 image_format_info.format = pCreateInfo->format;
2084 image_format_info.tiling = pCreateInfo->tiling;
2085 image_format_info.usage = pCreateInfo->usage;
2086 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002087 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002088
2089 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
2090 format_limits = image_format_properties.imageFormatProperties;
2091 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06002092 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06002093
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002094 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
2095 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
2096 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
2097 if (result != VK_SUCCESS) {
2098 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06002099#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002100 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06002101#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002102 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07002103 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002104 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
2105 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002106#ifdef VK_USE_PLATFORM_ANDROID_KHR
2107 }
2108#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002109 } else {
2110 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
2111 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002112 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
2113 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
2114 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002115 }
Dave Houlton130c0212018-01-29 13:39:56 -07002116
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002117 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
2118 static_cast<uint64_t>(pCreateInfo->extent.height) *
2119 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
2120 static_cast<uint64_t>(pCreateInfo->samples);
2121 uint64_t total_size =
2122 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07002123
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002124 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002125 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
2126 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002127 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002128
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002129 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002130 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
2131 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
2132 ", maximum resource size = 0x%" PRIxLEAST64 " ",
2133 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002134 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002135
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002136 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002137 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
2138 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
2139 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002140 }
2141
2142 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002143 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
2144 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
2145 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002146 }
sfricke-samsung612f3622020-06-20 20:42:46 -07002147
2148 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
2149 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
2150 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
2151 pCreateInfo->extent.width, format_limits.maxExtent.width);
2152 }
2153
2154 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
2155 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
2156 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
2157 pCreateInfo->extent.height, format_limits.maxExtent.height);
2158 }
2159
2160 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
2161 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
2162 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
2163 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
2164 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002165 }
2166
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002167 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08002168 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
2169 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
2170 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
2171 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002172 skip |= LogError(device, error_vuid,
2173 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
2174 "YCbCr Conversion format, arrayLayers must be 1",
2175 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002176 }
2177
2178 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002179 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
2180 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
2181 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002182 }
2183
2184 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002185 skip |= LogError(
2186 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08002187 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
2188 string_VkSampleCountFlagBits(pCreateInfo->samples));
2189 }
2190
2191 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002192 skip |= LogError(
2193 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08002194 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2195 string_VkImageType(pCreateInfo->imageType));
2196 }
2197 }
2198
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002199 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002200 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07002201 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06002202 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002203 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2204 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2205 "format must be block, ETC or ASTC compressed, but is %s",
2206 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002207 }
2208 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002209 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2210 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2211 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002212 }
2213 }
2214 }
2215
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002216 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002217 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
2218 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
2219 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002220 }
2221
unknown2c877272019-07-11 12:56:50 -06002222 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2223 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2224 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002225 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2226 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2227 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002228 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002229
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002230 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002231 if (swapchain_create_info != nullptr) {
2232 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2233 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2234 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2235
2236 // Validate rest of Swapchain Image create check that require swapchain state
2237 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2238 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2239 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2240 skip |= LogError(
2241 device, vuid,
2242 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2243 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2244 }
2245 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2246 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2247 skip |= LogError(device, vuid,
2248 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2249 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2250 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002251 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002252 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2253 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2254 skip |= LogError(device, vuid,
2255 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2256 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002257 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002258 }
2259 }
2260 }
2261
sfricke-samsungedce77a2020-07-03 22:35:13 -07002262 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2263 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2264 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2265 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2266 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2267 }
2268 const VkImageCreateFlags invalid_flags =
2269 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2270 if ((pCreateInfo->flags & invalid_flags) != 0) {
2271 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2272 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2273 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2274 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2275 }
2276 }
2277
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002278 skip |= ValidateImageFormatFeatures(pCreateInfo);
2279
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002280 // Check compatibility with VK_KHR_portability_subset
2281 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
2282 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2283 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2284 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2285 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2286 }
2287 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2288 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2289 skip |=
2290 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2291 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2292 }
2293 }
2294
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002295 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002296}
2297
John Zulauf7eeb6f72019-06-17 11:56:36 -06002298void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2299 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2300 if (VK_SUCCESS != result) return;
2301
2302 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002303 auto image_state = Get<IMAGE_STATE>(*pImage);
2304 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002305}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002306
Jeff Bolz5c801d12019-10-09 10:38:45 -05002307bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002308 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06002309 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002310 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002311 if (image_state) {
sfricke-samsung9056cc12021-04-18 22:51:00 -07002312 if (image_state->is_swapchain_image) {
2313 // TODO - Add VUID when headers are upstreamed
2314 skip |= LogError(device, "UNASSIGNED-vkDestroyImage-image",
2315 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2316 "destroyed with vkDestroySwapchainKHR.",
2317 report_data->FormatHandle(image_state->image).c_str());
2318 }
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002319 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002320 }
2321 return skip;
2322}
2323
John Zulauf7eeb6f72019-06-17 11:56:36 -06002324void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2325 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002326 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002327
locke-lunargcba7d5f2019-12-30 16:59:11 -07002328 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002329
2330 // Clean up generic image state
2331 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002332}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002333
sfricke-samsungcd924d92020-05-20 23:51:17 -07002334bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2335 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002336 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002337 const VkImage image = image_state->image;
2338 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002339
2340 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002341 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2342 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002343 }
2344
sfricke-samsungcd924d92020-05-20 23:51:17 -07002345 if (FormatIsDepthOrStencil(format)) {
2346 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2347 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2348 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2349 } else if (FormatIsCompressed(format)) {
2350 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2351 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2352 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002353 }
2354
2355 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002356 skip |=
2357 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2358 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2359 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002360 }
2361 return skip;
2362}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002363
John Zulauf07288512019-07-05 11:09:50 -06002364bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2365 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2366 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002367 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002368 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2369 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002370 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2371 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2372 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002373 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002374
2375 } else {
2376 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2377 if (!device_extensions.vk_khr_shared_presentable_image) {
2378 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002379 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2380 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2381 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002382 }
2383 } else {
2384 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2385 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002386 skip |= LogError(
2387 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002388 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2389 func_name, string_VkImageLayout(dest_image_layout));
2390 }
2391 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002392 }
2393
John Zulauff660ad62019-03-23 07:16:05 -06002394 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002395 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002396 if (subresource_map) {
2397 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002398 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002399 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002400 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2401 // the next "constant value" range
2402 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002403 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002404 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2405 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2406 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2407 } else {
2408 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002409 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002410 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2411 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2412 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2413 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002414 }
John Zulauf5e617452019-11-19 14:44:16 -07002415 }
John Zulauff660ad62019-03-23 07:16:05 -06002416 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002417 }
2418
2419 return skip;
2420}
2421
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002422bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2423 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002424 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002425 bool skip = false;
2426 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002427 const auto *cb_node = GetCBState(commandBuffer);
2428 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002429 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002430 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002431 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002432 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002433 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2434 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002435 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002436 skip |=
2437 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2438 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2439 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002440 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002441 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002442 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002443 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002444 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002445 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002446 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2447 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2448 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2449 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2450 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2451 string_VkFormat(image_state->createInfo.format));
2452 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002453 }
2454 return skip;
2455}
2456
John Zulaufeabb4462019-07-05 14:13:03 -06002457void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2458 const VkClearColorValue *pColor, uint32_t rangeCount,
2459 const VkImageSubresourceRange *pRanges) {
2460 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2461
2462 auto cb_node = GetCBState(commandBuffer);
2463 auto image_state = GetImageState(image);
2464 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002465 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002466 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002467 }
2468 }
2469}
2470
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002471bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2472 const char *apiName) const {
2473 bool skip = false;
2474
2475 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2476 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2477 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2478 // Also VUID-VkClearDepthStencilValue-depth-00022
2479 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2480 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2481 "(=%f) is not within the [0.0, 1.0] range.",
2482 apiName, clearValue.depth);
2483 }
2484 }
2485
2486 return skip;
2487}
2488
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002489bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2490 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002491 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002492 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002493
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002494 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002495 const auto *cb_node = GetCBState(commandBuffer);
2496 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002497 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002498 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002499 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002500 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002501 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002502 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002503 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002504 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002505 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002506 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002507 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2508 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2509 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2510 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002511
2512 bool any_include_aspect_depth_bit = false;
2513 bool any_include_aspect_stencil_bit = false;
2514
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002515 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002516 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002517 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002518 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002519 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002520 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2521 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002522 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2523 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2524 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2525 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002526 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002527 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2528 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002529 if (FormatHasDepth(image_format) == false) {
2530 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2531 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2532 "doesn't have a depth component.",
2533 i, string_VkFormat(image_format));
2534 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002535 }
2536 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2537 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002538 if (FormatHasStencil(image_format) == false) {
2539 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2540 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2541 "%s doesn't have a stencil component.",
2542 i, string_VkFormat(image_format));
2543 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002544 }
2545 }
2546 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002547 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002548 if (image_stencil_struct != nullptr) {
2549 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2550 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002551 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2552 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2553 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2554 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002555 }
2556 } else {
2557 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002558 skip |= LogError(
2559 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002560 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2561 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2562 "in VkImageCreateInfo::usage used to create image");
2563 }
2564 }
2565 }
2566 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002567 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2568 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2569 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002570 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002571 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002572 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2573 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002574 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002575 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002576 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002577 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2578 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2579 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2580 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002581 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002582 }
2583 return skip;
2584}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002585
John Zulaufeabb4462019-07-05 14:13:03 -06002586void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2587 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2588 const VkImageSubresourceRange *pRanges) {
2589 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2590 auto cb_node = GetCBState(commandBuffer);
2591 auto image_state = GetImageState(image);
2592 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002593 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002594 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002595 }
2596 }
2597}
2598
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002599// Returns true if [x, xoffset] and [y, yoffset] overlap
2600static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2601 bool result = false;
2602 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2603 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2604
2605 if (intersection_max > intersection_min) {
2606 result = true;
2607 }
2608 return result;
2609}
2610
Jeff Leger178b1e52020-10-05 12:22:23 -04002611// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002612// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002613template <typename RegionType>
2614static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002615 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002616
Dave Houltonc991cc92018-03-06 11:08:51 -07002617 // Separate planes within a multiplane image cannot intersect
2618 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002619 return result;
2620 }
2621
Dave Houltonc991cc92018-03-06 11:08:51 -07002622 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2623 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2624 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002625 result = true;
2626 switch (type) {
2627 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002628 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002629 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002630 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002631 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002632 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002633 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002634 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002635 break;
2636 default:
2637 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2638 assert(false);
2639 }
2640 }
2641 return result;
2642}
2643
Dave Houltonfc1a4052017-04-27 14:32:45 -06002644// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002645static const uint32_t kXBit = 1;
2646static const uint32_t kYBit = 2;
2647static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002648static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002649 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002650 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002651 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2652 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002653 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002654 }
2655 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2656 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002657 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002658 }
2659 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2660 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002661 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002662 }
2663 return result;
2664}
2665
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002666// Test if two VkExtent3D structs are equivalent
2667static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2668 bool result = true;
2669 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2670 (extent->depth != other_extent->depth)) {
2671 result = false;
2672 }
2673 return result;
2674}
2675
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002676// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002677static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002678 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2679}
2680
2681// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002682VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002683 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2684 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002685 auto pool = cb_node->command_pool.get();
2686 if (pool) {
2687 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002688 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002689 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002690 granularity.width *= block_size.width;
2691 granularity.height *= block_size.height;
2692 }
2693 }
2694 return granularity;
2695}
2696
2697// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2698static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2699 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002700 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2701 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002702 valid = false;
2703 }
2704 return valid;
2705}
2706
2707// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002708bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002709 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002710 bool skip = false;
2711 VkExtent3D offset_extent = {};
2712 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2713 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2714 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002715 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002716 // If the queue family image transfer granularity is (0, 0, 0), then the offset must always be (0, 0, 0)
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002717 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002718 skip |= LogError(cb_node->commandBuffer, vuid,
2719 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) when the command buffer's queue family "
2720 "image transfer granularity is (w=0, h=0, d=0).",
2721 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002722 }
2723 } else {
2724 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2725 // integer multiples of the image transfer granularity.
2726 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002727 skip |= LogError(cb_node->commandBuffer, vuid,
2728 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2729 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2730 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2731 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002732 }
2733 }
2734 return skip;
2735}
2736
2737// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002738bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002739 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002740 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002741 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002742 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002743 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2744 // subresource extent.
2745 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002746 skip |= LogError(cb_node->commandBuffer, vuid,
2747 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2748 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2749 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2750 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002751 }
2752 } else {
2753 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2754 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2755 // subresource extent dimensions.
2756 VkExtent3D offset_extent_sum = {};
2757 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2758 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2759 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002760 bool x_ok = true;
2761 bool y_ok = true;
2762 bool z_ok = true;
2763 switch (image_type) {
2764 case VK_IMAGE_TYPE_3D:
2765 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2766 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002767 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002768 case VK_IMAGE_TYPE_2D:
2769 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2770 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002771 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002772 case VK_IMAGE_TYPE_1D:
2773 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2774 (subresource_extent->width == offset_extent_sum.width));
2775 break;
2776 default:
2777 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2778 assert(false);
2779 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002780 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002781 skip |=
2782 LogError(cb_node->commandBuffer, vuid,
2783 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2784 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2785 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2786 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2787 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2788 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002789 }
2790 }
2791 return skip;
2792}
2793
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002794bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002795 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002796 bool skip = false;
2797 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002798 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2799 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002800 }
2801 return skip;
2802}
2803
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002804bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002805 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002806 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002807 bool skip = false;
2808 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2809 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002810 skip |= LogError(cb_node->commandBuffer, vuid,
2811 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2812 "%u, but provided %s has %u array layers.",
2813 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2814 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002815 }
2816 return skip;
2817}
2818
Jeff Leger178b1e52020-10-05 12:22:23 -04002819// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2820template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002821bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002822 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002823 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002824 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002825 VkExtent3D granularity = GetScaledItg(cb_node, img);
2826 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002827 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002828 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002829 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002830 return skip;
2831}
2832
Jeff Leger178b1e52020-10-05 12:22:23 -04002833// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2834template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002835bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002836 const IMAGE_STATE *dst_img, const RegionType *region,
2837 const uint32_t i, const char *function,
2838 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002839 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002840 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2841 const char *vuid;
2842
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002843 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002844 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002845 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2846 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002847 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002848 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002849 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002850 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002851 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002852
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002853 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002854 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002855 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2856 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002857 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002858 const VkExtent3D dest_effective_extent =
2859 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002860 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002861 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002862 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002863 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002864 return skip;
2865}
2866
Jeff Leger178b1e52020-10-05 12:22:23 -04002867// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2868template <typename ImageCopyRegionType>
2869bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2870 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2871 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002872 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002873 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2874 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2875 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002876
2877 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002878 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002879
2880 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002881 const VkExtent3D src_copy_extent = region.extent;
2882 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002883 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2884
Dave Houlton6f9059e2017-05-02 17:15:13 -06002885 bool slice_override = false;
2886 uint32_t depth_slices = 0;
2887
2888 // Special case for copying between a 1D/2D array and a 3D image
2889 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2890 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002891 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002892 slice_override = (depth_slices != 1);
2893 } else if ((VK_IMAGE_TYPE_3D == dst_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != src_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002894 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002895 slice_override = (depth_slices != 1);
2896 }
2897
2898 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002899 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002900 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002901 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2902 skip |= LogError(src_state->image, vuid,
2903 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2904 "be 0 and 1, respectively.",
2905 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002906 }
2907 }
2908
Dave Houlton533be9f2018-03-26 17:08:30 -06002909 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002910 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2911 skip |= LogError(src_state->image, vuid,
2912 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002913 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002914 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002915 }
2916
Dave Houlton533be9f2018-03-26 17:08:30 -06002917 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002918 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2919 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2920 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002921 }
2922
Dave Houltonc991cc92018-03-06 11:08:51 -07002923 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002924 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002925 if (FormatIsCompressed(src_state->createInfo.format) ||
2926 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002927 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002928 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002929 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2930 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2931 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002932 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002933 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002934 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002935 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002936 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002937 }
2938
Dave Houlton94a00372017-12-14 15:08:47 -07002939 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002940 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2941 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002942 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2943 skip |= LogError(src_state->image, vuid,
2944 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2945 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2946 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002947 }
2948
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002949 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002950 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2951 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002952 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2953 skip |= LogError(src_state->image, vuid,
2954 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2955 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2956 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002957 }
2958
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002959 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002960 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2961 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002962 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2963 skip |= LogError(src_state->image, vuid,
2964 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2965 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2966 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002967 }
2968 } // Compressed
2969
2970 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002971 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002972 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002973 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2974 skip |= LogError(dst_state->image, vuid,
2975 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002976 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002977 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002978 }
2979 }
2980
Dave Houlton533be9f2018-03-26 17:08:30 -06002981 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002982 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2983 skip |= LogError(dst_state->image, vuid,
2984 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2985 "and 1, respectively.",
2986 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002987 }
2988
Dave Houlton533be9f2018-03-26 17:08:30 -06002989 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002990 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2991 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2992 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002993 }
2994
sfricke-samsung30b094c2020-05-30 11:42:11 -07002995 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002996 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002997 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2998 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002999 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
3000 skip |= LogError(src_state->image, vuid,
3001 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
3002 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
3003 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07003004 }
3005 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06003006 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07003007 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003008 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
3009 skip |= LogError(dst_state->image, vuid,
3010 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
3011 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
3012 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003013 }
3014 }
3015 } else { // Pre maint 1
3016 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07003017 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003018 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
3019 skip |= LogError(src_state->image, vuid,
3020 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07003021 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
3022 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003023 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07003024 }
Dave Houltonee281a52017-12-08 13:51:02 -07003025 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003026 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
3027 skip |= LogError(dst_state->image, vuid,
3028 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003029 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
3030 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003031 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003032 }
3033 }
3034 }
3035
Dave Houltonc991cc92018-03-06 11:08:51 -07003036 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
3037 if (FormatIsCompressed(dst_state->createInfo.format) ||
3038 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07003039 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003040
3041 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07003042 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
3043 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
3044 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003045 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003046 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003047 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003048 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003049 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003050 }
3051
Dave Houlton94a00372017-12-14 15:08:47 -07003052 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07003053 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
3054 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003055 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
3056 skip |= LogError(dst_state->image, vuid,
3057 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3058 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
3059 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06003060 }
3061
Dave Houltonee281a52017-12-08 13:51:02 -07003062 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
3063 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
3064 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003065 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003066 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003067 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003068 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
3069 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003070 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003071 }
3072
Dave Houltonee281a52017-12-08 13:51:02 -07003073 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
3074 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
3075 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003076 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
3077 skip |= LogError(dst_state->image, vuid,
3078 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3079 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
3080 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003081 }
3082 } // Compressed
3083 }
3084 return skip;
3085}
3086
Jeff Leger178b1e52020-10-05 12:22:23 -04003087template <typename RegionType>
3088bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3089 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3090 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003091 const auto *cb_node = GetCBState(commandBuffer);
3092 const auto *src_image_state = GetImageState(srcImage);
3093 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08003094 const VkFormat src_format = src_image_state->createInfo.format;
3095 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04003096 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003097 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003098
Jeff Leger178b1e52020-10-05 12:22:23 -04003099 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
3100 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
3101 const char *vuid;
3102
3103 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003104
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003105 VkCommandBuffer command_buffer = cb_node->commandBuffer;
3106
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003107 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003108 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07003109
3110 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
3111 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08003112 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07003113
Dave Houlton6f9059e2017-05-02 17:15:13 -06003114 bool slice_override = false;
3115 uint32_t depth_slices = 0;
3116
3117 // Special case for copying between a 1D/2D array and a 3D image
3118 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
3119 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3120 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003121 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003122 slice_override = (depth_slices != 1);
3123 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3124 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003125 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003126 slice_override = (depth_slices != 1);
3127 }
3128
Jeff Leger178b1e52020-10-05 12:22:23 -04003129 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
3130 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
3131 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
3132 skip |=
3133 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3134 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
3135 skip |=
3136 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3137 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003138 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003139 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3140 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003141 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003142 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003143
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003144 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06003145 // No chance of mismatch if we're overriding depth slice count
3146 if (!slice_override) {
3147 // The number of depth slices in srcSubresource and dstSubresource must match
3148 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
3149 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003150 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
3151 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003152 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003153 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
3154 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003155 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003156 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
3157 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003158 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
3159 "do not match.",
3160 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003161 }
3162 }
3163 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003164 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07003165 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003166 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003167 skip |=
3168 LogError(command_buffer, vuid,
3169 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
3170 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003171 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003172 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003173
Dave Houltonc991cc92018-03-06 11:08:51 -07003174 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003175 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003176 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3177 // If neither image is multi-plane the aspectMask member of src and dst must match
3178 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
3179 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
3180 skip |= LogError(command_buffer, vuid,
3181 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3182 "source (0x%x) destination (0x%x).",
3183 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3184 }
3185 } else {
3186 // Source image multiplane checks
3187 uint32_t planes = FormatPlaneCount(src_format);
3188 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3189 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3190 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
3191 skip |= LogError(command_buffer, vuid,
3192 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3193 i, aspect);
3194 }
3195 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3196 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3197 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
3198 skip |= LogError(command_buffer, vuid,
3199 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3200 i, aspect);
3201 }
3202 // Single-plane to multi-plane
3203 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3204 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3205 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3206 skip |= LogError(command_buffer, vuid,
3207 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3208 func_name, i, aspect);
3209 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003210
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003211 // Dest image multiplane checks
3212 planes = FormatPlaneCount(dst_format);
3213 aspect = region.dstSubresource.aspectMask;
3214 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3215 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3216 skip |= LogError(command_buffer, vuid,
3217 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3218 i, aspect);
3219 }
3220 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3221 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3222 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3223 skip |= LogError(command_buffer, vuid,
3224 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3225 i, aspect);
3226 }
3227 // Multi-plane to single-plane
3228 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3229 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3230 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3231 skip |= LogError(command_buffer, vuid,
3232 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3233 func_name, i, aspect);
3234 }
3235 }
3236 } else {
3237 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003238 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3239 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003240 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003241 skip |= LogError(
3242 command_buffer, vuid,
3243 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3244 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003245 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003246 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003247
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003248 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003249 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003250 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003251 skip |=
3252 LogError(command_buffer, vuid,
3253 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3254 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003255 }
3256
3257 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003258 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003259 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003260 skip |= LogError(
3261 command_buffer, vuid,
3262 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3263 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003264 }
3265
Dave Houltonfc1a4052017-04-27 14:32:45 -06003266 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07003267 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
3268 if (slice_override) src_copy_extent.depth = depth_slices;
3269 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003270 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003271 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3272 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003273 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003274 "width [%1d].",
3275 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003276 }
3277
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003278 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003279 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3280 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003281 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003282 "height [%1d].",
3283 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003284 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003285 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003286 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3287 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003288 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003289 "depth [%1d].",
3290 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003291 }
3292
Dave Houltonee281a52017-12-08 13:51:02 -07003293 // Adjust dest extent if necessary
3294 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
3295 if (slice_override) dst_copy_extent.depth = depth_slices;
3296
3297 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003298 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003299 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3300 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003301 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003302 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003303 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003304 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003305 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003306 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3307 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003308 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003309 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003310 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003311 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003312 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003313 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3314 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003315 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003316 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003317 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003318 }
3319
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003320 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3321 // must not overlap in memory
3322 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003323 for (uint32_t j = 0; j < regionCount; j++) {
3324 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003325 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003326 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003327 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003328 }
3329 }
3330 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003331
3332 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3333 if (device_extensions.vk_khr_maintenance1) {
3334 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3335 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3336 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003337 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3338 skip |= LogError(command_buffer, vuid,
3339 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3340 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003341 }
3342 } else {
3343 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3344 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3345 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003346 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3347 skip |= LogError(command_buffer, vuid,
3348 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3349 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003350 }
3351 }
3352
3353 // Check if 2D with 3D and depth not equal to 2D layerCount
3354 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3355 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3356 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003357 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3358 skip |= LogError(command_buffer, vuid,
3359 "%s: pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
sfricke-samsung48172ca2020-02-13 23:38:11 -08003360 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003361 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003362 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3363 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3364 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003365 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3366 skip |= LogError(command_buffer, vuid,
3367 "%s: pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
sfricke-samsung48172ca2020-02-13 23:38:11 -08003368 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003369 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003370 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003371
3372 // Check for multi-plane format compatiblity
3373 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3374 size_t src_format_size = 0;
3375 size_t dst_format_size = 0;
3376 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003377 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3378 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003379 } else {
3380 src_format_size = FormatElementSize(src_format);
3381 }
3382 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003383 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3384 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003385 } else {
3386 dst_format_size = FormatElementSize(dst_format);
3387 }
3388 // If size is still zero, then format is invalid and will be caught in another VU
3389 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003390 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3391 skip |= LogError(command_buffer, vuid,
3392 "%s: pRegions[%u] called with non-compatible image formats. "
3393 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3394 func_name, i, string_VkFormat(src_format),
3395 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3396 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003397 }
3398 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003399 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003400
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003401 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3402 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3403 // because because both texels are 4 bytes in size.
3404 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003405 const char *compatible_vuid =
3406 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3407 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3408 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003409 // Depth/stencil formats must match exactly.
3410 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3411 if (src_format != dst_format) {
3412 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003413 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003414 string_VkFormat(src_format), string_VkFormat(dst_format));
3415 }
3416 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003417 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003418 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003419 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003420 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003421 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003422 FormatElementSize(dst_format));
3423 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003424 }
3425 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003426
Dave Houlton33c22b72017-02-28 13:16:02 -07003427 // Source and dest image sample counts must match
3428 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003429 std::stringstream ss;
3430 ss << func_name << " called on image pair with non-identical sample counts.";
3431 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003432 skip |=
3433 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3434 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3435 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003436 }
3437
Tony-LunarG5a066372021-01-21 10:31:34 -07003438 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3439 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3440 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003441 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
Tony-LunarG5a066372021-01-21 10:31:34 -07003442 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3443 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3444 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3445 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003446 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003447 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3448 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3449 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3450 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3451 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3452 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3453 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3454 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3455 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3456 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3457 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3458 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003459
3460 // Validation for VK_EXT_fragment_density_map
3461 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003462 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3463 skip |=
3464 LogError(command_buffer, vuid,
3465 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT", func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003466 }
3467 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003468 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3469 skip |=
3470 LogError(command_buffer, vuid,
3471 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT", func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003472 }
3473
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003474 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003475 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3476 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3477 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3478 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003479 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003480 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003481 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003482
3483 const char *invalid_src_layout_vuid =
3484 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3485 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3486 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3487 const char *invalid_dst_layout_vuid =
3488 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3489 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3490 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3491
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003492 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003493 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003494 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003495 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3496 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003497 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003498 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003499 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003500 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003501 }
3502
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003503 return skip;
3504}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003505
Jeff Leger178b1e52020-10-05 12:22:23 -04003506bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3507 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3508 const VkImageCopy *pRegions) const {
3509 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3510 COPY_COMMAND_VERSION_1);
3511}
3512
3513bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3514 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3515 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3516 COPY_COMMAND_VERSION_2);
3517}
3518
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003519void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3520 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3521 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003522 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3523 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003524 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003525 auto src_image_state = GetImageState(srcImage);
3526 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003527
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003528 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003529 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003530 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3531 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003532 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003533}
3534
Jeff Leger178b1e52020-10-05 12:22:23 -04003535void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3536 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3537 auto cb_node = GetCBState(commandBuffer);
3538 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3539 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3540
3541 // Make sure that all image slices are updated to correct layout
3542 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3543 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3544 pCopyImageInfo->srcImageLayout);
3545 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3546 pCopyImageInfo->dstImageLayout);
3547 }
3548}
3549
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003550// Returns true if sub_rect is entirely contained within rect
3551static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3552 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003553 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height)) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003554 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003555 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003556 return true;
3557}
3558
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003559bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003560 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003561 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3562 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003563 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003564 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3565 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003566 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003567 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003568
3569 for (uint32_t j = 0; j < rect_count; j++) {
3570 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003571 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3572 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3573 "the current render pass instance.",
3574 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003575 }
3576
3577 if (image_view_state) {
3578 // The layers specified by a given element of pRects must be contained within every attachment that
3579 // pAttachments refers to
3580 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3581 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3582 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003583 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3584 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3585 "of pAttachment[%d].",
3586 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003587 }
3588 }
3589 }
3590 return skip;
3591}
3592
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003593bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3594 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003595 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003596 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003597 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003598 if (!cb_node) return skip;
3599
Petr Kraus2dffb382019-08-10 02:52:12 +02003600 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003601
3602 // Validate that attachment is in reference list of active subpass
3603 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003604 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003605 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003606 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003607 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003608 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003609
John Zulauf3a548ef2019-02-01 16:14:07 -07003610 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3611 auto clear_desc = &pAttachments[attachment_index];
3612 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003613 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003614
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003615 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3616 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3617 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3618 attachment_index);
3619 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3620 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3621 skip |=
3622 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3623 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3624 attachment_index);
3625 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003626 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3627 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3628 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3629 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003630 skip |= LogError(
3631 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3632 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3633 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3634 attachment_index, clear_desc->colorAttachment,
3635 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3636 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003637
John Zulauff2582972019-02-09 14:53:30 -07003638 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3639 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003640 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003641 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3642 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3643 " subpass %u. colorAttachmentCount=%u",
3644 attachment_index, clear_desc->colorAttachment,
3645 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3646 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003647 }
John Zulauff2582972019-02-09 14:53:30 -07003648 fb_attachment = color_attachment;
3649
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003650 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3651 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3652 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3653 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3654 "of a color attachment.",
3655 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003656 }
3657 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003658 bool subpass_depth = false;
3659 bool subpass_stencil = false;
3660 if (subpass_desc->pDepthStencilAttachment &&
3661 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3662 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3663 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3664 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3665 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003666 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003667 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3668 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003669 skip |= LogError(
3670 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3671 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003672 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003673 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003674 }
3675 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003676 skip |= LogError(
3677 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3678 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003679 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003680 attachment_index);
3681 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003682 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003683 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003684 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003685 if (subpass_depth) {
3686 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3687 "vkCmdClearAttachments()");
3688 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003689 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003690 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003691 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3692 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003693 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003694
3695 // Once the framebuffer attachment is found, can get the image view state
3696 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3697 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3698 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003699 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003700 if (image_view_state != nullptr) {
3701 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3702 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3703 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3704 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3705 }
3706 }
John Zulauf441558b2019-08-12 11:47:39 -06003707 }
3708 }
3709 return skip;
3710}
3711
3712void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3713 const VkClearAttachment *pAttachments, uint32_t rectCount,
3714 const VkClearRect *pRects) {
3715 auto *cb_node = GetCBState(commandBuffer);
3716 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003717 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3718 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003719 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3720 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3721 const auto clear_desc = &pAttachments[attachment_index];
3722 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3723 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3724 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3725 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3726 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3727 subpass_desc->pDepthStencilAttachment) {
3728 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3729 }
3730 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003731 if (!clear_rect_copy) {
3732 // We need a copy of the clear rectangles that will persist until the last lambda executes
3733 // but we want to create it as lazily as possible
3734 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003735 }
John Zulauf441558b2019-08-12 11:47:39 -06003736 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3737 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003738 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003739 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003740 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003741 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3742 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003743 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003744 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003745 return skip;
3746 };
3747 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003748 }
3749 }
3750 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003751}
3752
Jeff Leger178b1e52020-10-05 12:22:23 -04003753template <typename RegionType>
3754bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3755 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3756 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003757 const auto *cb_node = GetCBState(commandBuffer);
3758 const auto *src_image_state = GetImageState(srcImage);
3759 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003760 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3761 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3762 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3763 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003764
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003765 bool skip = false;
3766 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003767 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3768 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3769 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3770 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003771 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003772 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3773 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3774 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3775 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3776 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3777 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3778 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3779 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003780
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003781 // Validation for VK_EXT_fragment_density_map
3782 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3784 skip |= LogError(cb_node->commandBuffer, vuid,
3785 "%s: srcImage must not have been created with flags containing "
3786 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3787 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003788 }
3789 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003790 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3791 skip |= LogError(cb_node->commandBuffer, vuid,
3792 "%s: dstImage must not have been created with flags containing "
3793 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3794 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003795 }
3796
Cort Stratton7df30962018-05-17 19:45:57 -07003797 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003798 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003799 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3800 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003801 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003802 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3803 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3804 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003805 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003806 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3807 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3808 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3809 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3810 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3811 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003812 // For each region, the number of layers in the image subresource should not be zero
3813 // For each region, src and dest image aspect must be color only
3814 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003815 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003816 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3817 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003818 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3819 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3820 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003821 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003822 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3823 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003824 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003825 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3826 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3827 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3828 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3829 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3830 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003831 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003832 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3833 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003834 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003835 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003836
3837 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003838 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003839 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3840 skip |=
3841 LogError(cb_node->commandBuffer, vuid,
3842 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003843 }
Cort Stratton7df30962018-05-17 19:45:57 -07003844 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003845 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3846 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003847 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3848 skip |= LogError(cb_node->commandBuffer, vuid,
3849 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3850 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003851 }
3852
3853 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3854 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3855
3856 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003857 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003858 LogObjectList objlist(cb_node->commandBuffer);
3859 objlist.add(src_image_state->image);
3860 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003861 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3862 skip |= LogError(objlist, vuid,
3863 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003864 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003865 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003866 }
3867 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3868 LogObjectList objlist(cb_node->commandBuffer);
3869 objlist.add(src_image_state->image);
3870 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003871 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3872 skip |= LogError(objlist, vuid,
3873 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003874 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003875 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003876 }
3877 }
3878
3879 if (VK_IMAGE_TYPE_1D == src_image_type) {
3880 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3881 LogObjectList objlist(cb_node->commandBuffer);
3882 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003883 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3884 skip |= LogError(objlist, vuid,
3885 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003886 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003887 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3888 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003889 }
3890 }
3891 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3892 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3893 LogObjectList objlist(cb_node->commandBuffer);
3894 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003895 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3896 skip |= LogError(objlist, vuid,
3897 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003898 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003899 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3900 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003901 }
3902 }
3903
3904 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3905 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3906 LogObjectList objlist(cb_node->commandBuffer);
3907 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003908 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3909 skip |= LogError(objlist, vuid,
3910 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003911 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003912 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3913 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003914 }
3915 }
3916 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3917 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3918 LogObjectList objlist(cb_node->commandBuffer);
3919 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003920 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3921 skip |= LogError(objlist, vuid,
3922 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003923 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003924 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3925 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003926 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003927 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003928
3929 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3930 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3931 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3932 // developer
3933 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3934 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003935 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003936 LogObjectList objlist(cb_node->commandBuffer);
3937 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003938 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3939 skip |= LogError(objlist, vuid,
3940 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003941 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003942 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003943 region.extent.width, subresource_extent.width);
3944 }
3945
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003946 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003947 LogObjectList objlist(cb_node->commandBuffer);
3948 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003949 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3950 skip |= LogError(objlist, vuid,
3951 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003952 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003953 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003954 region.extent.height, subresource_extent.height);
3955 }
3956
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003957 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003958 LogObjectList objlist(cb_node->commandBuffer);
3959 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003960 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3961 skip |= LogError(objlist, vuid,
3962 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003963 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003964 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003965 region.extent.depth, subresource_extent.depth);
3966 }
3967 }
3968
3969 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3970 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3971 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3972 // developer
3973 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3974 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003975 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003976 LogObjectList objlist(cb_node->commandBuffer);
3977 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003978 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3979 skip |= LogError(objlist, vuid,
3980 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003981 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003982 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003983 region.extent.width, subresource_extent.width);
3984 }
3985
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003986 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003987 LogObjectList objlist(cb_node->commandBuffer);
3988 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003989 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3990 skip |= LogError(objlist, vuid,
3991 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003992 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003993 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003994 region.extent.height, subresource_extent.height);
3995 }
3996
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003997 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003998 LogObjectList objlist(cb_node->commandBuffer);
3999 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04004000 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
4001 skip |= LogError(objlist, vuid,
4002 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004003 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04004004 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004005 region.extent.depth, subresource_extent.depth);
4006 }
4007 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004008 }
4009
4010 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004011 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
4012 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
4013 func_name, string_VkFormat(src_image_state->createInfo.format),
4014 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004015 }
4016 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07004017 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04004018 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07004019 string_VkImageType(src_image_state->createInfo.imageType),
4020 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004021 }
4022 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004023 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
4024 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage sample count is VK_SAMPLE_COUNT_1_BIT.", func_name);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004025 }
4026 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004027 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
4028 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
4029 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004030 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004031 } else {
4032 assert(0);
4033 }
4034 return skip;
4035}
4036
Jeff Leger178b1e52020-10-05 12:22:23 -04004037bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4038 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4039 const VkImageResolve *pRegions) const {
4040 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
4041 COPY_COMMAND_VERSION_1);
4042}
4043
4044bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
4045 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
4046 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4047 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
4048 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
4049}
4050
4051template <typename RegionType>
4052bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4053 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4054 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004055 const auto *cb_node = GetCBState(commandBuffer);
4056 const auto *src_image_state = GetImageState(srcImage);
4057 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004058
Jeff Leger178b1e52020-10-05 12:22:23 -04004059 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
4060 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
4061 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
4062
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004063 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07004064 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004065 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07004066 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004067 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004068 const char *vuid;
4069 const char *location;
4070 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
4071 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
4072 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
4073 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4074 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
4075 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
4076 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
4077 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
4078 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
4079 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
4080 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
4081 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
4082 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
4083 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
4084 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
4085 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04004086 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04004087 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4088 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
4089 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4090 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
4091 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
4092 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
4093 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
4094 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
4095 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
4096 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004097
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004098 // Validation for VK_EXT_fragment_density_map
4099 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004100 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
4101 skip |= LogError(cb_node->commandBuffer, vuid,
4102 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4103 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004104 }
4105 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004106 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
4107 skip |= LogError(cb_node->commandBuffer, vuid,
4108 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4109 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004110 }
4111
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004112 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004113
Dave Houlton33c2d252017-06-09 17:08:32 -06004114 VkFormat src_format = src_image_state->createInfo.format;
4115 VkFormat dst_format = dst_image_state->createInfo.format;
4116 VkImageType src_type = src_image_state->createInfo.imageType;
4117 VkImageType dst_type = dst_image_state->createInfo.imageType;
4118
Cort Stratton186b1a22018-05-01 20:18:06 -04004119 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004120 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4121 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
4122 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004123 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004124 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004125 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04004126 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004127 }
4128
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004129 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004130 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
4131 skip |= LogError(device, vuid,
4132 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004133 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004134 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004135 }
4136
4137 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004138 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
4139 skip |= LogError(device, vuid,
4140 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004141 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004142 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004143 }
4144
Dave Houlton33c2d252017-06-09 17:08:32 -06004145 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004146 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
4147 skip |= LogError(cb_node->commandBuffer, vuid,
4148 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004149 }
4150
Dave Houlton33c2d252017-06-09 17:08:32 -06004151 // Validate consistency for unsigned formats
4152 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
4153 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004154 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004155 << "the other one must also have unsigned integer format. "
4156 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004157 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
4158 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004159 }
4160
4161 // Validate consistency for signed formats
4162 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
4163 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004164 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004165 << "the other one must also have signed integer format. "
4166 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004167 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
4168 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004169 }
4170
4171 // Validate filter for Depth/Stencil formats
4172 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4173 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004174 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004175 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04004176 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
4177 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004178 }
4179
4180 // Validate aspect bits and formats for depth/stencil images
4181 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4182 if (src_format != dst_format) {
4183 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004184 ss << func_name << ": If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06004185 << "stencil, the other one must have exactly the same format. "
4186 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4187 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004188 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
4189 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004190 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004191 } // Depth or Stencil
4192
4193 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004194 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004195 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4196 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4197 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
4198 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4199 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4200 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004201 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004202 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4203 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4204 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
4205 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4206 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4207 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004208 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004209 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004210 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004211 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004212 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004213 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4214 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004215 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004216 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4217 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4218 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4219 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4220 skip |=
4221 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4222 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4223 skip |=
4224 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4225 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004226 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004227 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4228 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004229 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004230 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004231 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004232 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4233 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004234 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004235 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004236 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004237 }
Dave Houlton48989f32017-05-26 15:01:46 -06004238 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4239 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004240 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004241 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004242 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004243 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004244
4245 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004246 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004247 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4248 skip |=
4249 LogError(cb_node->commandBuffer, vuid,
4250 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004251 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004252
Dave Houlton48989f32017-05-26 15:01:46 -06004253 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004254 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4255 skip |=
4256 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004257 }
Dave Houlton48989f32017-05-26 15:01:46 -06004258
Dave Houlton33c2d252017-06-09 17:08:32 -06004259 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004260 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
4261 skip |= LogError(cb_node->commandBuffer, vuid,
4262 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004263 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004264 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004265 }
4266
4267 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004268 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
4269 skip |= LogError(cb_node->commandBuffer, vuid,
4270 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4271 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004272 }
4273
Dave Houlton48989f32017-05-26 15:01:46 -06004274 // Validate source image offsets
4275 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004276 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004277 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004278 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
4279 skip |= LogError(cb_node->commandBuffer, vuid,
4280 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4281 "of (%1d, %1d). These must be (0, 1).",
4282 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004283 }
4284 }
4285
Dave Houlton33c2d252017-06-09 17:08:32 -06004286 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004287 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004288 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
4289 skip |= LogError(cb_node->commandBuffer, vuid,
4290 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4291 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4292 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004293 }
4294 }
4295
Dave Houlton33c2d252017-06-09 17:08:32 -06004296 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004297 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4298 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004299 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004300 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
4301 skip |= LogError(cb_node->commandBuffer, vuid,
4302 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4303 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004304 }
4305 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4306 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004307 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004308 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
4309 skip |= LogError(cb_node->commandBuffer, vuid,
4310 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4311 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004312 }
4313 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4314 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004315 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004316 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
4317 skip |= LogError(cb_node->commandBuffer, vuid,
4318 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4319 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004320 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004321 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004322 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4323 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4324 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004325 }
Dave Houlton48989f32017-05-26 15:01:46 -06004326
4327 // Validate dest image offsets
4328 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004329 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004330 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004331 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4332 skip |= LogError(cb_node->commandBuffer, vuid,
4333 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4334 "(%1d, %1d). These must be (0, 1).",
4335 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004336 }
4337 }
4338
Dave Houlton33c2d252017-06-09 17:08:32 -06004339 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004340 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004341 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4342 skip |= LogError(cb_node->commandBuffer, vuid,
4343 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004344 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004345 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004346 }
4347 }
4348
Dave Houlton33c2d252017-06-09 17:08:32 -06004349 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004350 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4351 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004352 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004353 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4354 skip |= LogError(cb_node->commandBuffer, vuid,
4355 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4356 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004357 }
4358 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4359 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004360 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004361 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4362 skip |= LogError(cb_node->commandBuffer, vuid,
4363 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4364 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004365 }
4366 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4367 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004368 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004369 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4370 skip |= LogError(cb_node->commandBuffer, vuid,
4371 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4372 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004373 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004374 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004375 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4376 skip |= LogError(cb_node->commandBuffer, vuid,
4377 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004378 }
4379
Dave Houlton33c2d252017-06-09 17:08:32 -06004380 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4381 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4382 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004383 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4384 skip |= LogError(cb_node->commandBuffer, vuid,
4385 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4386 "layerCount other than 1.",
4387 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004388 }
4389 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004390 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004391 } else {
4392 assert(0);
4393 }
4394 return skip;
4395}
4396
Jeff Leger178b1e52020-10-05 12:22:23 -04004397bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4398 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4399 const VkImageBlit *pRegions, VkFilter filter) const {
4400 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4401 COPY_COMMAND_VERSION_1);
4402}
4403
4404bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4405 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4406 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4407 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4408}
4409
4410template <typename RegionType>
4411void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4412 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4413 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004414 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004415 auto src_image_state = GetImageState(srcImage);
4416 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004417
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004418 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004419 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004420 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4421 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004422 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004423}
4424
Jeff Leger178b1e52020-10-05 12:22:23 -04004425void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4426 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4427 const VkImageBlit *pRegions, VkFilter filter) {
4428 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4429 pRegions, filter);
4430 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4431}
4432
4433void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4434 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4435 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4436 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4437 pBlitImageInfo->filter);
4438}
4439
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004440GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004441 // This approach allows for a single hash lookup or/create new
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004442 auto &layout_map = map[image_state.image];
John Zulauf17708d02021-02-22 11:20:58 -07004443 if (!layout_map) {
4444 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004445 }
John Zulauf17708d02021-02-22 11:20:58 -07004446 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004447}
4448
4449const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4450 auto it = map.find(image);
4451 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004452 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004453 }
4454 return nullptr;
4455}
4456
Jeremy Gebben53631302021-04-13 16:46:37 -06004457// Helper to update the Global or Overlay layout map
4458struct GlobalLayoutUpdater {
4459 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4460 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4461 dst = src.current_layout;
4462 return true;
4463 }
4464 return false;
4465 }
4466
4467 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4468 layer_data::optional<VkImageLayout> result;
4469 if (src.current_layout != image_layout_map::kInvalidLayout) {
4470 result.emplace(src.current_layout);
4471 }
4472 return result;
4473 }
4474};
4475
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004476// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
John Zulauf2076e812020-01-08 14:55:54 -07004477bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004478 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004479 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004480 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004481 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004482 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004483 for (const auto &layout_map_entry : pCB->image_layout_map) {
4484 const auto image = layout_map_entry.first;
4485 const auto *image_state = GetImageState(image);
4486 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004487 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004488 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004489 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004490 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004491
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004492 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004493 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4494 if (global_map == nullptr) {
4495 global_map = &empty_map;
4496 }
4497
4498 // Note: don't know if it would matter
4499 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4500
Jeremy Gebben53631302021-04-13 16:46:37 -06004501 auto pos = layout_map.begin();
4502 const auto end = layout_map.end();
4503 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4504 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004505 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004506 VkImageLayout initial_layout = pos->second.initial_layout;
4507 assert(initial_layout != image_layout_map::kInvalidLayout);
4508 if (initial_layout == image_layout_map::kInvalidLayout) {
4509 continue;
4510 }
4511
John Zulauf2076e812020-01-08 14:55:54 -07004512 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004513
John Zulauf2076e812020-01-08 14:55:54 -07004514 if (current_layout->range.empty()) break; // When we are past the end of data in overlay and global... stop looking
locke-lunargf155ccf2020-02-18 11:34:15 -07004515 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004516 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004517 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004518 image_layout = current_layout->pos_B->lower_bound->second;
4519 }
4520 const auto intersected_range = pos->first & current_layout->range;
4521 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4522 // TODO: Set memory invalid which is in mem_tracker currently
4523 } else if (image_layout != initial_layout) {
4524 // Need to look up the inital layout *state* to get a bit more information
4525 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4526 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4527 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4528 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004529 // We can report all the errors for the intersected range directly
4530 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004531 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004532 skip |= LogError(
4533 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004534 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004535 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004536 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004537 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004538 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004539 }
4540 }
John Zulauf2076e812020-01-08 14:55:54 -07004541 if (pos->first.includes(intersected_range.end)) {
4542 current_layout.seek(intersected_range.end);
4543 } else {
4544 ++pos;
4545 if (pos != end) {
4546 current_layout.seek(pos->first.begin);
4547 }
4548 }
John Zulauff660ad62019-03-23 07:16:05 -06004549 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004550 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004551 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004552 }
John Zulauff660ad62019-03-23 07:16:05 -06004553
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004554 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004555}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004556
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004557void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004558 for (const auto &layout_map_entry : pCB->image_layout_map) {
4559 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004560 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004561 const auto *image_state = GetImageState(image);
4562 if (!image_state) continue; // Can't set layouts of a dead image
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004563 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004564 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004565 }
4566}
4567
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004568// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004569// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4570// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004571bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4572 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004573 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004574 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004575 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4576
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004577 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004578 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4579 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004580 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004581 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4582 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4583 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004584 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004585 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004586 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004587 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4588 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4589 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004590 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004591 string_VkImageLayout(first_layout));
4592 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4593 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004594 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004595 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004596 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004597 }
4598 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004599
4600 // Same as above for loadOp, but for stencilLoadOp
4601 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4602 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4603 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4604 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4605 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004606 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004607 string_VkImageLayout(first_layout));
4608 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4609 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4610 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004611 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004612 string_VkImageLayout(first_layout));
4613 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4614 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4615 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004616 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004617 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004618 }
4619 }
4620
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004621 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004622}
4623
Mark Lobodzinski96210742017-02-09 10:33:46 -07004624// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4625// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004626template <typename T1>
4627bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4628 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4629 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004630 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004631 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004632 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004633 if (strict) {
4634 correct_usage = ((actual & desired) == desired);
4635 } else {
4636 correct_usage = ((actual & desired) != 0);
4637 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004638
Mark Lobodzinski96210742017-02-09 10:33:46 -07004639 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004640 // All callers should have a valid VUID
4641 assert(msgCode != kVUIDUndefined);
4642 skip =
4643 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4644 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004645 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004646 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004647}
4648
4649// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4650// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004651bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004652 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004653 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004654 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004655}
4656
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004657bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004658 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004659 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004660 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4661 if ((image_format_features & desired) != desired) {
4662 // Same error, but more details if it was an AHB external format
4663 if (image_state->has_ahb_format == true) {
4664 skip |= LogError(image_state->image, vuid,
4665 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4666 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4667 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004668 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004669 } else {
4670 skip |= LogError(image_state->image, vuid,
4671 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4672 "with tiling %s.",
4673 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4674 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4675 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004676 }
4677 }
4678 return skip;
4679}
4680
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004681bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004682 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004683 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004684 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004685 // layerCount must not be zero
4686 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004687 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4688 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004689 }
4690 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004691 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004692 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4693 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004694 }
4695 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004696 if ((apsect_mask & VK_IMAGE_ASPECT_COLOR_BIT) && (apsect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004697 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4698 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4699 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4700 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004701 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004702 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4703 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4704 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4705 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4706 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4707 member);
4708 }
Cort Strattond619a302018-05-17 19:46:32 -07004709 return skip;
4710}
4711
Mark Lobodzinski96210742017-02-09 10:33:46 -07004712// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4713// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004714bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004715 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004716 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004717 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004718}
4719
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004720bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004721 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004722 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004723
4724 const VkDeviceSize &range = pCreateInfo->range;
4725 if (range != VK_WHOLE_SIZE) {
4726 // Range must be greater than 0
4727 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004728 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004729 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004730 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4731 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004732 }
4733 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004734 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4735 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004736 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004737 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004738 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4739 "(%" PRIu32 ").",
4740 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004741 }
4742 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004743 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004744 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004745 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004746 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4747 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4748 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004749 }
4750 // The sum of range and offset must be less than or equal to the size of buffer
4751 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004752 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004753 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004754 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4755 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4756 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004757 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004758 } else {
4759 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4760
4761 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4762 // VkPhysicalDeviceLimits::maxTexelBufferElements
4763 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4764 device_limits->maxTexelBufferElements) {
4765 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4766 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4767 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4768 "), divided by the element size of the format (%" PRIu32
4769 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4770 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4771 device_limits->maxTexelBufferElements);
4772 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004773 }
4774 return skip;
4775}
4776
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004777bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004778 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004779 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004780 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4781 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004782 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004783 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004784 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4785 "be supported for uniform texel buffers",
4786 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004787 }
4788 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4789 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004790 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004791 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004792 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4793 "be supported for storage texel buffers",
4794 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004795 }
4796 return skip;
4797}
4798
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004799bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004800 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004801 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004802
Dave Houltond8ed0212018-05-16 17:18:24 -06004803 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004804
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004805 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004806 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004807 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004808 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004809 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4810 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004811 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004812 }
4813 }
4814
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004815 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004816 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004817 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004818 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004819 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004820 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4821 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004822 }
4823 }
4824
Mike Schuchardt2df08912020-12-15 16:28:09 -08004825 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004826 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4827 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004828 skip |= LogError(
4829 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004830 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004831 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004832 }
4833
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004834 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004835 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4836 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4837 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004838 }
4839
sfricke-samsungedce77a2020-07-03 22:35:13 -07004840 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4841 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4842 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4843 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4844 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4845 }
4846 const VkBufferCreateFlags invalid_flags =
4847 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4848 if ((pCreateInfo->flags & invalid_flags) != 0) {
4849 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4850 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4851 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4852 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4853 }
4854 }
4855
Mark Lobodzinski96210742017-02-09 10:33:46 -07004856 return skip;
4857}
4858
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004859bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004860 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004861 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004862 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004863 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4864 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004865 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004866 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4867 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004868 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004869 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4870 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4871 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004872
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004873 // Buffer view offset must be less than the size of buffer
4874 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004875 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004876 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004877 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4878 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004879 }
4880
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004881 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004882 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4883 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4884 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004885 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4886 : "VUID-VkBufferViewCreateInfo-offset-00926";
4887 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004888 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004889 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4890 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004891 }
4892
4893 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004894 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4895 if ((element_size % 3) == 0) {
4896 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004897 }
4898 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004899 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004900 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4901 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004902 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004903 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004904 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004905 skip |= LogError(
4906 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004907 "vkCreateBufferView(): If buffer was created with usage containing "
4908 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004909 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4910 ") must be a multiple of the lesser of "
4911 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4912 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4913 "(%" PRId32
4914 ") is VK_TRUE, the size of a texel of the requested format. "
4915 "If the size of a texel is a multiple of three bytes, then the size of a "
4916 "single component of format is used instead",
4917 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4918 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4919 }
4920 }
4921 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004922 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004923 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4924 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004925 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004926 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004927 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004928 skip |= LogError(
4929 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004930 "vkCreateBufferView(): If buffer was created with usage containing "
4931 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004932 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4933 ") must be a multiple of the lesser of "
4934 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4935 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4936 "(%" PRId32
4937 ") is VK_TRUE, the size of a texel of the requested format. "
4938 "If the size of a texel is a multiple of three bytes, then the size of a "
4939 "single component of format is used instead",
4940 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4941 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4942 }
4943 }
4944 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004945
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004946 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004947
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004948 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004949 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004950 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004951}
4952
Mark Lobodzinski602de982017-02-09 11:01:33 -07004953// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004954bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004955 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004956 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004957 const IMAGE_STATE *image_state = GetImageState(image);
4958 // checks color format and (single-plane or non-disjoint)
4959 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004960 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004961 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004962 skip |= LogError(
4963 image, vuid,
4964 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4965 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004966 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004967 skip |= LogError(image, vuid,
4968 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4969 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4970 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004971 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004972 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004973 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004974 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004975 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4976 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4977 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004978 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004979 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004980 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4981 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4982 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004983 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004984 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004985 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004986 skip |= LogError(image, vuid,
4987 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4988 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4989 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004990 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004991 skip |= LogError(image, vuid,
4992 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4993 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4994 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004995 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004996 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004997 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004998 skip |= LogError(image, vuid,
4999 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
5000 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5001 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005002 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005003 skip |= LogError(image, vuid,
5004 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
5005 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5006 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005007 }
Dave Houlton501b15b2018-03-30 15:07:41 -06005008 } else if (FormatIsMultiplane(format)) {
5009 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
5010 if (3 == FormatPlaneCount(format)) {
5011 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
5012 }
5013 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005014 skip |= LogError(image, vuid,
5015 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
5016 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
5017 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06005018 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005019 }
5020 return skip;
5021}
5022
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005023bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
5024 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005025 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
5026 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005027 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02005028
5029 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02005030 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005031 skip |= LogError(image, errorCodes.base_mip_err,
5032 "%s: %s.baseMipLevel (= %" PRIu32
5033 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
5034 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005035 }
Petr Kraus4d718682017-05-18 03:38:41 +02005036
Petr Krausffa94af2017-08-08 21:46:02 +02005037 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
5038 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005039 skip |=
5040 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005041 } else {
5042 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02005043
Petr Krausffa94af2017-08-08 21:46:02 +02005044 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005045 skip |= LogError(image, errorCodes.mip_count_err,
5046 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5047 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
5048 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
5049 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005050 }
Petr Kraus4d718682017-05-18 03:38:41 +02005051 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005052 }
Petr Kraus4d718682017-05-18 03:38:41 +02005053
5054 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02005055 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005056 skip |= LogError(image, errorCodes.base_layer_err,
5057 "%s: %s.baseArrayLayer (= %" PRIu32
5058 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5059 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005060 }
Petr Kraus4d718682017-05-18 03:38:41 +02005061
Petr Krausffa94af2017-08-08 21:46:02 +02005062 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5063 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005064 skip |=
5065 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005066 } else {
5067 const uint64_t necessary_layer_count =
5068 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005069
Petr Krausffa94af2017-08-08 21:46:02 +02005070 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005071 skip |= LogError(image, errorCodes.layer_count_err,
5072 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5073 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5074 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5075 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005076 }
Petr Kraus4d718682017-05-18 03:38:41 +02005077 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005078 }
Petr Kraus4d718682017-05-18 03:38:41 +02005079
Mark Lobodzinski602de982017-02-09 11:01:33 -07005080 return skip;
5081}
5082
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005083bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005084 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005085 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02005086 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08005087 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005088 bool is_3_d_to_2_d_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
Petr Krausffa94af2017-08-08 21:46:02 +02005089
David McFarland2853f2f2020-11-30 15:50:39 -04005090 uint32_t image_layer_count;
5091
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005092 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005093 const auto layers = LayersFromRange(subresourceRange);
5094 const auto extent = GetImageSubresourceExtent(image_state, &layers);
5095 image_layer_count = extent.depth;
5096 } else {
5097 image_layer_count = image_state->createInfo.arrayLayers;
5098 }
5099
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005100 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005101
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005102 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5103 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5104 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5105 subresource_range_error_codes.base_layer_err =
5106 is_khr_maintenance1
5107 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
5108 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
5109 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
5110 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5111 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
5112 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005113
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005114 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005115 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005116 image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005117}
5118
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005119bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005120 const VkImageSubresourceRange &subresourceRange,
5121 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005122 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5123 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5124 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5125 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5126 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005127
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005128 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005129 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005130 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005131}
5132
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005133bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005134 const VkImageSubresourceRange &subresourceRange,
5135 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005136 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5137 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5138 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5139 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5140 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005141
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005142 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005143 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005144 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005145}
5146
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005147bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005148 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005149 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005150 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image,
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005151 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005152}
5153
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005154namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005155using sync_vuid_maps::GetBarrierQueueVUID;
5156using sync_vuid_maps::kQueueErrorSummary;
5157using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005158
5159class ValidatorState {
5160 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005161 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005162 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5163 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005164 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005165 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005166 barrier_handle_(barrier_handle),
5167 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005168 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5169 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5170
5171 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5172 // One and two family versions, in the single family version, Vu holds the name of the passed parameter
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005173 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5174 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005175 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005176 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5177 loc_.Message().c_str(), GetTypeString(),
5178 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5179 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005180 }
5181
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005182 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5183 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005184 const char *src_annotation = GetFamilyAnnotation(src_family);
5185 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5186 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005187 objects_, val_code,
5188 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5189 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5190 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005191 }
5192
5193 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5194 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5195 // application input.
5196 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5197 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005198 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005199 uint32_t queue_family = queue_state->queueFamilyIndex;
5200 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005201 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005202 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5203 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5204 return device_data->LogError(
5205 queue_state->queue, val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005206 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005207 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005208 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005209 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005210 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005211 }
5212 return false;
5213 }
5214 // Logical helpers for semantic clarity
5215 inline bool KhrExternalMem() const { return mem_ext_; }
5216 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5217 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5218 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5219 }
5220
5221 // Helpers for LogMsg
5222 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5223
5224 // Descriptive text for the various types of queue family index
5225 const char *GetFamilyAnnotation(uint32_t family) const {
5226 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5227 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5228 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5229 const char *valid = " (VALID)";
5230 const char *invalid = " (INVALID)";
5231 switch (family) {
5232 case VK_QUEUE_FAMILY_EXTERNAL:
5233 return external;
5234 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5235 return foreign;
5236 case VK_QUEUE_FAMILY_IGNORED:
5237 return ignored;
5238 default:
5239 if (IsValid(family)) {
5240 return valid;
5241 }
5242 return invalid;
5243 };
5244 }
5245 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5246 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5247
5248 protected:
5249 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005250 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005251 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005252 const VulkanTypedHandle barrier_handle_;
5253 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005254 const uint32_t limit_;
5255 const bool mem_ext_;
5256};
5257
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005258bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005259 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5260 bool skip = false;
5261
5262 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5263 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5264 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5265 if (val.KhrExternalMem()) {
5266 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005267 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5268 // this requirement is removed by VK_KHR_synchronization2
5269 if (!(src_ignored || dst_ignored) && !sync2) {
5270 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005271 }
5272 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5273 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005274 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005275 }
5276 } else {
5277 // VK_SHARING_MODE_EXCLUSIVE
5278 if (src_queue_family != dst_queue_family) {
5279 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005280 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005281 }
5282 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005283 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005284 }
5285 }
5286 }
5287 } else {
5288 // No memory extension
5289 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005290 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5291 // this requirement is removed by VK_KHR_synchronization2
5292 if ((!src_ignored || !dst_ignored) && !sync2) {
5293 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005294 }
5295 } else {
5296 // VK_SHARING_MODE_EXCLUSIVE
5297 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005298 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005299 }
5300 }
5301 }
5302 return skip;
5303}
5304} // namespace barrier_queue_families
5305
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005306bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker *state_data,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005307 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005308 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5309 uint32_t dst_queue_family) {
5310 using barrier_queue_families::ValidatorState;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005311 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005312 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5313}
5314
5315// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005316template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005317bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5318 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005319 // State data is required
5320 if (!state_data) {
5321 return false;
5322 }
5323
5324 // Create the validator state from the image state
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005325 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer), loc,
5326 VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005327 state_data->createInfo.sharingMode);
5328 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5329 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005330 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005331}
5332
5333// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005334template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005335bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5336 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005337 // State data is required
5338 if (!state_data) {
5339 return false;
5340 }
5341
5342 // Create the validator state from the buffer state
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005343 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer), loc,
5344 VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer),
5345 state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005346 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5347 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005348 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5349}
5350
5351template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005352bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005353 const Barrier &mem_barrier) const {
5354 using sync_vuid_maps::BufferError;
5355 using sync_vuid_maps::GetBufferBarrierVUID;
5356
5357 bool skip = false;
5358
5359 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5360
5361 // Validate buffer barrier queue family indices
5362 auto buffer_state = GetBufferState(mem_barrier.buffer);
5363 if (buffer_state) {
5364 auto buf_loc = loc.dot(Field::buffer);
5365 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005366 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005367
5368 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5369
5370 auto buffer_size = buffer_state->createInfo.size;
5371 if (mem_barrier.offset >= buffer_size) {
5372 auto offset_loc = loc.dot(Field::offset);
5373 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5374
5375 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5376 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5377 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5378 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5379 auto size_loc = loc.dot(Field::size);
5380 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5381 skip |= LogError(objects, vuid,
5382 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5383 ".",
5384 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5385 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5386 }
5387 if (mem_barrier.size == 0) {
5388 auto size_loc = loc.dot(Field::size);
5389 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5390 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5391 report_data->FormatHandle(mem_barrier.buffer).c_str());
5392 }
5393 }
5394 return skip;
5395}
5396
5397template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005398bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005399 const Barrier &mem_barrier) const {
5400 bool skip = false;
5401
5402 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5403
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005404 bool is_ilt = true;
5405 if (enabled_features.synchronization2_features.synchronization2) {
5406 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5407 }
5408
5409 if (is_ilt) {
5410 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5411 auto layout_loc = loc.dot(Field::newLayout);
5412 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5413 skip |=
5414 LogError(cb_state->commandBuffer, vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005415 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005416 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005417 }
5418
5419 auto image_data = GetImageState(mem_barrier.image);
5420 if (image_data) {
5421 auto image_loc = loc.dot(Field::image);
5422
John Zulaufbea70432021-02-23 07:03:12 -07005423 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005424
5425 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5426
Jeremy Gebbenb1c48512021-02-22 17:34:28 -07005427 skip |= ValidateImageAspectMask(image_data->image, image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005428 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005429
5430 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
5431 }
5432 return skip;
5433}
5434
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005435bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5436 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5437 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005438 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5439 const VkImageMemoryBarrier *pImageMemBarriers) const {
5440 bool skip = false;
5441 auto queue_flags = GetQueueFlags(*cb_state);
5442 LogObjectList objects(cb_state->commandBuffer);
5443 auto op_type =
5444 ComputeBarrierOperationsType(cb_state, bufferBarrierCount, pBufferMemBarriers, imageMemBarrierCount, pImageMemBarriers);
5445
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005446 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5447 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005448 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005449 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5450 }
5451 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5452 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005453 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005454 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005455 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5456 }
5457 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005458 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005459 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5460 }
5461 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5462 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005463 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005464 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005465 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5466 }
5467 return skip;
5468}
5469
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005470bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
5471 BarrierOperationsType op_type, const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005472 bool skip = false;
5473
5474 if (cb_state->activeRenderPass) {
5475 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5476 if (skip) return true; // Early return to avoid redundant errors from below calls
5477 }
5478 auto queue_flags = GetQueueFlags(*cb_state);
5479 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5480 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005481 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005482 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5483 }
5484 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5485 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005486 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005487 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5488 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5489 }
5490 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005491 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005492 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5493 }
5494
5495 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5496 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005497 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005498 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5499 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5500 }
5501
5502 return skip;
5503}
5504
5505template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005506bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, BarrierOperationsType op_type,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005507 VkQueueFlags queue_flags, const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
5508 VkPipelineStageFlags dst_stage_mask) const {
5509 bool skip = false;
5510 if (op_type == kAllRelease || op_type == kGeneral) {
5511 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5512 }
5513 if (op_type == kAllAcquire || op_type == kGeneral) {
5514 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5515 }
5516 return skip;
5517}
5518
5519template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005520bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, BarrierOperationsType op_type,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005521 VkQueueFlags queue_flags, const Barrier &barrier) const {
5522 bool skip = false;
5523 if (op_type == kAllRelease || op_type == kGeneral) {
5524 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
5525 skip |=
5526 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5527 }
5528 if (op_type == kAllAcquire || op_type == kGeneral) {
5529 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
5530 skip |=
5531 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5532 }
5533 return skip;
5534}
5535
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005536bool CoreChecks::ValidateSubpassBarrier(const LogObjectList &objects, const Location &loc, VkQueueFlags queue_flags,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005537 const VkSubpassDependency2 &barrier) const {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005538 bool skip = false;
5539 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(barrier.pNext);
5540 if (mem_barrier) {
5541 if (enabled_features.synchronization2_features.synchronization2) {
5542 if (barrier.srcAccessMask != 0) {
5543 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5544 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5545 loc.dot(Field::srcAccessMask).Message().c_str());
5546 }
5547 if (barrier.dstAccessMask != 0) {
5548 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5549 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5550 loc.dot(Field::dstAccessMask).Message().c_str());
5551 }
5552 if (barrier.srcStageMask != 0 || barrier.dstStageMask != 0) {
5553 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5554 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5555 loc.dot(Field::srcStageMask).Message().c_str());
5556 }
5557 if (barrier.dstStageMask != 0) {
5558 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5559 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5560 loc.dot(Field::dstStageMask).Message().c_str());
5561 }
5562
5563 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc.dot(Field::pNext), kGeneral, queue_flags, *mem_barrier);
5564 return skip;
5565 } else {
5566 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5567 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5568 loc.Message().c_str());
5569 }
5570 }
5571 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc, kGeneral, queue_flags, barrier);
5572 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005573}
5574
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005575bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5576 const VkImageUsageFlags image_usage) const {
5577 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5578 bool skip = false;
5579
5580 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5581 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5582
5583 if (image_state->has_ahb_format == true) {
5584 // AHB image view and image share same feature sets
5585 tiling_features = image_state->format_features;
5586 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5587 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
5588 assert(device_extensions.vk_ext_image_drm_format_modifier);
5589 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5590 nullptr};
5591 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
5592
5593 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5594 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5595 nullptr};
5596 format_properties_2.pNext = (void *)&drm_properties_list;
5597 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5598
nyorain38a9d232021-03-06 13:06:12 +01005599 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5600 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5601 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5602
5603 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5604
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005605 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5606 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5607 0) {
5608 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5609 }
5610 }
5611 } else {
5612 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5613 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5614 : format_properties.optimalTilingFeatures;
5615 }
5616
5617 if (tiling_features == 0) {
5618 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
5619 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5620 "physical device.",
5621 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5622 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
5623 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
5624 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5625 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5626 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5627 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
5628 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
5629 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5630 "VK_IMAGE_USAGE_STORAGE_BIT.",
5631 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5632 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
5633 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
5634 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5635 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5636 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5637 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5638 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
5639 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
5640 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5641 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5642 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5643 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5644 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
5645 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
5646 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5647 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5648 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005649 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5650 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5651 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5652 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-04550",
5653 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5654 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5655 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5656 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005657 }
5658
5659 return skip;
5660}
5661
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005662bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005663 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005664 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005665 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005666 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005667 skip |=
5668 ValidateImageUsageFlags(image_state,
5669 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5670 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005671 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5672 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5673 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005674 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005675 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005676 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005677 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005678 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005679 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005680 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005681 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005682
5683 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5684 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005685 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005686 VkFormat view_format = pCreateInfo->format;
5687 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005688 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005689 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005690
Dave Houltonbd2e2622018-04-10 16:41:14 -06005691 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005692 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005693 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005694 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005695 if (!device_extensions.vk_ext_separate_stencil_usage) {
5696 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005697 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5698 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5699 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005700 }
5701 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005702 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005703 if (image_stencil_struct == nullptr) {
5704 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005705 skip |= LogError(
5706 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005707 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5708 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5709 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5710 }
5711 } else {
5712 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5713 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5714 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005715 skip |= LogError(
5716 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005717 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5718 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5719 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5720 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5721 }
5722 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5723 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005724 skip |= LogError(
5725 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005726 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5727 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5728 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5729 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5730 }
5731 }
5732 }
5733 }
5734
Dave Houltonbd2e2622018-04-10 16:41:14 -06005735 image_usage = chained_ivuci_struct->usage;
5736 }
5737
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005738 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5739 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5740 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5741 bool foundFormat = false;
5742 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5743 if (format_list_info->pViewFormats[i] == view_format) {
5744 foundFormat = true;
5745 break;
5746 }
5747 }
5748 if (foundFormat == false) {
5749 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5750 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5751 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5752 string_VkFormat(view_format));
5753 }
5754 }
5755
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005756 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5757 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005758 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005759 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005760 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005761 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005762 std::stringstream ss;
5763 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005764 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005765 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005766 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005767 }
5768 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005769 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005770 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
sfricke-samsung9a65d282021-03-17 23:41:59 -07005771 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5772 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5773 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5774 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005775 const char *error_vuid;
5776 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5777 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5778 } else if ((device_extensions.vk_khr_maintenance2) &&
5779 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5780 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5781 } else if ((!device_extensions.vk_khr_maintenance2) &&
5782 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5783 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5784 } else {
5785 // both enabled
5786 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5787 }
Dave Houltonc7988072018-04-16 11:46:56 -06005788 std::stringstream ss;
5789 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005790 << " is not in the same format compatibility class as "
5791 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005792 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5793 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005794 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005795 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005796 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005797 }
5798 } else {
5799 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005800 // Unless it is a multi-planar color bit aspect
5801 if ((image_format != view_format) &&
5802 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5803 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5804 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005805 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005806 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005807 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005808 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005809 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005810 }
5811 }
5812
5813 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005814 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005815
5816 switch (image_type) {
5817 case VK_IMAGE_TYPE_1D:
5818 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005819 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5820 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5821 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005822 }
5823 break;
5824 case VK_IMAGE_TYPE_2D:
5825 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5826 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5827 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005828 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5829 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5830 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005831 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005832 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5833 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5834 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005835 }
5836 }
5837 break;
5838 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005839 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005840 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5841 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005842 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005843 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005844 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5845 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5846 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005847 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5848 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005849 skip |= LogError(
5850 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5851 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5852 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5853 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5854 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005855 }
5856 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005857 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5858 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5859 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005860 }
5861 }
5862 } else {
5863 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005864 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5865 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5866 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005867 }
5868 }
5869 break;
5870 default:
5871 break;
5872 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005873
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005874 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005875 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005876 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005877 }
5878
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005879 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005880
Tobias Hector6663c9b2020-11-05 10:18:02 +00005881 if (enabled_features.shading_rate_image.shadingRateImage) {
5882 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5883 if (view_format != VK_FORMAT_R8_UINT) {
5884 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5885 "vkCreateImageView() If image was created with usage containing "
5886 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5887 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005888 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005889 }
5890
5891 if (enabled_features.shading_rate_image.shadingRateImage ||
5892 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5893 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5894 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5895 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5896 "vkCreateImageView() If image was created with usage containing "
5897 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5898 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5899 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005900 }
5901 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005902
Tobias Hector6663c9b2020-11-05 10:18:02 +00005903 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5904 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5905 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5906 pCreateInfo->subresourceRange.layerCount != 1) {
5907 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5908 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5909 pCreateInfo->subresourceRange.layerCount);
5910 }
5911
Jeff Bolz99e3f632020-03-24 22:59:22 -05005912 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5913 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5914 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5915 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5916 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5917 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5918 }
5919 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5920 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5921 skip |= LogError(
5922 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5923 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5924 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5925 }
5926 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005927
5928 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5929 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005930 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005931 "vkCreateImageView(): If image was created with usage containing "
5932 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5933 pCreateInfo->subresourceRange.levelCount);
5934 }
5935 }
5936 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5937 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005938 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005939 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5940 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5941 }
5942 } else {
5943 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5944 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5945 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005946 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005947 "vkCreateImageView(): If image was created with usage containing "
5948 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5949 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5950 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5951 }
5952 }
5953 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005954
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005955 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5956 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5957 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5958 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5959 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5960 }
5961 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5962 skip |=
5963 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5964 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5965 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5966 }
5967 }
5968 if (device_extensions.vk_ext_fragment_density_map_2) {
5969 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5970 (pCreateInfo->subresourceRange.layerCount >
5971 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5972 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5973 "vkCreateImageView(): If image was created with flags containing "
5974 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5975 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5976 pCreateInfo->subresourceRange.layerCount,
5977 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5978 }
5979 }
5980
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005981 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005982 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5983 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5984 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5985 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5986 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5987 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5988 }
5989 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005990
5991 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5992 // If swizzling is disabled, make sure it isn't used
5993 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5994 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5995 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5996 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5997 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5998 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5999 "vkCreateImageView (portability error): swizzle is disabled for this device.");
6000 }
6001
6002 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
6003 // disabled
6004 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
6005 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
6006 // spec. See Github issue #2361.
6007 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
6008 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
6009 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
6010 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
6011 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
6012 "vkCreateImageView (portability error): ImageView format must have"
6013 " the same number of components and bits per component as the Image's format");
6014 }
6015 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006016 }
6017 return skip;
6018}
6019
Jeff Leger178b1e52020-10-05 12:22:23 -04006020template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006021bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04006022 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006023 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006024 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6025 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
6026 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006027
6028 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
6029 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
6030 VkDeviceSize src_min = UINT64_MAX;
6031 VkDeviceSize src_max = 0;
6032 VkDeviceSize dst_min = UINT64_MAX;
6033 VkDeviceSize dst_max = 0;
6034
6035 for (uint32_t i = 0; i < regionCount; i++) {
6036 src_min = std::min(src_min, pRegions[i].srcOffset);
6037 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
6038 dst_min = std::min(dst_min, pRegions[i].dstOffset);
6039 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
6040
6041 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
6042 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006043 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
6044 skip |= LogError(src_buffer_state->buffer, vuid,
6045 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
6046 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006047 }
6048
6049 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
6050 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006051 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
6052 skip |= LogError(dst_buffer_state->buffer, vuid,
6053 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
6054 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006055 }
6056
6057 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
6058 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006059 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
6060 skip |= LogError(src_buffer_state->buffer, vuid,
6061 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006062 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006063 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006064 }
6065
6066 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
6067 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006068 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
6069 skip |= LogError(dst_buffer_state->buffer, vuid,
6070 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006071 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006072 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006073 }
6074 }
6075
6076 // The union of the source regions, and the union of the destination regions, must not overlap in memory
6077 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
6078 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006079 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6080 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
6081 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006082 }
6083 }
6084
6085 return skip;
6086}
6087
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006088bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006089 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006090 const auto cb_node = GetCBState(commandBuffer);
6091 const auto src_buffer_state = GetBufferState(srcBuffer);
6092 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006093
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006094 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006095 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
6096 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006097 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06006098 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006099 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
6100 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06006101 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006102 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
6103 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006104 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Jeff Leger178b1e52020-10-05 12:22:23 -04006105 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07006106 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
6107 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
6108 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006109 return skip;
6110}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006111
Jeff Leger178b1e52020-10-05 12:22:23 -04006112bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6113 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
6114 const auto cb_node = GetCBState(commandBuffer);
6115 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
6116 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
6117
6118 bool skip = false;
6119 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
6120 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
6121 // Validate that SRC & DST buffers have correct usage flags set
6122 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
6123 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
6124 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6125 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
6126 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
6127 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006128 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
Jeff Leger178b1e52020-10-05 12:22:23 -04006129 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
6130 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
6131 skip |=
6132 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
6133 skip |=
6134 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
6135 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
6136 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
6137 return skip;
6138}
6139
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006140bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006141 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006142 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006143 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006144 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006145 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6146 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006147 }
6148 }
6149 return skip;
6150}
6151
Jeff Bolz5c801d12019-10-09 10:38:45 -05006152bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6153 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006154 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06006155 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006156
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006157 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006158 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006159 skip |=
6160 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006161 }
6162 return skip;
6163}
6164
Jeff Bolz5c801d12019-10-09 10:38:45 -05006165bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006166 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006167
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006168 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006169 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006170 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006171 }
6172 return skip;
6173}
6174
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006175bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006176 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006177 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06006178 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006179 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006180 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006181 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006182 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006183 }
6184 return skip;
6185}
6186
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006187bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006188 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006189 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006190 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006191 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006192 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006193 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006194 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006195 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6196 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006197
sfricke-samsung022fa252020-07-24 03:26:16 -07006198 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6199 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6200
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006201 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006202 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6203 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6204 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6205 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006206 }
6207
6208 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006209 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6210 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6211 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6212 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006213 }
6214
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006215 return skip;
6216}
6217
Jeff Leger178b1e52020-10-05 12:22:23 -04006218template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006219bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006220 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006221 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006222 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006223 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6224 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006225
sfricke-samsung125d2b42020-05-28 06:32:43 -07006226 assert(image_state != nullptr);
6227 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006228
6229 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006230 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006231 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6232 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006233 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006234 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6235 "and 1, respectively.",
6236 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006237 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006238 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006239
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006240 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6241 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006242 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006243 "%s: pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006244 "must be 0 and 1, respectively.",
6245 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006246 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006247 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006248
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006249 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6250 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006251 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006252 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006253 "For 3D images these must be 0 and 1, respectively.",
6254 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006255 }
6256 }
6257
6258 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006259 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08006260 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
6261 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006262
sfricke-samsung8feecc12021-01-23 03:28:38 -08006263 if (FormatIsDepthOrStencil(image_format)) {
6264 if (SafeModulo(bufferOffset, 4) != 0) {
6265 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
6266 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6267 " must be a multiple 4 if using a depth/stencil format (%s).",
6268 function, i, bufferOffset, string_VkFormat(image_format));
6269 }
6270 } else {
6271 // If not depth/stencil and not multi-plane
6272 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
6273 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
6274 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6275 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
6276 skip |= LogError(image_state->image, vuid,
6277 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6278 " must be a multiple of this format's texel size (%" PRIu32 ").",
6279 function, i, bufferOffset, element_size);
6280 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006281 }
6282
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006283 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6284 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006285 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006286 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006287 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006288 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006289 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006290 }
6291
6292 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6293 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006294 vuid =
6295 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006296 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006297 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006298 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6299 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006300 }
6301
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006302 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006303 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006304 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006305 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006306 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6307 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006308 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006309 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006310 "zero or <= image subresource width (%d).",
6311 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006312 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006313 }
6314
6315 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006316 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006317 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6318 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006319 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006320 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006321 "zero or <= image subresource height (%d).",
6322 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006323 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006324 }
6325
6326 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006327 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006328 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6329 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006330 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006331 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006332 "zero or <= image subresource depth (%d).",
6333 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006334 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006335 }
6336
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006337 // subresource aspectMask must have exactly 1 bit set
6338 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006339 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006340 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006341 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
6342 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006343 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006344 }
6345
6346 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006347 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006348 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006349 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006350 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6351 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006352 }
6353
6354 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006355 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6356 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006357
6358 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006359 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006360 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006361 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006362 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
6363 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006364 }
6365
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006366 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006367 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006368 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006369 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006370 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006371 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006372 }
6373
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006374 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006375 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6376 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6377 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006378 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006379 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006380 "width & height (%d, %d)..",
6381 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6382 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006383 }
6384
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006385 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07006386 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006387 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006388 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006389 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006390 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006391 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006392 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006393
6394 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07006395 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06006396 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006397 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006398 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006399 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006400 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
6401 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6402 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006403 }
6404
6405 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006406 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006407 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006408 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006409 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006410 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
6411 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6412 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006413 }
6414
6415 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006416 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006417 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006418 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006419 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006420 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
6421 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6422 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006423 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006424 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006425
6426 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006427 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006428 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006429 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006430 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006431 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006432 "format has three planes.",
6433 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006434 }
6435
6436 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006437 if (0 ==
6438 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006439 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006440 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006441 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6442 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006443 } else {
6444 // Know aspect mask is valid
6445 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6446 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006447 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006448 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006449 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006450 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006451 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006452 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006453 string_VkFormat(compatible_format));
6454 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006455 }
6456 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006457
6458 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6459 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6460 assert(command_pool != nullptr);
6461 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6462 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6463 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
6464 LogObjectList objlist(cb_node->commandBuffer);
6465 objlist.add(command_pool->commandPool);
6466 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
6467 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6468 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6469 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6470 "VK_QUEUE_COMPUTE_BIT flag.",
6471 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6472 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6473 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006474 }
6475
6476 return skip;
6477}
6478
Jeff Leger178b1e52020-10-05 12:22:23 -04006479template <typename BufferImageCopyRegionType>
6480bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6481 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006482 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006483 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006484
6485 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006486 VkExtent3D extent = pRegions[i].imageExtent;
6487 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006488
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006489 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6490 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006491 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
6492 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6493 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006494 }
6495
6496 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
6497
6498 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
unknown948b6ba2019-09-19 17:32:54 -06006499 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006500 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006501 if (image_extent.width % block_extent.width) {
6502 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6503 }
6504 if (image_extent.height % block_extent.height) {
6505 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6506 }
6507 if (image_extent.depth % block_extent.depth) {
6508 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6509 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006510 }
6511
Dave Houltonfc1a4052017-04-27 14:32:45 -06006512 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006513 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006514 }
6515 }
6516
6517 return skip;
6518}
6519
Jeff Leger178b1e52020-10-05 12:22:23 -04006520template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006521bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006522 const BufferImageCopyRegionType *pRegions, const char *func_name,
6523 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006524 bool skip = false;
6525
6526 VkDeviceSize buffer_size = buff_state->createInfo.size;
6527
6528 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07006529 VkDeviceSize max_buffer_offset =
6530 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
6531 if (buffer_size < max_buffer_offset) {
6532 skip |=
6533 LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006534 }
6535 }
6536
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006537 return skip;
6538}
6539
Jeff Leger178b1e52020-10-05 12:22:23 -04006540template <typename BufferImageCopyRegionType>
6541bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6542 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6543 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006544 const auto cb_node = GetCBState(commandBuffer);
6545 const auto src_image_state = GetImageState(srcImage);
6546 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006547
Jeff Leger178b1e52020-10-05 12:22:23 -04006548 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6549 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
6550 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
6551 const char *vuid;
6552
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006553 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006554
6555 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006556 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006557
6558 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006559 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006560
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006561 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006562
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006563 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006564 vuid =
6565 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6566 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6567 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6568 "or transfer capabilities.",
6569 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006570 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006571 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
6572 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6573 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6574 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006575
Jeff Leger178b1e52020-10-05 12:22:23 -04006576 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6577 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6578 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6579
6580 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6581 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6582 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6583 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006584
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006585 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006586 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6587 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006588 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006589 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6590 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006591 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006592 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6593 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6594 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6595 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6596 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6597 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006598
6599 // Validation for VK_EXT_fragment_density_map
6600 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006601 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
6602 skip |= LogError(cb_node->commandBuffer, vuid,
6603 "%s: srcImage must not have been created with flags containing "
6604 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6605 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006606 }
6607
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006608 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006609 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6610 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006611 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006612 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006613
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006614 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Jeff Leger178b1e52020-10-05 12:22:23 -04006615 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6616 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6617 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6618 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
6619
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006620 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006621 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6622 vuid =
6623 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006624 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006625 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6626 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6627 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6628 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6629 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6630 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6631 "imageSubresource", vuid);
6632 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6633 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006634 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006635 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006636 }
6637 return skip;
6638}
6639
Jeff Leger178b1e52020-10-05 12:22:23 -04006640bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6641 VkBuffer dstBuffer, uint32_t regionCount,
6642 const VkBufferImageCopy *pRegions) const {
6643 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6644 COPY_COMMAND_VERSION_1);
6645}
6646
6647bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6648 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6649 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6650 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6651 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6652}
6653
John Zulauf1686f232019-07-09 16:27:11 -06006654void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6655 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6656 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6657
6658 auto cb_node = GetCBState(commandBuffer);
6659 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006660 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006661 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006662 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006663 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006664}
6665
Jeff Leger178b1e52020-10-05 12:22:23 -04006666void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6667 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6668 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6669
6670 auto cb_node = GetCBState(commandBuffer);
6671 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6672 // Make sure that all image slices record referenced layout
6673 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6674 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6675 pCopyImageToBufferInfo->srcImageLayout);
6676 }
6677}
6678
6679template <typename RegionType>
6680bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6681 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6682 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006683 const auto cb_node = GetCBState(commandBuffer);
6684 const auto src_buffer_state = GetBufferState(srcBuffer);
6685 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006686
Jeff Leger178b1e52020-10-05 12:22:23 -04006687 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6688 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
6689 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
6690 const char *vuid;
6691
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006692 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006693
6694 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006695 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006696
Jeff Leger178b1e52020-10-05 12:22:23 -04006697 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
6698 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6699 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6700 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6701
6702 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6703 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6704 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6705 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6706 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6707 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6708 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6709 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6710 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006711 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006712 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6713 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006714 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006715 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6716 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6717 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6718 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6719 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6720 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006721
6722 // Validation for VK_EXT_fragment_density_map
6723 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006724 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
6725 skip |= LogError(cb_node->commandBuffer, vuid,
6726 "%s: dstImage must not have been created with flags containing "
6727 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6728 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006729 }
6730
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006731 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006732 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6733 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006734 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006735 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006736
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006737 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Jeff Leger178b1e52020-10-05 12:22:23 -04006738 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6739 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6740 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6741 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6742
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006743 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006744 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6745 vuid =
6746 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006747 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006748 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6749 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6750 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6751 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6752 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6753 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6754 "imageSubresource", vuid);
6755 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6756 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006757 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006758 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006759
6760 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6761 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6762 assert(command_pool != nullptr);
6763 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6764 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6765 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6766 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6767 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
6768 LogObjectList objlist(cb_node->commandBuffer);
6769 objlist.add(command_pool->commandPool);
6770 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6771 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
6772 skip |= LogError(dst_image_state->image, vuid,
6773 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6774 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6775 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
6776 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6777 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6778 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006779 }
6780 return skip;
6781}
6782
Jeff Leger178b1e52020-10-05 12:22:23 -04006783bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6784 VkImageLayout dstImageLayout, uint32_t regionCount,
6785 const VkBufferImageCopy *pRegions) const {
6786 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6787 COPY_COMMAND_VERSION_1);
6788}
6789
6790bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6791 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6792 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6793 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6794 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6795}
6796
John Zulauf1686f232019-07-09 16:27:11 -06006797void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6798 VkImageLayout dstImageLayout, uint32_t regionCount,
6799 const VkBufferImageCopy *pRegions) {
6800 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6801
6802 auto cb_node = GetCBState(commandBuffer);
6803 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006804 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006805 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006806 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006807 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006808}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006809
Jeff Leger178b1e52020-10-05 12:22:23 -04006810void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6811 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6812 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6813
6814 auto cb_node = GetCBState(commandBuffer);
6815 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6816 // Make sure that all image slices are record referenced layout
6817 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6818 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6819 pCopyBufferToImageInfo2KHR->dstImageLayout);
6820 }
6821}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006822bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006823 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006824 bool skip = false;
6825 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6826
Dave Houlton1d960ff2018-01-19 12:17:05 -07006827 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006828 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6829 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6830 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006831 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6832 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006833 }
6834
John Zulaufa26d3c82019-08-14 16:09:08 -06006835 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006836 if (!image_entry) {
6837 return skip;
6838 }
6839
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006840 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6841 if (device_extensions.vk_ext_image_drm_format_modifier) {
6842 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6843 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006844 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6845 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6846 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006847 }
6848 } else {
6849 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006850 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6851 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006852 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006853 }
6854
Dave Houlton1d960ff2018-01-19 12:17:05 -07006855 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006856 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006857 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6858 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6859 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006860 }
6861
Dave Houlton1d960ff2018-01-19 12:17:05 -07006862 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006863 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006864 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6865 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6866 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006867 }
6868
Dave Houlton1d960ff2018-01-19 12:17:05 -07006869 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006870 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006871 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6872 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006873 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006874 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6875 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006876 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006877 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6878 }
6879 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006880 skip |= LogError(image, vuid,
6881 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6882 ") must be a single-plane specifier flag.",
6883 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006884 }
6885 } else if (FormatIsColor(img_format)) {
6886 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006887 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6888 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6889 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006890 }
6891 } else if (FormatIsDepthOrStencil(img_format)) {
6892 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6893 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006894 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006895 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6896 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6897 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6898 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006899 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6900 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6901 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006902 }
6903 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006904
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006905 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006906 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006907 }
6908
Mike Weiblen672b58b2017-02-21 14:32:53 -07006909 return skip;
6910}
sfricke-samsung022fa252020-07-24 03:26:16 -07006911
6912// Validates the image is allowed to be protected
6913bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006914 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006915 bool skip = false;
6916 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6917 LogObjectList objlist(cb_state->commandBuffer);
6918 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006919 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image.%s", cmd_name,
sfricke-samsung022fa252020-07-24 03:26:16 -07006920 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006921 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006922 }
6923 return skip;
6924}
6925
6926// Validates the image is allowed to be unprotected
6927bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006928 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006929 bool skip = false;
6930 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6931 LogObjectList objlist(cb_state->commandBuffer);
6932 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006933 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image.%s", cmd_name,
sfricke-samsung022fa252020-07-24 03:26:16 -07006934 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006935 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006936 }
6937 return skip;
6938}
6939
6940// Validates the buffer is allowed to be protected
6941bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006942 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006943 bool skip = false;
6944 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6945 LogObjectList objlist(cb_state->commandBuffer);
6946 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006947 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer.%s", cmd_name,
sfricke-samsung022fa252020-07-24 03:26:16 -07006948 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006949 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006950 }
6951 return skip;
6952}
6953
6954// Validates the buffer is allowed to be unprotected
6955bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006956 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006957 bool skip = false;
6958 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6959 LogObjectList objlist(cb_state->commandBuffer);
6960 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006961 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer.%s", cmd_name,
sfricke-samsung022fa252020-07-24 03:26:16 -07006962 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006963 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006964 }
6965 return skip;
6966}