blob: 4ce992e43235c66941ad4cb29cf4889616c64232 [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
unknown08c57af2019-06-21 16:33:35 -0600246 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600247 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700248 uint32_t *queue_family_indices = new uint32_t[createInfo.queueFamilyIndexCount];
John Zulauff660ad62019-03-23 07:16:05 -0600249 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700250 queue_family_indices[i] = pCreateInfo->pQueueFamilyIndices[i];
John Zulauff660ad62019-03-23 07:16:05 -0600251 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700252 createInfo.pQueueFamilyIndices = queue_family_indices;
John Zulauff660ad62019-03-23 07:16:05 -0600253 }
254
255 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
256 sparse = true;
257 }
Locked8af3732019-05-10 09:47:56 -0600258
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700259 auto *external_memory_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700260 if (external_memory_info) {
261 external_memory_handle = external_memory_info->handleTypes;
sfricke-samsunge2441192019-11-06 14:07:57 -0800262 }
John Zulauff660ad62019-03-23 07:16:05 -0600263}
264
unknown2c877272019-07-11 12:56:50 -0600265bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
266 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
267 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
268 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
269 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
270 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
271 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600272 return is_equal &&
273 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600274}
275
Jeff Bolz82f854d2019-09-17 14:56:47 -0500276// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
277bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
278 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
279 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
280 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
281 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
282 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600283 is_compatible = is_compatible &&
284 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
285 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500286
287 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
288 createInfo.extent.height <= other_createInfo.extent.height &&
289 createInfo.extent.depth <= other_createInfo.extent.depth &&
290 createInfo.arrayLayers <= other_createInfo.arrayLayers;
291 return is_compatible;
292}
293
unknown2c877272019-07-11 12:56:50 -0600294bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700295 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700296 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700297 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700298 }
locke-lunarg5f59e782019-12-19 10:32:23 -0700299 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
300 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600301 IsCreateInfoEqual(other_image_state->createInfo)) {
302 return true;
303 }
unknowne1661522019-07-11 13:04:18 -0600304 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
305 return true;
306 }
unknown2c877272019-07-11 12:56:50 -0600307 return false;
308}
309
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500310IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
311 : image_view(iv),
312 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700313 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600314 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500315 samplerConversion(VK_NULL_HANDLE),
316 image_state(im) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700317 auto *conversion_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700318 if (conversion_info) samplerConversion = conversion_info->conversion;
John Zulauff660ad62019-03-23 07:16:05 -0600319 if (image_state) {
320 // A light normalization of the createInfo range
321 auto &sub_res_range = create_info.subresourceRange;
322 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
323 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
324
325 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700326 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500327 samples = image_state->createInfo.samples;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200328
329 if (image_state->has_ahb_format) {
330 // When the image has a external format the views format must be VK_FORMAT_UNDEFINED and it is required to use a sampler
331 // Ycbcr conversion. Thus we can't extract any meaningful information from the format parameter. As a Sampler Ycbcr
332 // conversion must be used the shader type is always float.
333 descriptor_format_bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
334 } else {
335 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
336 }
John Zulauff660ad62019-03-23 07:16:05 -0600337 }
338}
339
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700340static VkImageLayout NormalizeImageLayout(VkImageLayout layout, VkImageLayout non_normal, VkImageLayout normal) {
341 return (layout == non_normal) ? normal : layout;
342}
343
344static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
345 return NormalizeImageLayout(layout, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
346 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL);
347}
348
349static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
350 return NormalizeImageLayout(layout, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
351 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL);
352}
353
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700354static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
355 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
356 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
357 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
358 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
359 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
360 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
361 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
362 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
363 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
364 }
365 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
366 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
367 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
368 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
369 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
370 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
371 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
372 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
373 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
374 }
375 }
376 return layout;
377}
378
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700379static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700380 a = NormalizeSynchronization2Layout(aspect_mask, a);
381 b = NormalizeSynchronization2Layout(aspect_mask, b);
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700382 bool matches = (a == b);
383 if (!matches) {
384 // Relaxed rules when referencing *only* the depth or stencil aspects
385 if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
386 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
387 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
388 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
389 }
390 }
391 return matches;
392}
393
394// Utility type for ForRange callbacks
395struct LayoutUseCheckAndMessage {
396 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
397 const ImageSubresourceLayoutMap *layout_map;
398 const VkImageAspectFlags aspect_mask;
399 const char *message;
400 VkImageLayout layout;
401
402 LayoutUseCheckAndMessage() = delete;
403 LayoutUseCheckAndMessage(const ImageSubresourceLayoutMap *layout_map_, const VkImageAspectFlags aspect_mask_ = 0)
404 : layout_map(layout_map_), aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
405 bool Check(const VkImageSubresource &subres, VkImageLayout check, VkImageLayout current_layout, VkImageLayout initial_layout) {
406 message = nullptr;
407 layout = kInvalidLayout; // Success status
408 if (current_layout != kInvalidLayout && !ImageLayoutMatches(aspect_mask, check, current_layout)) {
409 message = "previous known";
410 layout = current_layout;
411 } else if ((initial_layout != kInvalidLayout) && !ImageLayoutMatches(aspect_mask, check, initial_layout)) {
412 // To check the relaxed rule matching we need to see how the initial use was used
413 const auto initial_layout_state = layout_map->GetSubresourceInitialLayoutState(subres);
414 assert(initial_layout_state); // If we have an initial layout, we better have a state for it
415 if (!((initial_layout_state->aspect_mask & kDepthOrStencil) &&
416 ImageLayoutMatches(initial_layout_state->aspect_mask, check, initial_layout))) {
417 message = "previously used";
418 layout = initial_layout;
419 }
420 }
421 return layout == kInvalidLayout;
422 }
423};
424
locke-lunarg540b2252020-08-03 13:23:36 -0600425bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600426 if (image_view == compare_view.image_view) {
427 return true;
428 }
locke-lunargdc287022020-08-21 12:03:57 -0600429 if (image_state->image != compare_view.image_state->image) {
430 return false;
431 }
locke-lunarg540b2252020-08-03 13:23:36 -0600432 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
433 return false;
434 }
435
436 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600437 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600438 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600439 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600440 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600441 }
442
443 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600444 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600445 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600446 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600447 }
448
449 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600450 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600451 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600452 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600453 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600454 }
455
456 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600457 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600458 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600459 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600460 }
locke-lunargdc287022020-08-21 12:03:57 -0600461 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600462}
463
Dave Houltond9611312018-11-19 17:03:36 -0700464uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
465 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700466 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700467}
468
469uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
470
471uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
472
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500473bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700474 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700475 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700476
John Zulauf2076e812020-01-08 14:55:54 -0700477 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
478 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700479 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
480 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
481
John Zulauf2076e812020-01-08 14:55:54 -0700482 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
483
484 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
485 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700486 return false;
487 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700488
John Zulauf2076e812020-01-08 14:55:54 -0700489 for (auto entry : *layout_range_map) {
490 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700491 }
492 return true;
493}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700494
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600495// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600496void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600497 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
498 VkImageLayout expected_layout) {
499 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
500 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600501 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600502 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700503 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700504 for (const auto &image : image_state.aliasing_images) {
505 auto alias_state = GetImageState(image);
506 // The map state of the aliases should all be in sync, so no need to check the return value
507 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
508 assert(subresource_map);
509 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
510 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700511}
John Zulauff660ad62019-03-23 07:16:05 -0600512
513// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600514void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600515 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500516 return;
517 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500518 IMAGE_STATE *image_state = view_state.image_state.get();
519 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700520 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700521 for (const auto &image : image_state->aliasing_images) {
522 image_state = GetImageState(image);
523 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
524 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
525 }
John Zulauff660ad62019-03-23 07:16:05 -0600526}
527
528// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600529void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600530 const VkImageSubresourceRange &range, VkImageLayout layout) {
531 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
532 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600533 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700534 for (const auto &image : image_state.aliasing_images) {
535 auto alias_state = GetImageState(image);
536 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
537 assert(subresource_map);
538 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
539 }
John Zulauff660ad62019-03-23 07:16:05 -0600540}
541
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600542void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600543 VkImageLayout layout) {
544 const IMAGE_STATE *image_state = GetImageState(image);
545 if (!image_state) return;
546 SetImageInitialLayout(cb_node, *image_state, range, layout);
547};
548
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600549void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600550 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
551 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600552}
Dave Houltonddd65c52018-05-08 14:58:01 -0600553
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600554// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700555void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
556 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500557 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600558
John Zulauff660ad62019-03-23 07:16:05 -0600559 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600560 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
561 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600562 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 -0600563 sub_range.baseArrayLayer = 0;
564 sub_range.layerCount = image_state->createInfo.extent.depth;
565 }
566
Piers Daniell4fde9b72019-11-27 16:19:46 -0700567 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
568 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
569 SetImageLayout(cb_node, *image_state, sub_range, layout);
570 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
571 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
572 } else {
573 SetImageLayout(cb_node, *image_state, sub_range, layout);
574 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600575}
576
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700577bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
578 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700579 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600580 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100581 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700582 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100583 const char *vuid;
584 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700585 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100586
587 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600588 LogObjectList objlist(image);
589 objlist.add(renderpass);
590 objlist.add(framebuffer);
591 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700592 skip |=
593 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
594 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
595 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
596 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100597 return skip;
598 }
599
600 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700601 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200602 if (stencil_usage_info) {
603 image_usage |= stencil_usage_info->stencilUsage;
604 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100605
606 // Check for layouts that mismatch image usages in the framebuffer
607 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800608 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600609 LogObjectList objlist(image);
610 objlist.add(renderpass);
611 objlist.add(framebuffer);
612 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700613 skip |= LogError(objlist, vuid,
614 "%s: Layout/usage mismatch for attachment %u in %s"
615 " - the %s is %s but the image attached to %s via %s"
616 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
617 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
618 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
619 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100620 }
621
622 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
623 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800624 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600625 LogObjectList objlist(image);
626 objlist.add(renderpass);
627 objlist.add(framebuffer);
628 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700629 skip |= LogError(objlist, vuid,
630 "%s: Layout/usage mismatch for attachment %u in %s"
631 " - the %s is %s but the image attached to %s via %s"
632 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
633 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
634 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
635 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100636 }
637
638 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800639 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600640 LogObjectList objlist(image);
641 objlist.add(renderpass);
642 objlist.add(framebuffer);
643 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700644 skip |= LogError(objlist, vuid,
645 "%s: Layout/usage mismatch for attachment %u in %s"
646 " - the %s is %s but the image attached to %s via %s"
647 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
648 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
649 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
650 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100651 }
652
653 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800654 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600655 LogObjectList objlist(image);
656 objlist.add(renderpass);
657 objlist.add(framebuffer);
658 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700659 skip |= LogError(objlist, vuid,
660 "%s: Layout/usage mismatch for attachment %u in %s"
661 " - the %s is %s but the image attached to %s via %s"
662 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
663 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
664 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
665 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100666 }
667
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600668 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100669 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
670 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
671 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
672 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
673 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800674 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600675 LogObjectList objlist(image);
676 objlist.add(renderpass);
677 objlist.add(framebuffer);
678 objlist.add(image_view);
679 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700680 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700681 " - the %s is %s but the image attached to %s via %s"
682 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700683 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700684 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
685 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100686 }
687 } else {
688 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
689 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
690 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
691 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600692 LogObjectList objlist(image);
693 objlist.add(renderpass);
694 objlist.add(framebuffer);
695 objlist.add(image_view);
696 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700697 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700698 " - the %s is %s but the image attached to %s via %s"
699 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700700 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700701 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
702 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100703 }
704 }
705 return skip;
706}
707
John Zulauf17a01bb2019-08-09 16:41:19 -0600708bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700709 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600710 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600711 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700712 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
713 auto const &framebuffer_info = framebuffer_state->createInfo;
714 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100715
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700716 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100717 auto framebuffer = framebuffer_state->framebuffer;
718
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700719 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700720 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
721 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700722 }
John Zulauf8e308292018-09-21 11:34:37 -0600723
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700724 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800725 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700726 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100727 }
728
Tobias Hectorc9057422019-07-23 12:15:52 +0100729 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700730 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
731 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100732 auto image_view = attachments[i];
733 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100734
Tobias Hectorc9057422019-07-23 12:15:52 +0100735 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600736 LogObjectList objlist(pRenderPassBegin->renderPass);
737 objlist.add(framebuffer_state->framebuffer);
738 objlist.add(image_view);
739 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700740 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
741 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
742 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100743 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100744 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100745
746 const VkImage image = view_state->create_info.image;
747 const IMAGE_STATE *image_state = GetImageState(image);
748
749 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600750 LogObjectList objlist(pRenderPassBegin->renderPass);
751 objlist.add(framebuffer_state->framebuffer);
752 objlist.add(image_view);
753 objlist.add(image);
754 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700755 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
756 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
757 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100758 continue;
759 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700760 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
761 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100762
Piers Daniell7f894f62020-01-09 16:33:48 -0700763 // Default to expecting stencil in the same layout.
764 auto attachment_stencil_initial_layout = attachment_initial_layout;
765
766 // If a separate layout is specified, look for that.
767 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700768 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700769 if (attachment_description_stencil_layout) {
770 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
771 }
772
Tobias Hectorc9057422019-07-23 12:15:52 +0100773 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
774 // in common with the non-const version.)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700775 const ImageSubresourceLayoutMap *subresource_map = (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED)
776 ? GetImageSubresourceLayoutMap(const_p_cb, image)
777 : nullptr;
Tobias Hectorc9057422019-07-23 12:15:52 +0100778
779 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
780 LayoutUseCheckAndMessage layout_check(subresource_map);
781 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700782 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700783 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
784 // the next "constant value" range
785 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700786 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700787
John Zulauf5e617452019-11-19 14:44:16 -0700788 // Allow for differing depth and stencil layouts
789 VkImageLayout check_layout = attachment_initial_layout;
790 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
791
792 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700793 subres_skip |= LogError(
794 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700795 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
796 "and the %s layout of the attachment is %s. The layouts must match, or the render "
797 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700798 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100799 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700800 }
John Zulauf5e617452019-11-19 14:44:16 -0700801
Tobias Hectorc9057422019-07-23 12:15:52 +0100802 skip |= subres_skip;
803 }
804
805 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
806 framebuffer, render_pass, i, "initial layout");
807
808 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
809 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100810 }
811
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700812 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
813 auto &subpass = render_pass_info->pSubpasses[j];
814 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100815 auto &attachment_ref = subpass.pInputAttachments[k];
816 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
817 auto image_view = attachments[attachment_ref.attachment];
818 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100819
Tobias Hectorc9057422019-07-23 12:15:52 +0100820 if (view_state) {
821 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700822 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
823 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100824 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100825 }
826 }
827 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100828
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700829 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100830 auto &attachment_ref = subpass.pColorAttachments[k];
831 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
832 auto image_view = attachments[attachment_ref.attachment];
833 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100834
Tobias Hectorc9057422019-07-23 12:15:52 +0100835 if (view_state) {
836 auto image = view_state->create_info.image;
837 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
838 framebuffer, render_pass, attachment_ref.attachment,
839 "color attachment layout");
840 if (subpass.pResolveAttachments) {
841 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
842 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
843 attachment_ref.attachment, "resolve attachment layout");
844 }
845 }
846 }
847 }
848
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700849 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100850 auto &attachment_ref = *subpass.pDepthStencilAttachment;
851 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
852 auto image_view = attachments[attachment_ref.attachment];
853 auto view_state = GetImageViewState(image_view);
854
855 if (view_state) {
856 auto image = view_state->create_info.image;
857 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
858 framebuffer, render_pass, attachment_ref.attachment,
859 "input attachment layout");
860 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100861 }
862 }
863 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700864 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600865 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700866}
867
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600868void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700869 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700870 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinski8d46f802020-12-07 16:33:54 -0700871 IMAGE_VIEW_STATE *image_view = GetActiveAttachmentImageViewState(pCB, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600872 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700873 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700874 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700875 if (attachment_reference_stencil_layout) {
876 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
877 }
878
879 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600880 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700881 }
882}
883
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600884void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
885 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700886 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700887
888 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700889 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700890 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700891 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700892 }
893 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700894 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700895 }
896 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700897 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700898 }
899 }
900}
901
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700902// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
903// 1. Transition into initialLayout state
904// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600905void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700906 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700907 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700908 auto const rpci = render_pass_state->createInfo.ptr();
909 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -0700910 auto *view_state = GetActiveAttachmentImageViewState(cb_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600911 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700912 IMAGE_STATE *image_state = view_state->image_state.get();
913 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700914 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700915 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700916 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700917 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
918 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
919 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
920 SetImageInitialLayout(cb_state, *image_state, sub_range, initial_layout);
921 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
922 SetImageInitialLayout(cb_state, *image_state, sub_range, stencil_initial_layout);
923 } else {
924 SetImageInitialLayout(cb_state, *image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700925 }
John Zulauf8e308292018-09-21 11:34:37 -0600926 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700927 }
928 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700929 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700930}
931
Dave Houlton10b39482017-03-16 13:18:15 -0600932bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600933 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600934 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600935 }
936 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600937 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600938 }
939 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600940 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600941 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800942 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 -0700943 if (FormatPlaneCount(format) == 1) return false;
944 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600945 return true;
946}
947
Mike Weiblen62d08a32017-03-07 22:18:27 -0700948// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700949bool CoreChecks::ValidateBarrierLayoutToImageUsage(const CoreErrorLocation &loc, VkImage image, VkImageLayout layout,
950 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700951 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700952 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700953 switch (layout) {
954 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700955 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700956 break;
957 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700958 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700959 break;
960 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700961 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700962 break;
963 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700964 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700965 break;
966 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700967 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700968 break;
969 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700970 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700971 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600972 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700973 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500974 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700975 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700976 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700977 break;
978 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700979 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700980 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700981 default:
982 // Other VkImageLayout values do not have VUs defined in this context.
983 break;
984 }
985
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700986 if (is_error) {
987 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
988
989 skip |=
990 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
991 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700992 }
993 return skip;
994}
995
996// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700997template <typename ImageBarrier>
998bool CoreChecks::ValidateBarriersToImages(const CoreErrorLocation &outer_loc, const CMD_BUFFER_STATE *cb_state,
999 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001000 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001001 using sync_vuid_maps::GetImageBarrierVUID;
1002 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +02001003 // Scoreboard for checking for duplicate and inconsistent barriers to images
1004 struct ImageBarrierScoreboardEntry {
1005 uint32_t index;
1006 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
1007 // 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 -07001008 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +02001009 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001010 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
1011 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
1012 // when creating maps full of maps.
1013 struct ImageBarrierScoreboardSubresMap {
1014 std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
1015 };
Petr Krausad0096a2019-08-09 18:35:04 +02001016 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
1017
John Zulauf463c51e2018-05-31 13:29:20 -06001018 // Scoreboard for duplicate layout transition barriers within the list
1019 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
1020 ImageBarrierScoreboardImageMap layout_transitions;
1021
Mike Weiblen62d08a32017-03-07 22:18:27 -07001022 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001023 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +02001024 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -07001025
John Zulauf463c51e2018-05-31 13:29:20 -06001026 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
1027 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
1028 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +02001029 if (img_barrier.oldLayout != img_barrier.newLayout) {
1030 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
1031 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -06001032 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001033 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +02001034 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -06001035 if (subres_it != subres_map.end()) {
1036 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001037 auto entry_layout =
1038 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
1039 auto old_layout =
1040 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
1041 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +02001042 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001043 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001044 skip = LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001045 cb_state->commandBuffer, vuid,
1046 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -06001047 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
1048 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001049 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +02001050 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
1051 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -06001052 }
1053 entry = new_entry;
1054 } else {
Petr Krausad0096a2019-08-09 18:35:04 +02001055 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001056 }
1057 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001058 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001059 }
1060 }
1061
Petr Krausad0096a2019-08-09 18:35:04 +02001062 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001063 if (image_state) {
1064 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001065 skip |=
1066 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
1067 skip |=
1068 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001069
1070 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
1071 if (image_state->layout_locked) {
1072 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001073 skip |= LogError(
1074 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001075 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001076 " 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 -07001077 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1078 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001079 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001080
John Zulaufa4472282019-08-22 14:44:34 -06001081 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -07001082 const VkFormat image_format = image_create_info.format;
1083 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -06001084 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001085 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -07001086 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001087 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06001088 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001089 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
1090 skip |= LogError(img_barrier.image, vuid,
1091 "%s references %s of format %s that must have either the depth or stencil "
1092 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1093 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1094 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001095 }
1096 } else {
1097 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1098 if ((aspect_mask & ds_mask) != (ds_mask)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001099 auto error = device_extensions.vk_khr_separate_depth_stencil_layouts
1100 ? ImageError::kNotSeparateDepthAndStencilAspect
1101 : ImageError::kNotDepthAndStencilAspect;
1102 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -07001103 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001104 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001105 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001106 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001107 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001108 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001109 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001110 }
John Zulauff660ad62019-03-23 07:16:05 -06001111
Petr Krausad0096a2019-08-09 18:35:04 +02001112 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1113 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001114 // TODO: Set memory invalid which is in mem_tracker currently
1115 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1116 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001117 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001118 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001119 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001120 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001121 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1122 // the next "constant value" range
1123 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001124 const auto &value = *pos;
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001125 auto old_layout =
1126 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
1127 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001128 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
1129 subres_skip = LogError(cb_state->commandBuffer, vuid,
1130 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
1131 "%s layout is %s.",
1132 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1133 value.subresource.aspectMask, value.subresource.mipLevel,
1134 value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1135 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001136 }
John Zulauf5e617452019-11-19 14:44:16 -07001137 }
John Zulauff660ad62019-03-23 07:16:05 -06001138 skip |= subres_skip;
1139 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001140
1141 // checks color format and (single-plane or non-disjoint)
1142 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1143 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001144 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001145 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001146 auto error = device_extensions.vk_khr_sampler_ycbcr_conversion ? ImageError::kNotColorAspect
1147 : ImageError::kNotColorAspectYcbcr;
1148 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -07001149 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001150 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -07001151 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001152 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001153 string_VkFormat(image_format), aspect_mask);
1154 }
1155 }
1156
1157 VkImageAspectFlags valid_disjoint_mask =
1158 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 -07001159 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001160 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001161 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
1162 skip |= LogError(img_barrier.image, vuid,
1163 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -07001164 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001165 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001166 string_VkFormat(image_format), aspect_mask);
1167 }
1168
1169 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001170 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1171 skip |= LogError(img_barrier.image, vuid,
1172 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -07001173 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001174 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001175 string_VkFormat(image_format), aspect_mask);
1176 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001177 }
1178 }
1179 return skip;
1180}
1181
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001182template <typename Barrier, typename TransferBarrier>
1183bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
1184 const Barrier &barrier,
1185 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>
1253void CoreChecks::RecordBarrierValidationInfo(const CoreErrorLocation &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
1254 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
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001266 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1267 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1268 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1269 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1270 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1271 auto handle_state = BarrierHandleState(*this, barrier);
1272 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1273 if (!mode_concurrent) {
1274 const auto typed_handle = BarrierTypedHandle(barrier);
1275 cb_state->queue_submit_functions.emplace_back(
1276 [loc, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1277 const QUEUE_STATE *queue_state) {
1278 return ValidateConcurrentBarrierAtSubmit(loc, device_data, queue_state, cb_state, typed_handle,
1279 src_queue_family, dst_queue_family);
1280 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001281 }
1282 }
1283}
1284
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001285// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001286template <typename ImgBarrier>
1287bool CoreChecks::ValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001288 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1289 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001290 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1291 using sync_vuid_maps::GetImageBarrierVUID;
1292 using sync_vuid_maps::ImageError;
1293
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001294 bool skip = false;
1295 const auto *fb_state = framebuffer;
1296 assert(fb_state);
1297 const auto img_bar_image = img_barrier.image;
1298 bool image_match = false;
1299 bool sub_image_found = false; // Do we find a corresponding subpass description
1300 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1301 uint32_t attach_index = 0;
1302 // Verify that a framebuffer image matches barrier image
1303 const auto attachment_count = fb_state->createInfo.attachmentCount;
1304 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
1305 auto view_state = GetActiveAttachmentImageViewState(cb_state, attachment, primary_cb_state);
1306 if (view_state && (img_bar_image == view_state->create_info.image)) {
1307 image_match = true;
1308 attach_index = attachment;
1309 break;
1310 }
1311 }
1312 if (image_match) { // Make sure subpass is referring to matching attachment
1313 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1314 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1315 sub_image_found = true;
1316 }
1317 if (!sub_image_found && device_extensions.vk_khr_depth_stencil_resolve) {
1318 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1319 if (resolve && resolve->pDepthStencilResolveAttachment &&
1320 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1321 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1322 sub_image_found = true;
1323 }
1324 }
1325 if (!sub_image_found) {
1326 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1327 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1328 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1329 sub_image_found = true;
1330 break;
1331 }
1332 if (!sub_image_found && sub_desc.pResolveAttachments &&
1333 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1334 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1335 sub_image_found = true;
1336 break;
1337 }
1338 }
1339 }
1340 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001341 auto img_loc = loc.dot(Field::image);
1342 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1343 skip |=
1344 LogError(rp_handle, vuid,
1345 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1346 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1347 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001348 }
1349 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001350 auto img_loc = loc.dot(Field::image);
1351 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1352 skip |= LogError(fb_state->framebuffer, vuid, "%s Barrier for %s does not match an image from the current %s.",
1353 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
1354 report_data->FormatHandle(fb_state->framebuffer).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001355 }
1356 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001357 auto layout_loc = loc.dot(Field::oldLayout);
1358 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1359 skip |= LogError(cb_state->commandBuffer, vuid,
1360 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001361 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001362 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001363 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1364 } else {
1365 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1366 LogObjectList objlist(rp_handle);
1367 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001368 auto layout_loc = loc.dot(Field::oldLayout);
1369 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1370 skip |= LogError(objlist, vuid,
1371 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001372 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001373 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001374 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1375 string_VkImageLayout(img_barrier.oldLayout));
1376 }
1377 }
1378 return skip;
1379}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001380// explictly instantiate so these can be used in core_validation.cpp
1381template bool CoreChecks::ValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE const *cb_state,
1382 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1383 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1384 const VkImageMemoryBarrier &img_barrier,
1385 const CMD_BUFFER_STATE *primary_cb_state) const;
1386template bool CoreChecks::ValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE const *cb_state,
1387 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1388 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1389 const VkImageMemoryBarrier2KHR &img_barrier,
1390 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001391
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001392template <typename ImgBarrier>
1393void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE *cb_state,
1394 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001395 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1396 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1397 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1398 const auto active_subpass = cb_state->activeSubpass;
1399 const auto rp_state = cb_state->activeRenderPass;
1400 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001401 // Secondary CB case w/o FB specified delay validation
1402 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
1403 cb_state->cmd_execute_commands_functions.emplace_back([=](const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1404 return this_ptr->ValidateImageBarrierAttachment(loc, cb_state, fb, active_subpass, sub_desc, rp_state->renderPass,
1405 barrier, primary_cb);
1406 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001407 }
1408}
1409
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001410void CoreChecks::RecordBarriers(ErrFunc func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1411 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1412 const VkImageMemoryBarrier *pImageMemBarriers) {
1413 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
1414 CoreErrorLocation loc(func_name, RefPage::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
1415 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1416 }
1417 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
1418 CoreErrorLocation loc(func_name, RefPage::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
1419 const auto &img_barrier = pImageMemBarriers[i];
1420 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1421 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1422 }
1423}
1424
1425void CoreChecks::RecordBarriers(ErrFunc func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
1426 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
1427 CoreErrorLocation loc(func_name, RefPage::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
1428 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1429 }
1430 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
1431 CoreErrorLocation loc(func_name, RefPage::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
1432 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1433 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1434 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1435 }
1436}
1437
1438template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001439bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001440 const char *operation, const TransferBarrier &barrier,
1441 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001442 // Record to the scoreboard or report that we have a duplication
1443 bool skip = false;
1444 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1445 if (!inserted.second && inserted.first->second != cb_state) {
1446 // 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 -06001447 LogObjectList objlist(cb_state->commandBuffer);
1448 objlist.add(barrier.handle);
1449 objlist.add(inserted.first->second->commandBuffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001450 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001451 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1452 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001453 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001454 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1455 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001456 }
1457 return skip;
1458}
1459
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001460template <typename TransferBarrier>
1461bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1462 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1463 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001464 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001465 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TransferBarrier());
1466 const char *barrier_name = TransferBarrier::BarrierName();
1467 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001468 // No release should have an extant duplicate (WARNING)
1469 for (const auto &release : cb_barriers.release) {
1470 // Check the global pending release barriers
1471 const auto set_it = global_release_barriers.find(release.handle);
1472 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001473 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001474 const auto found = set_for_handle.find(release);
1475 if (found != set_for_handle.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001476 skip |= LogWarning(cb_state->commandBuffer, TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001477 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1478 " to dstQueueFamilyIndex %" PRIu32
1479 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1480 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1481 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001482 }
1483 }
1484 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1485 }
1486 // Each acquire must have a matching release (ERROR)
1487 for (const auto &acquire : cb_barriers.acquire) {
1488 const auto set_it = global_release_barriers.find(acquire.handle);
1489 bool matching_release_found = false;
1490 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001491 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001492 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1493 }
1494 if (!matching_release_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001495 skip |= LogError(cb_state->commandBuffer, TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001496 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1497 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1498 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1499 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001500 }
1501 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1502 }
1503 return skip;
1504}
1505
John Zulauf3b04ebd2019-07-18 14:08:11 -06001506bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001507 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1508 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001509 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001510 skip |=
1511 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1512 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1513 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001514 return skip;
1515}
1516
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001517template <typename TransferBarrier>
1518void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1519 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001520 // Add release barriers from this submit to the global map
1521 for (const auto &release : cb_barriers.release) {
1522 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1523 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1524 global_release_barriers[release.handle].insert(release);
1525 }
1526
1527 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1528 for (const auto &acquire : cb_barriers.acquire) {
1529 // NOTE: We're not using [] because we don't want to create entries for missing releases
1530 auto set_it = global_release_barriers.find(acquire.handle);
1531 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001532 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001533 set_for_handle.erase(acquire);
1534 if (set_for_handle.size() == 0) { // Clean up empty sets
1535 global_release_barriers.erase(set_it);
1536 }
1537 }
1538 }
1539}
1540
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001541void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001542 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1543 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1544 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001545}
1546
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001547template <typename ImgBarrier>
1548void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1549 // For ownership transfers, the barrier is specified twice; as a release
1550 // operation on the yielding queue family, and as an acquire operation
1551 // on the acquiring queue family. This barrier may also include a layout
1552 // transition, which occurs 'between' the two operations. For validation
1553 // purposes it doesn't seem important which side performs the layout
1554 // transition, but it must not be performed twice. We'll arbitrarily
1555 // choose to perform it as part of the acquire operation.
1556 //
1557 // However, we still need to record initial layout for the "initial layout" validation
1558 for (uint32_t i = 0; i < barrier_count; i++) {
1559 const auto &mem_barrier = barriers[i];
John Zulauf2be3fe02019-12-30 09:48:02 -07001560 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001561 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001562 if (image_state) {
1563 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1564 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001565 }
1566}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001567// explictly instantiate this template so it can be used in core_validation.cpp
1568template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1569 const VkImageMemoryBarrier *barrier);
1570template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1571 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001572
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001573VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1574
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001575template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001576void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001577 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001578 if (enabled_features.synchronization2_features.synchronization2) {
1579 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1580 return;
1581 }
1582 }
unknown86bcb3a2019-07-11 13:05:36 -06001583 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1584 const auto &image_create_info = image_state->createInfo;
1585
Mike Schuchardt2df08912020-12-15 16:28:09 -08001586 // 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 -07001587 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
unknown86bcb3a2019-07-11 13:05:36 -06001588 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001589 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001590 normalized_isr.baseArrayLayer = 0;
1591 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1592 }
1593
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001594 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1595 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001596
1597 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001598 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001599 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1600 }
1601
John Zulauf2be3fe02019-12-30 09:48:02 -07001602 if (is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001603 SetImageInitialLayout(cb_state, *image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001604 } else {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001605 SetImageLayout(cb_state, *image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001606 }
unknown86bcb3a2019-07-11 13:05:36 -06001607}
1608
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001609bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1610 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1611 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1612 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001613 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001614 assert(cb_node);
1615 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001616 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001617 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001618
John Zulauff660ad62019-03-23 07:16:05 -06001619 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1620 if (subresource_map) {
1621 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001622 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001623 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1624 // the next "constant value" range
1625 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001626 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001627 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001628 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1629 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1630 "%s layout %s.",
1631 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1632 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1633 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001634 }
John Zulauf5e617452019-11-19 14:44:16 -07001635 }
John Zulauff660ad62019-03-23 07:16:05 -06001636 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001637 }
John Zulauff660ad62019-03-23 07:16:05 -06001638
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001639 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1640 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1641 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001642 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1643 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001644 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1645 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1646 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001647 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001648 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001649 if (image_state->shared_presentable) {
1650 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001651 skip |=
1652 LogError(device, layout_invalid_msg_code,
1653 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1654 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001655 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001656 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001657 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001658 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001659 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1660 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1661 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1662 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001663 }
1664 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001665 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001666}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001667bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001668 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1669 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001670 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001671 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1672 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1673}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001674
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001675void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001676 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001677 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1678 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001679
Mike Schuchardt2df08912020-12-15 16:28:09 -08001680 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001681 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001682 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001683 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001684 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001685 VkImageLayout stencil_layout = kInvalidLayout;
1686 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001687 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001688 if (attachment_description_stencil_layout) {
1689 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1690 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001691 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001692 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001693 }
1694 }
1695}
Dave Houltone19e20d2018-02-02 16:32:41 -07001696
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001697#ifdef VK_USE_PLATFORM_ANDROID_KHR
1698// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1699// This could also move into a seperate core_validation_android.cpp file... ?
1700
1701//
1702// AHB-specific validation within non-AHB APIs
1703//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001704bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001705 bool skip = false;
1706
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001707 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001708 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001709 if (0 != ext_fmt_android->externalFormat) {
1710 if (VK_FORMAT_UNDEFINED != create_info->format) {
1711 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001712 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1713 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1714 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001715 }
1716
1717 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001718 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1719 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1720 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001721 }
1722
1723 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001724 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1725 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001726 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1727 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1728 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001729 }
1730
1731 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001732 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1733 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1734 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001735 }
1736 }
1737
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001738 if ((0 != ext_fmt_android->externalFormat) &&
1739 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001740 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001741 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1742 ") which has "
1743 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1744 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001745 }
1746 }
1747
Dave Houltond9611312018-11-19 17:03:36 -07001748 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001749 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001750 skip |=
1751 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1752 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1753 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001754 }
1755 }
1756
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001757 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001758 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1759 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001760 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001761 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1762 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1763 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1764 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001765 }
1766
1767 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001768 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1769 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1770 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1771 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1772 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001773 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001774 }
1775
1776 return skip;
1777}
1778
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001779bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001780 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001781 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001782
1783 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001784 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001785 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1786 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001787 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001788 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001789 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001790
Dave Houltond9611312018-11-19 17:03:36 -07001791 // Chain must include a compatible ycbcr conversion
1792 bool conv_found = false;
1793 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001794 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001795 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001796 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001797 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001798 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001799 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001800 }
Dave Houltond9611312018-11-19 17:03:36 -07001801 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001802 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001803 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001804 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1805 "an externalFormat (%" PRIu64
1806 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1807 "with the same external format.",
1808 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001809 }
1810
1811 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001812 if (IsIdentitySwizzle(create_info->components) == false) {
1813 skip |= LogError(
1814 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1815 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1816 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1817 "= %s.",
1818 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1819 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001820 }
1821 }
Dave Houltond9611312018-11-19 17:03:36 -07001822
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001823 return skip;
1824}
1825
John Zulaufa26d3c82019-08-14 16:09:08 -06001826bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001827 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001828
John Zulaufa26d3c82019-08-14 16:09:08 -06001829 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001830 if (image_state != nullptr) {
1831 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1832 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1833 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1834 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1835 "bound to memory.");
1836 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001837 }
1838 return skip;
1839}
1840
1841#else
1842
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001843bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001844 return false;
1845}
1846
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001847bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001848
John Zulaufa26d3c82019-08-14 16:09:08 -06001849bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001850
1851#endif // VK_USE_PLATFORM_ANDROID_KHR
1852
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001853bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1854 bool skip = false;
1855
1856 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1857 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1858 const VkImageTiling image_tiling = pCreateInfo->tiling;
1859 const VkFormat image_format = pCreateInfo->format;
1860
1861 if (image_format == VK_FORMAT_UNDEFINED) {
1862 // VU 01975 states format can't be undefined unless an android externalFormat
1863#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001864 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001865 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1866 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1867 if (it != ahb_ext_formats_map.end()) {
1868 tiling_features = it->second;
1869 }
1870 }
1871#endif
1872 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1873 uint64_t drm_format_modifier = 0;
1874 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001875 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001876 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001877 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001878
1879 if (drm_explicit != nullptr) {
1880 drm_format_modifier = drm_explicit->drmFormatModifier;
1881 } else {
1882 // VUID 02261 makes sure its only explict or implict in parameter checking
1883 assert(drm_implicit != nullptr);
1884 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1885 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1886 }
1887 }
1888
1889 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1890 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1891 nullptr};
1892 format_properties_2.pNext = (void *)&drm_properties_list;
1893 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001894 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1895 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1896 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1897 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001898
1899 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1900 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1901 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1902 }
1903 }
1904 } else {
1905 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1906 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1907 : format_properties.optimalTilingFeatures;
1908 }
1909
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001910 // Lack of disjoint format feature support while using the flag
1911 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1912 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1913 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1914 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1915 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1916 string_VkFormat(pCreateInfo->format));
1917 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001918
1919 return skip;
1920}
1921
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001922bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001923 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001924 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001925
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001926 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001927 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001928 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1929 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001930 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1931 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001932 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001933 }
1934
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001935 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1936 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001937 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1938 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1939 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001940 }
1941
1942 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001943 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1944 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1945 "height (%d) and arrayLayers (%d) must be >= 6.",
1946 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001947 }
Dave Houlton130c0212018-01-29 13:39:56 -07001948 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001949
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001950 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001951 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1952 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1953 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001954 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001955 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1956 "device maxFramebufferWidth (%u).",
1957 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001958 }
1959
1960 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001961 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001962 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1963 "device maxFramebufferHeight (%u).",
1964 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001965 }
1966
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001967 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001968 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1969 static_cast<float>(device_limits->maxFramebufferWidth) /
1970 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001971 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1972 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001973 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1974 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1975 "ceiling of device "
1976 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1977 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1978 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001979 }
1980
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001981 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1982 static_cast<float>(device_limits->maxFramebufferHeight) /
1983 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001984 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1985 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001986 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1987 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1988 "ceiling of device "
1989 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1990 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1991 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001992 }
1993 }
1994
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001995 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001996 VkResult result = VK_SUCCESS;
1997 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1998 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1999 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
2000 &format_limits);
2001 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002002 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
2003 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002004 if (modifier_list) {
2005 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002006 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002007 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002008 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002009 image_format_info.type = pCreateInfo->imageType;
2010 image_format_info.format = pCreateInfo->format;
2011 image_format_info.tiling = pCreateInfo->tiling;
2012 image_format_info.usage = pCreateInfo->usage;
2013 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002014 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002015
2016 result =
2017 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
2018 format_limits = image_format_properties.imageFormatProperties;
2019
2020 /* The application gives a list of modifier and the driver
2021 * selects one. If one is wrong, stop there.
2022 */
2023 if (result != VK_SUCCESS) break;
2024 }
2025 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002026 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002027 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002028 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002029 image_format_info.type = pCreateInfo->imageType;
2030 image_format_info.format = pCreateInfo->format;
2031 image_format_info.tiling = pCreateInfo->tiling;
2032 image_format_info.usage = pCreateInfo->usage;
2033 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002034 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002035
2036 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
2037 format_limits = image_format_properties.imageFormatProperties;
2038 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06002039 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06002040
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002041 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
2042 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
2043 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
2044 if (result != VK_SUCCESS) {
2045 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06002046#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002047 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06002048#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002049 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07002050 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002051 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
2052 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002053#ifdef VK_USE_PLATFORM_ANDROID_KHR
2054 }
2055#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002056 } else {
2057 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
2058 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002059 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
2060 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
2061 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002062 }
Dave Houlton130c0212018-01-29 13:39:56 -07002063
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002064 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
2065 static_cast<uint64_t>(pCreateInfo->extent.height) *
2066 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
2067 static_cast<uint64_t>(pCreateInfo->samples);
2068 uint64_t total_size =
2069 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07002070
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002071 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002072 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
2073 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002074 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002075
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002076 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002077 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
2078 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
2079 ", maximum resource size = 0x%" PRIxLEAST64 " ",
2080 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002081 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002082
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002083 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002084 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
2085 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
2086 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002087 }
2088
2089 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002090 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
2091 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
2092 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002093 }
sfricke-samsung612f3622020-06-20 20:42:46 -07002094
2095 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
2096 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
2097 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
2098 pCreateInfo->extent.width, format_limits.maxExtent.width);
2099 }
2100
2101 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
2102 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
2103 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
2104 pCreateInfo->extent.height, format_limits.maxExtent.height);
2105 }
2106
2107 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
2108 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
2109 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
2110 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
2111 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002112 }
2113
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002114 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08002115 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
2116 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
2117 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
2118 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002119 skip |= LogError(device, error_vuid,
2120 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
2121 "YCbCr Conversion format, arrayLayers must be 1",
2122 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002123 }
2124
2125 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002126 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
2127 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
2128 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002129 }
2130
2131 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002132 skip |= LogError(
2133 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08002134 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
2135 string_VkSampleCountFlagBits(pCreateInfo->samples));
2136 }
2137
2138 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002139 skip |= LogError(
2140 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08002141 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2142 string_VkImageType(pCreateInfo->imageType));
2143 }
2144 }
2145
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002146 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002147 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07002148 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06002149 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002150 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2151 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2152 "format must be block, ETC or ASTC compressed, but is %s",
2153 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002154 }
2155 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002156 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2157 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2158 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002159 }
2160 }
2161 }
2162
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002163 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002164 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
2165 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
2166 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002167 }
2168
unknown2c877272019-07-11 12:56:50 -06002169 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2170 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2171 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002172 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2173 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2174 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002175 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002176
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002177 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002178 if (swapchain_create_info != nullptr) {
2179 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2180 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2181 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2182
2183 // Validate rest of Swapchain Image create check that require swapchain state
2184 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2185 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2186 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2187 skip |= LogError(
2188 device, vuid,
2189 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2190 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2191 }
2192 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2193 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2194 skip |= LogError(device, vuid,
2195 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2196 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2197 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002198 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002199 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2200 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2201 skip |= LogError(device, vuid,
2202 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2203 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002204 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002205 }
2206 }
2207 }
2208
sfricke-samsungedce77a2020-07-03 22:35:13 -07002209 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2210 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2211 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2212 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2213 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2214 }
2215 const VkImageCreateFlags invalid_flags =
2216 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2217 if ((pCreateInfo->flags & invalid_flags) != 0) {
2218 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2219 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2220 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2221 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2222 }
2223 }
2224
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002225 skip |= ValidateImageFormatFeatures(pCreateInfo);
2226
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002227 // Check compatibility with VK_KHR_portability_subset
2228 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
2229 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2230 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2231 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2232 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2233 }
2234 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2235 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2236 skip |=
2237 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2238 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2239 }
2240 }
2241
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002242 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002243}
2244
John Zulauf7eeb6f72019-06-17 11:56:36 -06002245void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2246 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2247 if (VK_SUCCESS != result) return;
2248
2249 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002250 auto image_state = Get<IMAGE_STATE>(*pImage);
2251 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002252}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002253
Jeff Bolz5c801d12019-10-09 10:38:45 -05002254bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002255 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06002256 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002257 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002258 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002259 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002260 }
2261 return skip;
2262}
2263
John Zulauf7eeb6f72019-06-17 11:56:36 -06002264void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2265 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002266 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002267
locke-lunargcba7d5f2019-12-30 16:59:11 -07002268 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002269
2270 // Clean up generic image state
2271 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002272}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002273
sfricke-samsungcd924d92020-05-20 23:51:17 -07002274bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2275 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002276 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002277 const VkImage image = image_state->image;
2278 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002279
2280 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002281 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2282 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002283 }
2284
sfricke-samsungcd924d92020-05-20 23:51:17 -07002285 if (FormatIsDepthOrStencil(format)) {
2286 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2287 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2288 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2289 } else if (FormatIsCompressed(format)) {
2290 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2291 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2292 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002293 }
2294
2295 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002296 skip |=
2297 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2298 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2299 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002300 }
2301 return skip;
2302}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002303
John Zulauf07288512019-07-05 11:09:50 -06002304bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2305 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2306 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002307 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002308 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2309 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002310 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2311 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2312 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002313 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002314
2315 } else {
2316 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2317 if (!device_extensions.vk_khr_shared_presentable_image) {
2318 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002319 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2320 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2321 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002322 }
2323 } else {
2324 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2325 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002326 skip |= LogError(
2327 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002328 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2329 func_name, string_VkImageLayout(dest_image_layout));
2330 }
2331 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002332 }
2333
John Zulauff660ad62019-03-23 07:16:05 -06002334 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002335 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002336 if (subresource_map) {
2337 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002338 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002339 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002340 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2341 // the next "constant value" range
2342 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002343 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002344 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2345 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2346 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2347 } else {
2348 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002349 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002350 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2351 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2352 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2353 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002354 }
John Zulauf5e617452019-11-19 14:44:16 -07002355 }
John Zulauff660ad62019-03-23 07:16:05 -06002356 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002357 }
2358
2359 return skip;
2360}
2361
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002362bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2363 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002364 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002365 bool skip = false;
2366 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002367 const auto *cb_node = GetCBState(commandBuffer);
2368 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002369 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002370 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002371 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002372 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002373 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002374 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002375 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2376 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002377 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002378 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002379 skip |=
2380 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2381 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2382 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002383 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002384 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002385 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002386 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002387 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002388 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002389 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2390 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2391 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2392 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2393 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2394 string_VkFormat(image_state->createInfo.format));
2395 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002396 }
2397 return skip;
2398}
2399
John Zulaufeabb4462019-07-05 14:13:03 -06002400void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2401 const VkClearColorValue *pColor, uint32_t rangeCount,
2402 const VkImageSubresourceRange *pRanges) {
2403 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2404
2405 auto cb_node = GetCBState(commandBuffer);
2406 auto image_state = GetImageState(image);
2407 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002408 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002409 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002410 }
2411 }
2412}
2413
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002414bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2415 const char *apiName) const {
2416 bool skip = false;
2417
2418 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2419 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2420 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2421 // Also VUID-VkClearDepthStencilValue-depth-00022
2422 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2423 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2424 "(=%f) is not within the [0.0, 1.0] range.",
2425 apiName, clearValue.depth);
2426 }
2427 }
2428
2429 return skip;
2430}
2431
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002432bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2433 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002434 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002435 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002436
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002437 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002438 const auto *cb_node = GetCBState(commandBuffer);
2439 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002440 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002441 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002442 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002443 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002444 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002445 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002446 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002447 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002448 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002449 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002450 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002451 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002452 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002453 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2454 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2455 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2456 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002457
2458 bool any_include_aspect_depth_bit = false;
2459 bool any_include_aspect_stencil_bit = false;
2460
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002461 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002462 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002463 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002464 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002465 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002466 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2467 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002468 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2469 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2470 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2471 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002472 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002473 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2474 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002475 if (FormatHasDepth(image_format) == false) {
2476 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2477 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2478 "doesn't have a depth component.",
2479 i, string_VkFormat(image_format));
2480 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002481 }
2482 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2483 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002484 if (FormatHasStencil(image_format) == false) {
2485 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2486 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2487 "%s doesn't have a stencil component.",
2488 i, string_VkFormat(image_format));
2489 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002490 }
2491 }
2492 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002493 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002494 if (image_stencil_struct != nullptr) {
2495 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2496 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002497 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2498 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2499 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2500 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002501 }
2502 } else {
2503 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002504 skip |= LogError(
2505 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002506 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2507 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2508 "in VkImageCreateInfo::usage used to create image");
2509 }
2510 }
2511 }
2512 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002513 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2514 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2515 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002516 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002517 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002518 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2519 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002520 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002521 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002522 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002523 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2524 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2525 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2526 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002527 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002528 }
2529 return skip;
2530}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002531
John Zulaufeabb4462019-07-05 14:13:03 -06002532void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2533 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2534 const VkImageSubresourceRange *pRanges) {
2535 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2536 auto cb_node = GetCBState(commandBuffer);
2537 auto image_state = GetImageState(image);
2538 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002539 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002540 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002541 }
2542 }
2543}
2544
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002545// Returns true if [x, xoffset] and [y, yoffset] overlap
2546static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2547 bool result = false;
2548 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2549 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2550
2551 if (intersection_max > intersection_min) {
2552 result = true;
2553 }
2554 return result;
2555}
2556
Jeff Leger178b1e52020-10-05 12:22:23 -04002557// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002558// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002559template <typename RegionType>
2560static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002561 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002562
Dave Houltonc991cc92018-03-06 11:08:51 -07002563 // Separate planes within a multiplane image cannot intersect
2564 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002565 return result;
2566 }
2567
Dave Houltonc991cc92018-03-06 11:08:51 -07002568 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2569 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2570 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002571 result = true;
2572 switch (type) {
2573 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002574 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002575 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002576 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002577 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002578 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002579 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002580 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002581 break;
2582 default:
2583 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2584 assert(false);
2585 }
2586 }
2587 return result;
2588}
2589
Dave Houltonfc1a4052017-04-27 14:32:45 -06002590// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002591static const uint32_t kXBit = 1;
2592static const uint32_t kYBit = 2;
2593static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002594static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002595 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002596 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002597 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2598 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002599 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002600 }
2601 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2602 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002603 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002604 }
2605 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2606 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002607 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002608 }
2609 return result;
2610}
2611
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002612// Test if two VkExtent3D structs are equivalent
2613static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2614 bool result = true;
2615 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2616 (extent->depth != other_extent->depth)) {
2617 result = false;
2618 }
2619 return result;
2620}
2621
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002622// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002623static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002624 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2625}
2626
2627// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002628VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002629 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2630 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002631 auto pool = cb_node->command_pool.get();
2632 if (pool) {
2633 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002634 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002635 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002636 granularity.width *= block_size.width;
2637 granularity.height *= block_size.height;
2638 }
2639 }
2640 return granularity;
2641}
2642
2643// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2644static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2645 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002646 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2647 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002648 valid = false;
2649 }
2650 return valid;
2651}
2652
2653// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002654bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002655 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002656 bool skip = false;
2657 VkExtent3D offset_extent = {};
2658 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2659 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2660 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002661 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 // 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 -07002663 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002664 skip |= LogError(cb_node->commandBuffer, vuid,
2665 "%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 "
2666 "image transfer granularity is (w=0, h=0, d=0).",
2667 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002668 }
2669 } else {
2670 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2671 // integer multiples of the image transfer granularity.
2672 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002673 skip |= LogError(cb_node->commandBuffer, vuid,
2674 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2675 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2676 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2677 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002678 }
2679 }
2680 return skip;
2681}
2682
2683// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002684bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002685 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002686 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002687 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002688 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002689 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2690 // subresource extent.
2691 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002692 skip |= LogError(cb_node->commandBuffer, vuid,
2693 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2694 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2695 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2696 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002697 }
2698 } else {
2699 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2700 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2701 // subresource extent dimensions.
2702 VkExtent3D offset_extent_sum = {};
2703 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2704 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2705 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002706 bool x_ok = true;
2707 bool y_ok = true;
2708 bool z_ok = true;
2709 switch (image_type) {
2710 case VK_IMAGE_TYPE_3D:
2711 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2712 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002713 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002714 case VK_IMAGE_TYPE_2D:
2715 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2716 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002717 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002718 case VK_IMAGE_TYPE_1D:
2719 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2720 (subresource_extent->width == offset_extent_sum.width));
2721 break;
2722 default:
2723 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2724 assert(false);
2725 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002726 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002727 skip |=
2728 LogError(cb_node->commandBuffer, vuid,
2729 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2730 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2731 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2732 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2733 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2734 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002735 }
2736 }
2737 return skip;
2738}
2739
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002740bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002741 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002742 bool skip = false;
2743 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002744 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2745 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002746 }
2747 return skip;
2748}
2749
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002750bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002751 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002752 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002753 bool skip = false;
2754 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2755 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002756 skip |= LogError(cb_node->commandBuffer, vuid,
2757 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2758 "%u, but provided %s has %u array layers.",
2759 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2760 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002761 }
2762 return skip;
2763}
2764
Jeff Leger178b1e52020-10-05 12:22:23 -04002765// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2766template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002767bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002768 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002769 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002770 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002771 VkExtent3D granularity = GetScaledItg(cb_node, img);
2772 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002773 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002774 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002775 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002776 return skip;
2777}
2778
Jeff Leger178b1e52020-10-05 12:22:23 -04002779// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2780template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002781bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002782 const IMAGE_STATE *dst_img, const RegionType *region,
2783 const uint32_t i, const char *function,
2784 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002785 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002786 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2787 const char *vuid;
2788
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002789 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002790 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002791 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2792 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002793 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002794 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002795 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002796 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002797 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002798
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002799 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002800 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002801 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2802 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002803 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002804 const VkExtent3D dest_effective_extent =
2805 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002806 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002807 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002808 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002809 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002810 return skip;
2811}
2812
Jeff Leger178b1e52020-10-05 12:22:23 -04002813// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2814template <typename ImageCopyRegionType>
2815bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2816 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2817 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002818 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002819 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2820 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2821 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002822
2823 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002824 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002825
2826 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002827 const VkExtent3D src_copy_extent = region.extent;
2828 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002829 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2830
Dave Houlton6f9059e2017-05-02 17:15:13 -06002831 bool slice_override = false;
2832 uint32_t depth_slices = 0;
2833
2834 // Special case for copying between a 1D/2D array and a 3D image
2835 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2836 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002837 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002838 slice_override = (depth_slices != 1);
2839 } 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 -07002840 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002841 slice_override = (depth_slices != 1);
2842 }
2843
2844 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002845 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002846 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002847 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2848 skip |= LogError(src_state->image, vuid,
2849 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2850 "be 0 and 1, respectively.",
2851 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002852 }
2853 }
2854
Dave Houlton533be9f2018-03-26 17:08:30 -06002855 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 -04002856 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2857 skip |= LogError(src_state->image, vuid,
2858 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002859 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002860 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002861 }
2862
Dave Houlton533be9f2018-03-26 17:08:30 -06002863 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002864 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2865 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2866 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002867 }
2868
Dave Houltonc991cc92018-03-06 11:08:51 -07002869 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002870 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002871 if (FormatIsCompressed(src_state->createInfo.format) ||
2872 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002873 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002874 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002875 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2876 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2877 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002878 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002879 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002880 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002881 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002882 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002883 }
2884
Dave Houlton94a00372017-12-14 15:08:47 -07002885 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002886 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2887 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002888 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2889 skip |= LogError(src_state->image, vuid,
2890 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2891 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2892 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002893 }
2894
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002895 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002896 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2897 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002898 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2899 skip |= LogError(src_state->image, vuid,
2900 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2901 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2902 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002903 }
2904
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002905 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002906 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2907 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002908 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2909 skip |= LogError(src_state->image, vuid,
2910 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2911 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2912 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002913 }
2914 } // Compressed
2915
2916 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002917 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002918 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002919 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2920 skip |= LogError(dst_state->image, vuid,
2921 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002922 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002923 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002924 }
2925 }
2926
Dave Houlton533be9f2018-03-26 17:08:30 -06002927 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 -04002928 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2929 skip |= LogError(dst_state->image, vuid,
2930 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2931 "and 1, respectively.",
2932 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002933 }
2934
Dave Houlton533be9f2018-03-26 17:08:30 -06002935 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002936 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2937 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2938 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002939 }
2940
sfricke-samsung30b094c2020-05-30 11:42:11 -07002941 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002942 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002943 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2944 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002945 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2946 skip |= LogError(src_state->image, vuid,
2947 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2948 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2949 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002950 }
2951 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002952 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002953 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002954 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2955 skip |= LogError(dst_state->image, vuid,
2956 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2957 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2958 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002959 }
2960 }
2961 } else { // Pre maint 1
2962 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002963 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002964 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2965 skip |= LogError(src_state->image, vuid,
2966 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002967 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2968 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002969 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002970 }
Dave Houltonee281a52017-12-08 13:51:02 -07002971 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002972 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2973 skip |= LogError(dst_state->image, vuid,
2974 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002975 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2976 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002977 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002978 }
2979 }
2980 }
2981
Dave Houltonc991cc92018-03-06 11:08:51 -07002982 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2983 if (FormatIsCompressed(dst_state->createInfo.format) ||
2984 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002985 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002986
2987 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002988 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2989 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2990 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002991 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002992 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002993 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002994 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002995 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002996 }
2997
Dave Houlton94a00372017-12-14 15:08:47 -07002998 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002999 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
3000 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003001 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
3002 skip |= LogError(dst_state->image, vuid,
3003 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3004 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
3005 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06003006 }
3007
Dave Houltonee281a52017-12-08 13:51:02 -07003008 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
3009 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
3010 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003011 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003012 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003013 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003014 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
3015 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003016 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003017 }
3018
Dave Houltonee281a52017-12-08 13:51:02 -07003019 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
3020 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
3021 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003022 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
3023 skip |= LogError(dst_state->image, vuid,
3024 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3025 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
3026 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003027 }
3028 } // Compressed
3029 }
3030 return skip;
3031}
3032
Jeff Leger178b1e52020-10-05 12:22:23 -04003033template <typename RegionType>
3034bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3035 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3036 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003037 const auto *cb_node = GetCBState(commandBuffer);
3038 const auto *src_image_state = GetImageState(srcImage);
3039 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08003040 const VkFormat src_format = src_image_state->createInfo.format;
3041 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04003042 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003043 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003044
Jeff Leger178b1e52020-10-05 12:22:23 -04003045 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
3046 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
3047 const char *vuid;
3048
3049 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003050
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003051 VkCommandBuffer command_buffer = cb_node->commandBuffer;
3052
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003053 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003054 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07003055
3056 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
3057 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08003058 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07003059
Dave Houlton6f9059e2017-05-02 17:15:13 -06003060 bool slice_override = false;
3061 uint32_t depth_slices = 0;
3062
3063 // Special case for copying between a 1D/2D array and a 3D image
3064 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
3065 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3066 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003067 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003068 slice_override = (depth_slices != 1);
3069 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3070 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003071 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003072 slice_override = (depth_slices != 1);
3073 }
3074
Jeff Leger178b1e52020-10-05 12:22:23 -04003075 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
3076 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
3077 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
3078 skip |=
3079 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3080 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
3081 skip |=
3082 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3083 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003084 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003085 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3086 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003087 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003088 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003089
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003090 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06003091 // No chance of mismatch if we're overriding depth slice count
3092 if (!slice_override) {
3093 // The number of depth slices in srcSubresource and dstSubresource must match
3094 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
3095 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003096 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
3097 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003098 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003099 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
3100 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003101 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003102 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
3103 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003104 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
3105 "do not match.",
3106 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003107 }
3108 }
3109 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003110 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07003111 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003112 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003113 skip |=
3114 LogError(command_buffer, vuid,
3115 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
3116 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003117 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003118 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003119
Dave Houltonc991cc92018-03-06 11:08:51 -07003120 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003121 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003122 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3123 // If neither image is multi-plane the aspectMask member of src and dst must match
3124 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
3125 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
3126 skip |= LogError(command_buffer, vuid,
3127 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3128 "source (0x%x) destination (0x%x).",
3129 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3130 }
3131 } else {
3132 // Source image multiplane checks
3133 uint32_t planes = FormatPlaneCount(src_format);
3134 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3135 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3136 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
3137 skip |= LogError(command_buffer, vuid,
3138 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3139 i, aspect);
3140 }
3141 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3142 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3143 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
3144 skip |= LogError(command_buffer, vuid,
3145 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3146 i, aspect);
3147 }
3148 // Single-plane to multi-plane
3149 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3150 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3151 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3152 skip |= LogError(command_buffer, vuid,
3153 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3154 func_name, i, aspect);
3155 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003156
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003157 // Dest image multiplane checks
3158 planes = FormatPlaneCount(dst_format);
3159 aspect = region.dstSubresource.aspectMask;
3160 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3161 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3162 skip |= LogError(command_buffer, vuid,
3163 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3164 i, aspect);
3165 }
3166 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3167 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3168 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3169 skip |= LogError(command_buffer, vuid,
3170 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3171 i, aspect);
3172 }
3173 // Multi-plane to single-plane
3174 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3175 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3176 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3177 skip |= LogError(command_buffer, vuid,
3178 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3179 func_name, i, aspect);
3180 }
3181 }
3182 } else {
3183 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003184 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3185 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003186 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003187 skip |= LogError(
3188 command_buffer, vuid,
3189 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3190 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003191 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003192 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003193
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003194 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003195 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003196 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003197 skip |=
3198 LogError(command_buffer, vuid,
3199 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3200 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003201 }
3202
3203 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003204 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003205 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003206 skip |= LogError(
3207 command_buffer, vuid,
3208 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3209 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003210 }
3211
Dave Houltonfc1a4052017-04-27 14:32:45 -06003212 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07003213 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
3214 if (slice_override) src_copy_extent.depth = depth_slices;
3215 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003216 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003217 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3218 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003219 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003220 "width [%1d].",
3221 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003222 }
3223
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003224 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003225 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3226 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003227 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003228 "height [%1d].",
3229 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003230 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003231 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003232 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3233 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003234 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003235 "depth [%1d].",
3236 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003237 }
3238
Dave Houltonee281a52017-12-08 13:51:02 -07003239 // Adjust dest extent if necessary
3240 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
3241 if (slice_override) dst_copy_extent.depth = depth_slices;
3242
3243 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003244 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003245 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3246 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003247 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003248 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003249 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003250 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003251 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003252 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3253 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003254 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003255 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003256 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003257 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003258 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003259 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3260 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003261 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003262 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003263 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003264 }
3265
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003266 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3267 // must not overlap in memory
3268 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003269 for (uint32_t j = 0; j < regionCount; j++) {
3270 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003271 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003272 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003273 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003274 }
3275 }
3276 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003277
3278 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3279 if (device_extensions.vk_khr_maintenance1) {
3280 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3281 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3282 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003283 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3284 skip |= LogError(command_buffer, vuid,
3285 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3286 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003287 }
3288 } else {
3289 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3290 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3291 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003292 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3293 skip |= LogError(command_buffer, vuid,
3294 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3295 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003296 }
3297 }
3298
3299 // Check if 2D with 3D and depth not equal to 2D layerCount
3300 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3301 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3302 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003303 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3304 skip |= LogError(command_buffer, vuid,
3305 "%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 -08003306 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003307 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003308 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3309 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3310 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003311 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3312 skip |= LogError(command_buffer, vuid,
3313 "%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 -08003314 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003315 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003316 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003317
3318 // Check for multi-plane format compatiblity
3319 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3320 size_t src_format_size = 0;
3321 size_t dst_format_size = 0;
3322 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003323 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3324 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003325 } else {
3326 src_format_size = FormatElementSize(src_format);
3327 }
3328 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003329 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3330 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003331 } else {
3332 dst_format_size = FormatElementSize(dst_format);
3333 }
3334 // If size is still zero, then format is invalid and will be caught in another VU
3335 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003336 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3337 skip |= LogError(command_buffer, vuid,
3338 "%s: pRegions[%u] called with non-compatible image formats. "
3339 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3340 func_name, i, string_VkFormat(src_format),
3341 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3342 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003343 }
3344 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003345 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003346
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003347 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3348 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3349 // because because both texels are 4 bytes in size.
3350 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003351 const char *compatible_vuid =
3352 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3353 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3354 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003355 // Depth/stencil formats must match exactly.
3356 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3357 if (src_format != dst_format) {
3358 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003359 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003360 string_VkFormat(src_format), string_VkFormat(dst_format));
3361 }
3362 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003363 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003364 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003365 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003366 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003367 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003368 FormatElementSize(dst_format));
3369 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003370 }
3371 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003372
Dave Houlton33c22b72017-02-28 13:16:02 -07003373 // Source and dest image sample counts must match
3374 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003375 std::stringstream ss;
3376 ss << func_name << " called on image pair with non-identical sample counts.";
3377 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003378 skip |=
3379 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3380 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3381 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003382 }
3383
Tony-LunarG5a066372021-01-21 10:31:34 -07003384 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3385 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3386 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003387 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
Tony-LunarG5a066372021-01-21 10:31:34 -07003388 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3389 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3390 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3391 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003392 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003393 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3394 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3395 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3396 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3397 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3398 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3399 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3400 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3401 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3402 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3403 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3404 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003405
3406 // Validation for VK_EXT_fragment_density_map
3407 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003408 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3409 skip |=
3410 LogError(command_buffer, vuid,
3411 "%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 +02003412 }
3413 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003414 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3415 skip |=
3416 LogError(command_buffer, vuid,
3417 "%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 +02003418 }
3419
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003420 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003421 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3422 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3423 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3424 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003425 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003426 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3427 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3428 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3429 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3430 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003431 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003432
3433 const char *invalid_src_layout_vuid =
3434 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3435 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3436 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3437 const char *invalid_dst_layout_vuid =
3438 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3439 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3440 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3441
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003442 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003443 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003444 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003445 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3446 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003447 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003448 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003449 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003450 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003451 }
3452
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003453 return skip;
3454}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003455
Jeff Leger178b1e52020-10-05 12:22:23 -04003456bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3457 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3458 const VkImageCopy *pRegions) const {
3459 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3460 COPY_COMMAND_VERSION_1);
3461}
3462
3463bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3464 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3465 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3466 COPY_COMMAND_VERSION_2);
3467}
3468
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003469void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3470 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3471 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003472 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3473 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003474 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003475 auto src_image_state = GetImageState(srcImage);
3476 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003477
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003478 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003479 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003480 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3481 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003482 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003483}
3484
Jeff Leger178b1e52020-10-05 12:22:23 -04003485void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3486 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3487 auto cb_node = GetCBState(commandBuffer);
3488 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3489 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3490
3491 // Make sure that all image slices are updated to correct layout
3492 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3493 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3494 pCopyImageInfo->srcImageLayout);
3495 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3496 pCopyImageInfo->dstImageLayout);
3497 }
3498}
3499
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003500// Returns true if sub_rect is entirely contained within rect
3501static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3502 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 -07003503 (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 -07003504 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003505 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003506 return true;
3507}
3508
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003509bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003510 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003511 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3512 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003513 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003514 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3515 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003516 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003517 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003518
3519 for (uint32_t j = 0; j < rect_count; j++) {
3520 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003521 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3522 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3523 "the current render pass instance.",
3524 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003525 }
3526
3527 if (image_view_state) {
3528 // The layers specified by a given element of pRects must be contained within every attachment that
3529 // pAttachments refers to
3530 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3531 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3532 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003533 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3534 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3535 "of pAttachment[%d].",
3536 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003537 }
3538 }
3539 }
3540 return skip;
3541}
3542
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003543bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3544 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003545 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003546 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003547 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003548 if (!cb_node) return skip;
3549
3550 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3551 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3552 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003553 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003554
3555 // Validate that attachment is in reference list of active subpass
3556 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003557 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003558 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003559 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003560 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003561 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003562
John Zulauf3a548ef2019-02-01 16:14:07 -07003563 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3564 auto clear_desc = &pAttachments[attachment_index];
3565 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003566 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003567
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003568 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3569 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3570 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3571 attachment_index);
3572 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3573 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3574 skip |=
3575 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3576 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3577 attachment_index);
3578 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003579 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3580 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3581 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3582 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003583 skip |= LogError(
3584 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3585 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3586 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3587 attachment_index, clear_desc->colorAttachment,
3588 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3589 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003590
John Zulauff2582972019-02-09 14:53:30 -07003591 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3592 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003593 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003594 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3595 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3596 " subpass %u. colorAttachmentCount=%u",
3597 attachment_index, clear_desc->colorAttachment,
3598 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3599 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003600 }
John Zulauff2582972019-02-09 14:53:30 -07003601 fb_attachment = color_attachment;
3602
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003603 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3604 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3605 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3606 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3607 "of a color attachment.",
3608 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003609 }
3610 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003611 bool subpass_depth = false;
3612 bool subpass_stencil = false;
3613 if (subpass_desc->pDepthStencilAttachment &&
3614 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3615 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3616 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3617 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3618 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003619 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003620 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3621 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003622 skip |= LogError(
3623 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3624 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003625 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003626 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003627 }
3628 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003629 skip |= LogError(
3630 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3631 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003632 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003633 attachment_index);
3634 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003635 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003636 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003637 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003638 if (subpass_depth) {
3639 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3640 "vkCmdClearAttachments()");
3641 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003642 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003643 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003644 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3645 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003646 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003647
3648 // Once the framebuffer attachment is found, can get the image view state
3649 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3650 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3651 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003652 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003653 if (image_view_state != nullptr) {
3654 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3655 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3656 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3657 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3658 }
3659 }
John Zulauf441558b2019-08-12 11:47:39 -06003660 }
3661 }
3662 return skip;
3663}
3664
3665void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3666 const VkClearAttachment *pAttachments, uint32_t rectCount,
3667 const VkClearRect *pRects) {
3668 auto *cb_node = GetCBState(commandBuffer);
3669 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003670 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3671 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003672 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3673 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3674 const auto clear_desc = &pAttachments[attachment_index];
3675 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3676 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3677 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3678 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3679 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3680 subpass_desc->pDepthStencilAttachment) {
3681 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3682 }
3683 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003684 if (!clear_rect_copy) {
3685 // We need a copy of the clear rectangles that will persist until the last lambda executes
3686 // but we want to create it as lazily as possible
3687 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003688 }
John Zulauf441558b2019-08-12 11:47:39 -06003689 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3690 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003691 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003692 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003693 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003694 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3695 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003696 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003697 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003698 return skip;
3699 };
3700 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003701 }
3702 }
3703 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003704}
3705
Jeff Leger178b1e52020-10-05 12:22:23 -04003706template <typename RegionType>
3707bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3708 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3709 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003710 const auto *cb_node = GetCBState(commandBuffer);
3711 const auto *src_image_state = GetImageState(srcImage);
3712 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003713 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3714 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3715 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3716 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003717
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003718 bool skip = false;
3719 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003720 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3721 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3722 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3723 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3724 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3725 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3726 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3727 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3728 skip |= InsideRenderPass(cb_node, func_name, vuid);
3729 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3730 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3731 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3732 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3733 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3734 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3735 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3736 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003737
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003738 // Validation for VK_EXT_fragment_density_map
3739 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003740 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3741 skip |= LogError(cb_node->commandBuffer, vuid,
3742 "%s: srcImage must not have been created with flags containing "
3743 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3744 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003745 }
3746 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003747 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3748 skip |= LogError(cb_node->commandBuffer, vuid,
3749 "%s: dstImage must not have been created with flags containing "
3750 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3751 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003752 }
3753
Cort Stratton7df30962018-05-17 19:45:57 -07003754 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003755 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003756 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3757 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003758 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003759 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3760 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3761 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003762 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003763 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3764 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3765 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3766 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3767 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3768 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003769 // For each region, the number of layers in the image subresource should not be zero
3770 // For each region, src and dest image aspect must be color only
3771 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003772 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003773 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3774 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003775 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3776 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3777 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003778 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003779 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3780 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003781 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003782 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3783 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3784 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3785 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3786 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3787 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003788 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003789 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3790 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003791 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003792 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003793
3794 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003795 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003796 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3797 skip |=
3798 LogError(cb_node->commandBuffer, vuid,
3799 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003800 }
Cort Stratton7df30962018-05-17 19:45:57 -07003801 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003802 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3803 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003804 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3805 skip |= LogError(cb_node->commandBuffer, vuid,
3806 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3807 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003808 }
3809
3810 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3811 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3812
3813 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003814 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003815 LogObjectList objlist(cb_node->commandBuffer);
3816 objlist.add(src_image_state->image);
3817 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003818 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3819 skip |= LogError(objlist, vuid,
3820 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003821 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003822 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003823 }
3824 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3825 LogObjectList objlist(cb_node->commandBuffer);
3826 objlist.add(src_image_state->image);
3827 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003828 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3829 skip |= LogError(objlist, vuid,
3830 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003831 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003832 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003833 }
3834 }
3835
3836 if (VK_IMAGE_TYPE_1D == src_image_type) {
3837 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3838 LogObjectList objlist(cb_node->commandBuffer);
3839 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003840 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3841 skip |= LogError(objlist, vuid,
3842 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003843 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003844 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3845 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003846 }
3847 }
3848 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3849 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3850 LogObjectList objlist(cb_node->commandBuffer);
3851 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003852 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3853 skip |= LogError(objlist, vuid,
3854 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003855 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003856 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3857 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003858 }
3859 }
3860
3861 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3862 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3863 LogObjectList objlist(cb_node->commandBuffer);
3864 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003865 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3866 skip |= LogError(objlist, vuid,
3867 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003868 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003869 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3870 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003871 }
3872 }
3873 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3874 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3875 LogObjectList objlist(cb_node->commandBuffer);
3876 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003877 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3878 skip |= LogError(objlist, vuid,
3879 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003880 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003881 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3882 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003883 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003884 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003885
3886 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3887 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3888 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3889 // developer
3890 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3891 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003892 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003893 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-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3896 skip |= LogError(objlist, vuid,
3897 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003898 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003899 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003900 region.extent.width, subresource_extent.width);
3901 }
3902
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003903 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003904 LogObjectList objlist(cb_node->commandBuffer);
3905 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003906 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3907 skip |= LogError(objlist, vuid,
3908 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003909 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003910 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003911 region.extent.height, subresource_extent.height);
3912 }
3913
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003914 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003915 LogObjectList objlist(cb_node->commandBuffer);
3916 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003917 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3918 skip |= LogError(objlist, vuid,
3919 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003920 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003921 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003922 region.extent.depth, subresource_extent.depth);
3923 }
3924 }
3925
3926 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3927 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3928 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3929 // developer
3930 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3931 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003932 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003933 LogObjectList objlist(cb_node->commandBuffer);
3934 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003935 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3936 skip |= LogError(objlist, vuid,
3937 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003938 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003939 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003940 region.extent.width, subresource_extent.width);
3941 }
3942
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003943 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003944 LogObjectList objlist(cb_node->commandBuffer);
3945 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003946 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3947 skip |= LogError(objlist, vuid,
3948 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003949 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003950 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003951 region.extent.height, subresource_extent.height);
3952 }
3953
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003954 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003955 LogObjectList objlist(cb_node->commandBuffer);
3956 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003957 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3958 skip |= LogError(objlist, vuid,
3959 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003960 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003961 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003962 region.extent.depth, subresource_extent.depth);
3963 }
3964 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003965 }
3966
3967 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003968 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3969 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3970 func_name, string_VkFormat(src_image_state->createInfo.format),
3971 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003972 }
3973 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003974 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003975 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003976 string_VkImageType(src_image_state->createInfo.imageType),
3977 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003978 }
3979 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003980 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3981 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 -07003982 }
3983 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003984 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3985 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3986 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003987 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003988 } else {
3989 assert(0);
3990 }
3991 return skip;
3992}
3993
Jeff Leger178b1e52020-10-05 12:22:23 -04003994bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3995 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3996 const VkImageResolve *pRegions) const {
3997 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3998 COPY_COMMAND_VERSION_1);
3999}
4000
4001bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
4002 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
4003 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4004 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
4005 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
4006}
4007
4008template <typename RegionType>
4009bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4010 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4011 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004012 const auto *cb_node = GetCBState(commandBuffer);
4013 const auto *src_image_state = GetImageState(srcImage);
4014 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004015
Jeff Leger178b1e52020-10-05 12:22:23 -04004016 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
4017 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
4018 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
4019
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004020 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07004021 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004022 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07004023 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004024 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004025 const char *vuid;
4026 const char *location;
4027 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
4028 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
4029 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
4030 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4031 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
4032 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
4033 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
4034 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
4035 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
4036 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
4037 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
4038 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
4039 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
4040 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
4041 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
4042 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
4043 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
4044 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
4045 skip |= ValidateCmd(cb_node, cmd_type, func_name);
4046 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
4047 skip |= InsideRenderPass(cb_node, func_name, vuid);
4048 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4049 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
4050 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4051 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
4052 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
4053 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
4054 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
4055 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
4056 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
4057 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004058
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004059 // Validation for VK_EXT_fragment_density_map
4060 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004061 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
4062 skip |= LogError(cb_node->commandBuffer, vuid,
4063 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4064 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004065 }
4066 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004067 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
4068 skip |= LogError(cb_node->commandBuffer, vuid,
4069 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4070 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004071 }
4072
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004073 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004074
Dave Houlton33c2d252017-06-09 17:08:32 -06004075 VkFormat src_format = src_image_state->createInfo.format;
4076 VkFormat dst_format = dst_image_state->createInfo.format;
4077 VkImageType src_type = src_image_state->createInfo.imageType;
4078 VkImageType dst_type = dst_image_state->createInfo.imageType;
4079
Cort Stratton186b1a22018-05-01 20:18:06 -04004080 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004081 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4082 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
4083 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004084 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004085 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004086 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04004087 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004088 }
4089
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004090 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004091 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
4092 skip |= LogError(device, vuid,
4093 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004094 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004095 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004096 }
4097
4098 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004099 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
4100 skip |= LogError(device, vuid,
4101 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004102 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004103 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004104 }
4105
Dave Houlton33c2d252017-06-09 17:08:32 -06004106 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004107 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
4108 skip |= LogError(cb_node->commandBuffer, vuid,
4109 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004110 }
4111
Dave Houlton33c2d252017-06-09 17:08:32 -06004112 // Validate consistency for unsigned formats
4113 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
4114 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004115 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004116 << "the other one must also have unsigned integer format. "
4117 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004118 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
4119 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004120 }
4121
4122 // Validate consistency for signed formats
4123 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
4124 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004125 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004126 << "the other one must also have signed integer format. "
4127 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004128 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
4129 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004130 }
4131
4132 // Validate filter for Depth/Stencil formats
4133 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4134 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004135 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004136 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04004137 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
4138 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004139 }
4140
4141 // Validate aspect bits and formats for depth/stencil images
4142 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4143 if (src_format != dst_format) {
4144 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004145 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 -06004146 << "stencil, the other one must have exactly the same format. "
4147 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4148 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004149 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
4150 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004151 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004152 } // Depth or Stencil
4153
4154 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004155 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004156 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4157 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4158 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
4159 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4160 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4161 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004162 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004163 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4164 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4165 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
4166 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4167 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4168 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004169 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004170 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004171 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004172 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004173 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004174 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4175 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004176 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004177 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4178 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4179 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4180 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4181 skip |=
4182 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4183 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4184 skip |=
4185 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4186 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004187 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004188 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4189 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004190 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004191 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004192 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004193 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4194 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004195 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004196 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004197 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004198 }
Dave Houlton48989f32017-05-26 15:01:46 -06004199 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4200 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004201 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004202 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004203 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004204 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004205
4206 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004207 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004208 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4209 skip |=
4210 LogError(cb_node->commandBuffer, vuid,
4211 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004212 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004213
Dave Houlton48989f32017-05-26 15:01:46 -06004214 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004215 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4216 skip |=
4217 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004218 }
Dave Houlton48989f32017-05-26 15:01:46 -06004219
Dave Houlton33c2d252017-06-09 17:08:32 -06004220 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004221 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
4222 skip |= LogError(cb_node->commandBuffer, vuid,
4223 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004224 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004225 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004226 }
4227
4228 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004229 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
4230 skip |= LogError(cb_node->commandBuffer, vuid,
4231 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4232 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004233 }
4234
Dave Houlton48989f32017-05-26 15:01:46 -06004235 // Validate source image offsets
4236 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004237 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004238 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004239 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
4240 skip |= LogError(cb_node->commandBuffer, vuid,
4241 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4242 "of (%1d, %1d). These must be (0, 1).",
4243 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004244 }
4245 }
4246
Dave Houlton33c2d252017-06-09 17:08:32 -06004247 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004248 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004249 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
4250 skip |= LogError(cb_node->commandBuffer, vuid,
4251 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4252 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4253 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004254 }
4255 }
4256
Dave Houlton33c2d252017-06-09 17:08:32 -06004257 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004258 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4259 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004260 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004261 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
4262 skip |= LogError(cb_node->commandBuffer, vuid,
4263 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4264 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004265 }
4266 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4267 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004268 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004269 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
4270 skip |= LogError(cb_node->commandBuffer, vuid,
4271 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4272 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004273 }
4274 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4275 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004276 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004277 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
4278 skip |= LogError(cb_node->commandBuffer, vuid,
4279 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4280 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004281 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004282 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004283 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4284 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4285 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004286 }
Dave Houlton48989f32017-05-26 15:01:46 -06004287
4288 // Validate dest image offsets
4289 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004290 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004291 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004292 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4293 skip |= LogError(cb_node->commandBuffer, vuid,
4294 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4295 "(%1d, %1d). These must be (0, 1).",
4296 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004297 }
4298 }
4299
Dave Houlton33c2d252017-06-09 17:08:32 -06004300 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004301 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004302 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4303 skip |= LogError(cb_node->commandBuffer, vuid,
4304 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004305 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004306 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004307 }
4308 }
4309
Dave Houlton33c2d252017-06-09 17:08:32 -06004310 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004311 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4312 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004313 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004314 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4315 skip |= LogError(cb_node->commandBuffer, vuid,
4316 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4317 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004318 }
4319 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4320 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004321 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004322 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4323 skip |= LogError(cb_node->commandBuffer, vuid,
4324 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4325 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004326 }
4327 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4328 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004329 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004330 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4331 skip |= LogError(cb_node->commandBuffer, vuid,
4332 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4333 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004334 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004335 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004336 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4337 skip |= LogError(cb_node->commandBuffer, vuid,
4338 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004339 }
4340
Dave Houlton33c2d252017-06-09 17:08:32 -06004341 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4342 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4343 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004344 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4345 skip |= LogError(cb_node->commandBuffer, vuid,
4346 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4347 "layerCount other than 1.",
4348 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004349 }
4350 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004351 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004352 } else {
4353 assert(0);
4354 }
4355 return skip;
4356}
4357
Jeff Leger178b1e52020-10-05 12:22:23 -04004358bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4359 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4360 const VkImageBlit *pRegions, VkFilter filter) const {
4361 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4362 COPY_COMMAND_VERSION_1);
4363}
4364
4365bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4366 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4367 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4368 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4369}
4370
4371template <typename RegionType>
4372void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4373 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4374 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004375 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004376 auto src_image_state = GetImageState(srcImage);
4377 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004378
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004379 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004380 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004381 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4382 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004383 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004384}
4385
Jeff Leger178b1e52020-10-05 12:22:23 -04004386void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4387 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4388 const VkImageBlit *pRegions, VkFilter filter) {
4389 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4390 pRegions, filter);
4391 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4392}
4393
4394void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4395 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4396 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4397 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4398 pBlitImageInfo->filter);
4399}
4400
John Zulauf2076e812020-01-08 14:55:54 -07004401GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4402 assert(map);
4403 // This approach allows for a single hash lookup or/create new
4404 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4405 if (inserted.second) {
4406 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004407 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004408 inserted.first->second.reset(layout_map);
4409 return layout_map;
4410 } else {
4411 assert(nullptr != inserted.first->second.get());
4412 return inserted.first->second.get();
4413 }
4414 return nullptr;
4415}
4416
4417const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4418 auto it = map.find(image);
4419 if (it != map.end()) {
4420 return it->second.get();
4421 }
4422 return nullptr;
4423}
4424
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004425// 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 -07004426bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4427 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004428 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004429 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004430 GlobalImageLayoutMap &overlay_layout_map = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004431 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004432 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004433 for (const auto &layout_map_entry : pCB->image_layout_map) {
4434 const auto image = layout_map_entry.first;
4435 const auto *image_state = GetImageState(image);
4436 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004437 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004438 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004439 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004440 if (initial_layout_map.empty()) continue;
4441
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004442 auto *overlay_map = GetLayoutRangeMap(&overlay_layout_map, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004443 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4444 if (global_map == nullptr) {
4445 global_map = &empty_map;
4446 }
4447
4448 // Note: don't know if it would matter
4449 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4450
4451 auto pos = initial_layout_map.begin();
4452 const auto end = initial_layout_map.end();
4453 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4454 pos->first.begin);
4455 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004456 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004457 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004458 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 -07004459 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004460 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004461 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004462 image_layout = current_layout->pos_B->lower_bound->second;
4463 }
4464 const auto intersected_range = pos->first & current_layout->range;
4465 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4466 // TODO: Set memory invalid which is in mem_tracker currently
4467 } else if (image_layout != initial_layout) {
4468 // Need to look up the inital layout *state* to get a bit more information
4469 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4470 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4471 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4472 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004473 // We can report all the errors for the intersected range directly
4474 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004475 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004476 skip |= LogError(
4477 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004478 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004479 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004480 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004481 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004482 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004483 }
4484 }
John Zulauf2076e812020-01-08 14:55:54 -07004485 if (pos->first.includes(intersected_range.end)) {
4486 current_layout.seek(intersected_range.end);
4487 } else {
4488 ++pos;
4489 if (pos != end) {
4490 current_layout.seek(pos->first.begin);
4491 }
4492 }
John Zulauff660ad62019-03-23 07:16:05 -06004493 }
4494
locke-lunargf155ccf2020-02-18 11:34:15 -07004495 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004496 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004497 }
John Zulauff660ad62019-03-23 07:16:05 -06004498
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004499 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004500}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004501
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004502void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004503 for (const auto &layout_map_entry : pCB->image_layout_map) {
4504 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004505 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004506 const auto *image_state = GetImageState(image);
4507 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004508 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4509 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004510 }
4511}
4512
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004513// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004514// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4515// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004516bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4517 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004518 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004519 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004520 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4521
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004522 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004523 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4524 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004525 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004526 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4527 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4528 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004529 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004530 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004531 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004532 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4533 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4534 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004535 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004536 string_VkImageLayout(first_layout));
4537 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4538 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004539 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004540 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004541 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004542 }
4543 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004544
4545 // Same as above for loadOp, but for stencilLoadOp
4546 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4547 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4548 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4549 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4550 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004551 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004552 string_VkImageLayout(first_layout));
4553 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4554 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4555 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004556 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004557 string_VkImageLayout(first_layout));
4558 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4559 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4560 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004561 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004562 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004563 }
4564 }
4565
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004566 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004567}
4568
Mark Lobodzinski96210742017-02-09 10:33:46 -07004569// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4570// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004571template <typename T1>
4572bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4573 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4574 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004575 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004576 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004577 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004578 if (strict) {
4579 correct_usage = ((actual & desired) == desired);
4580 } else {
4581 correct_usage = ((actual & desired) != 0);
4582 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004583
Mark Lobodzinski96210742017-02-09 10:33:46 -07004584 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004585 // All callers should have a valid VUID
4586 assert(msgCode != kVUIDUndefined);
4587 skip =
4588 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4589 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004590 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004591 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004592}
4593
4594// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4595// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004596bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004597 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004598 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004599 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004600}
4601
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004602bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004603 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004604 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004605 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4606 if ((image_format_features & desired) != desired) {
4607 // Same error, but more details if it was an AHB external format
4608 if (image_state->has_ahb_format == true) {
4609 skip |= LogError(image_state->image, vuid,
4610 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4611 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4612 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004613 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004614 } else {
4615 skip |= LogError(image_state->image, vuid,
4616 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4617 "with tiling %s.",
4618 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4619 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4620 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004621 }
4622 }
4623 return skip;
4624}
4625
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004626bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004627 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004628 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004629 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004630 // layerCount must not be zero
4631 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004632 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4633 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004634 }
4635 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004636 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004637 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4638 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004639 }
4640 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004641 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 -07004642 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4643 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4644 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4645 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004646 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004647 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4648 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4649 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4650 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4651 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4652 member);
4653 }
Cort Strattond619a302018-05-17 19:46:32 -07004654 return skip;
4655}
4656
Mark Lobodzinski96210742017-02-09 10:33:46 -07004657// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4658// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004659bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004660 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004661 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004662 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004663}
4664
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004665bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004666 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004667 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004668
4669 const VkDeviceSize &range = pCreateInfo->range;
4670 if (range != VK_WHOLE_SIZE) {
4671 // Range must be greater than 0
4672 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004673 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004674 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004675 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4676 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004677 }
4678 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004679 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4680 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004681 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004682 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004683 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4684 "(%" PRIu32 ").",
4685 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004686 }
4687 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004688 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004689 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004690 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004691 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4692 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4693 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004694 }
4695 // The sum of range and offset must be less than or equal to the size of buffer
4696 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004697 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004698 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004699 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4700 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4701 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004702 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004703 } else {
4704 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4705
4706 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4707 // VkPhysicalDeviceLimits::maxTexelBufferElements
4708 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4709 device_limits->maxTexelBufferElements) {
4710 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4711 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4712 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4713 "), divided by the element size of the format (%" PRIu32
4714 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4715 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4716 device_limits->maxTexelBufferElements);
4717 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004718 }
4719 return skip;
4720}
4721
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004722bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004723 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004724 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004725 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4726 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004727 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004728 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004729 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4730 "be supported for uniform texel buffers",
4731 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004732 }
4733 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4734 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004735 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004736 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004737 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4738 "be supported for storage texel buffers",
4739 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004740 }
4741 return skip;
4742}
4743
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004744bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004745 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004746 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004747
Dave Houltond8ed0212018-05-16 17:18:24 -06004748 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004749
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004750 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004751 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004752 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004753 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004754 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4755 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004756 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004757 }
4758 }
4759
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004760 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004761 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004762 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004763 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004764 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004765 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4766 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004767 }
4768 }
4769
Mike Schuchardt2df08912020-12-15 16:28:09 -08004770 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004771 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4772 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004773 skip |= LogError(
4774 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004775 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004776 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004777 }
4778
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004779 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004780 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4781 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4782 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004783 }
4784
sfricke-samsungedce77a2020-07-03 22:35:13 -07004785 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4786 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4787 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4788 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4789 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4790 }
4791 const VkBufferCreateFlags invalid_flags =
4792 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4793 if ((pCreateInfo->flags & invalid_flags) != 0) {
4794 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4795 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4796 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4797 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4798 }
4799 }
4800
Mark Lobodzinski96210742017-02-09 10:33:46 -07004801 return skip;
4802}
4803
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004804bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004805 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004806 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004807 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004808 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4809 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004810 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004811 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4812 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004813 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004814 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4815 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4816 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004817
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004818 // Buffer view offset must be less than the size of buffer
4819 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004820 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004821 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004822 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4823 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004824 }
4825
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004826 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004827 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4828 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4829 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004830 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4831 : "VUID-VkBufferViewCreateInfo-offset-00926";
4832 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004833 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004834 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4835 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004836 }
4837
4838 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004839 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4840 if ((element_size % 3) == 0) {
4841 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004842 }
4843 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004844 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004845 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4846 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004847 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004848 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004849 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004850 skip |= LogError(
4851 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004852 "vkCreateBufferView(): If buffer was created with usage containing "
4853 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004854 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4855 ") must be a multiple of the lesser of "
4856 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4857 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4858 "(%" PRId32
4859 ") is VK_TRUE, the size of a texel of the requested format. "
4860 "If the size of a texel is a multiple of three bytes, then the size of a "
4861 "single component of format is used instead",
4862 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4863 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4864 }
4865 }
4866 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004867 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004868 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4869 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004870 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004871 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004872 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004873 skip |= LogError(
4874 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004875 "vkCreateBufferView(): If buffer was created with usage containing "
4876 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004877 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4878 ") must be a multiple of the lesser of "
4879 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4880 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4881 "(%" PRId32
4882 ") is VK_TRUE, the size of a texel of the requested format. "
4883 "If the size of a texel is a multiple of three bytes, then the size of a "
4884 "single component of format is used instead",
4885 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4886 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4887 }
4888 }
4889 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004890
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004891 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004892
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004893 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004894 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004895 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004896}
4897
Mark Lobodzinski602de982017-02-09 11:01:33 -07004898// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004899bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004900 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004901 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004902 const IMAGE_STATE *image_state = GetImageState(image);
4903 // checks color format and (single-plane or non-disjoint)
4904 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004905 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004906 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004907 skip |= LogError(
4908 image, vuid,
4909 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4910 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004911 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004912 skip |= LogError(image, vuid,
4913 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4914 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4915 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004916 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004917 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004918 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004919 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004920 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4921 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4922 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004923 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004924 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004925 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4926 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4927 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004928 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004929 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004930 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004931 skip |= LogError(image, vuid,
4932 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4933 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4934 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004935 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004936 skip |= LogError(image, vuid,
4937 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4938 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4939 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004940 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004941 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004942 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004943 skip |= LogError(image, vuid,
4944 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4945 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4946 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004947 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004948 skip |= LogError(image, vuid,
4949 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4950 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4951 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004952 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004953 } else if (FormatIsMultiplane(format)) {
4954 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4955 if (3 == FormatPlaneCount(format)) {
4956 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4957 }
4958 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004959 skip |= LogError(image, vuid,
4960 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4961 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4962 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004963 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004964 }
4965 return skip;
4966}
4967
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004968bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4969 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004970 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4971 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004972 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004973
4974 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004975 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004976 skip |= LogError(image, errorCodes.base_mip_err,
4977 "%s: %s.baseMipLevel (= %" PRIu32
4978 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4979 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004980 }
Petr Kraus4d718682017-05-18 03:38:41 +02004981
Petr Krausffa94af2017-08-08 21:46:02 +02004982 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4983 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004984 skip |=
4985 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004986 } else {
4987 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004988
Petr Krausffa94af2017-08-08 21:46:02 +02004989 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004990 skip |= LogError(image, errorCodes.mip_count_err,
4991 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4992 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4993 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4994 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004995 }
Petr Kraus4d718682017-05-18 03:38:41 +02004996 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004997 }
Petr Kraus4d718682017-05-18 03:38:41 +02004998
4999 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02005000 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005001 skip |= LogError(image, errorCodes.base_layer_err,
5002 "%s: %s.baseArrayLayer (= %" PRIu32
5003 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5004 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005005 }
Petr Kraus4d718682017-05-18 03:38:41 +02005006
Petr Krausffa94af2017-08-08 21:46:02 +02005007 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5008 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005009 skip |=
5010 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005011 } else {
5012 const uint64_t necessary_layer_count =
5013 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005014
Petr Krausffa94af2017-08-08 21:46:02 +02005015 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005016 skip |= LogError(image, errorCodes.layer_count_err,
5017 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5018 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5019 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5020 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005021 }
Petr Kraus4d718682017-05-18 03:38:41 +02005022 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005023 }
Petr Kraus4d718682017-05-18 03:38:41 +02005024
Mark Lobodzinski602de982017-02-09 11:01:33 -07005025 return skip;
5026}
5027
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005028bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005029 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005030 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02005031 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08005032 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005033 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 +02005034
David McFarland2853f2f2020-11-30 15:50:39 -04005035 uint32_t image_layer_count;
5036
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005037 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005038 const auto layers = LayersFromRange(subresourceRange);
5039 const auto extent = GetImageSubresourceExtent(image_state, &layers);
5040 image_layer_count = extent.depth;
5041 } else {
5042 image_layer_count = image_state->createInfo.arrayLayers;
5043 }
5044
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005045 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005046
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005047 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5048 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5049 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5050 subresource_range_error_codes.base_layer_err =
5051 is_khr_maintenance1
5052 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
5053 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
5054 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
5055 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5056 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
5057 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005058
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005059 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005060 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005061 image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005062}
5063
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005064bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005065 const VkImageSubresourceRange &subresourceRange,
5066 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005067 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5068 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5069 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5070 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5071 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005072
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005073 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005074 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005075 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005076}
5077
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005078bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005079 const VkImageSubresourceRange &subresourceRange,
5080 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005081 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5082 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5083 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5084 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5085 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005086
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005087 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005088 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005089 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005090}
5091
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005092bool CoreChecks::ValidateImageBarrierSubresourceRange(const CoreErrorLocation &loc, const IMAGE_STATE *image_state,
5093 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005094 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005095 loc.StringFuncName().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image,
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005096 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005097}
5098
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005099namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005100using sync_vuid_maps::GetBarrierQueueVUID;
5101using sync_vuid_maps::kQueueErrorSummary;
5102using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005103
5104class ValidatorState {
5105 public:
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005106 ValidatorState(const ValidationStateTracker *device_data, const LogObjectList &obj, const CoreErrorLocation &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005107 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5108 : device_data_(device_data),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005109 objects_(obj),
5110 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005111 barrier_handle_(barrier_handle),
5112 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005113 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5114 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5115
5116 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5117 // 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 -07005118 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5119 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005120 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005121 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5122 loc_.Message().c_str(), GetTypeString(),
5123 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5124 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005125 }
5126
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005127 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5128 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005129 const char *src_annotation = GetFamilyAnnotation(src_family);
5130 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5131 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005132 objects_, val_code,
5133 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5134 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5135 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005136 }
5137
5138 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5139 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5140 // application input.
5141 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5142 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005143 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005144 uint32_t queue_family = queue_state->queueFamilyIndex;
5145 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005146 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005147 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5148 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5149 return device_data->LogError(
5150 queue_state->queue, val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005151 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005152 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005153 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005154 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005155 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005156 }
5157 return false;
5158 }
5159 // Logical helpers for semantic clarity
5160 inline bool KhrExternalMem() const { return mem_ext_; }
5161 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5162 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5163 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5164 }
5165
5166 // Helpers for LogMsg
5167 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5168
5169 // Descriptive text for the various types of queue family index
5170 const char *GetFamilyAnnotation(uint32_t family) const {
5171 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5172 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5173 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5174 const char *valid = " (VALID)";
5175 const char *invalid = " (INVALID)";
5176 switch (family) {
5177 case VK_QUEUE_FAMILY_EXTERNAL:
5178 return external;
5179 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5180 return foreign;
5181 case VK_QUEUE_FAMILY_IGNORED:
5182 return ignored;
5183 default:
5184 if (IsValid(family)) {
5185 return valid;
5186 }
5187 return invalid;
5188 };
5189 }
5190 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5191 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5192
5193 protected:
5194 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005195 const LogObjectList objects_;
5196 const CoreErrorLocation loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005197 const VulkanTypedHandle barrier_handle_;
5198 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005199 const uint32_t limit_;
5200 const bool mem_ext_;
5201};
5202
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005203bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005204 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5205 bool skip = false;
5206
5207 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5208 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5209 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5210 if (val.KhrExternalMem()) {
5211 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005212 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5213 // this requirement is removed by VK_KHR_synchronization2
5214 if (!(src_ignored || dst_ignored) && !sync2) {
5215 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005216 }
5217 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5218 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005219 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005220 }
5221 } else {
5222 // VK_SHARING_MODE_EXCLUSIVE
5223 if (src_queue_family != dst_queue_family) {
5224 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005225 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005226 }
5227 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005228 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005229 }
5230 }
5231 }
5232 } else {
5233 // No memory extension
5234 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005235 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5236 // this requirement is removed by VK_KHR_synchronization2
5237 if ((!src_ignored || !dst_ignored) && !sync2) {
5238 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005239 }
5240 } else {
5241 // VK_SHARING_MODE_EXCLUSIVE
5242 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005243 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005244 }
5245 }
5246 }
5247 return skip;
5248}
5249} // namespace barrier_queue_families
5250
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005251bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const CoreErrorLocation &loc, const ValidationStateTracker *state_data,
5252 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005253 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5254 uint32_t dst_queue_family) {
5255 using barrier_queue_families::ValidatorState;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005256 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005257 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5258}
5259
5260// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005261template <typename ImgBarrier>
5262bool CoreChecks::ValidateBarrierQueueFamilies(const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5263 const ImgBarrier &barrier, const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005264 // State data is required
5265 if (!state_data) {
5266 return false;
5267 }
5268
5269 // Create the validator state from the image state
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005270 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer), loc,
5271 VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005272 state_data->createInfo.sharingMode);
5273 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5274 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005275 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005276}
5277
5278// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005279template <typename BufBarrier>
5280bool CoreChecks::ValidateBarrierQueueFamilies(const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5281 const BufBarrier &barrier, const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005282 // State data is required
5283 if (!state_data) {
5284 return false;
5285 }
5286
5287 // Create the validator state from the buffer state
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005288 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer), loc,
5289 VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer),
5290 state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005291 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5292 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005293 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5294}
5295
5296template <typename Barrier>
5297bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5298 const Barrier &mem_barrier) const {
5299 using sync_vuid_maps::BufferError;
5300 using sync_vuid_maps::GetBufferBarrierVUID;
5301
5302 bool skip = false;
5303
5304 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5305
5306 // Validate buffer barrier queue family indices
5307 auto buffer_state = GetBufferState(mem_barrier.buffer);
5308 if (buffer_state) {
5309 auto buf_loc = loc.dot(Field::buffer);
5310 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
5311 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFuncName().c_str(), mem_vuid.c_str());
5312
5313 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5314
5315 auto buffer_size = buffer_state->createInfo.size;
5316 if (mem_barrier.offset >= buffer_size) {
5317 auto offset_loc = loc.dot(Field::offset);
5318 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5319
5320 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5321 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5322 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5323 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5324 auto size_loc = loc.dot(Field::size);
5325 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5326 skip |= LogError(objects, vuid,
5327 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5328 ".",
5329 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5330 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5331 }
5332 if (mem_barrier.size == 0) {
5333 auto size_loc = loc.dot(Field::size);
5334 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5335 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5336 report_data->FormatHandle(mem_barrier.buffer).c_str());
5337 }
5338 }
5339 return skip;
5340}
5341
5342template <typename Barrier>
5343bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5344 const Barrier &mem_barrier) const {
5345 bool skip = false;
5346
5347 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5348
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005349 bool is_ilt = true;
5350 if (enabled_features.synchronization2_features.synchronization2) {
5351 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5352 }
5353
5354 if (is_ilt) {
5355 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5356 auto layout_loc = loc.dot(Field::newLayout);
5357 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5358 skip |=
5359 LogError(cb_state->commandBuffer, vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005360 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005361 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005362 }
5363
5364 auto image_data = GetImageState(mem_barrier.image);
5365 if (image_data) {
5366 auto image_loc = loc.dot(Field::image);
5367
5368 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kNoMemory);
5369 skip |= ValidateMemoryIsBoundToImage(image_data, loc.StringFuncName().c_str(), vuid.c_str());
5370
5371 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5372
5373 const auto aspect_mask = mem_barrier.subresourceRange.aspectMask;
5374 skip |= ValidateImageAspectMask(image_data->image, image_data->createInfo.format, aspect_mask, image_loc.Message().c_str());
5375
5376 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
5377 }
5378 return skip;
5379}
5380
5381bool CoreChecks::ValidateBarriers(const CoreErrorLocation &outer_loc, const CMD_BUFFER_STATE *cb_state,
5382 VkPipelineStageFlags src_stage_mask, VkPipelineStageFlags dst_stage_mask,
5383 uint32_t memBarrierCount, const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
5384 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5385 const VkImageMemoryBarrier *pImageMemBarriers) const {
5386 bool skip = false;
5387 auto queue_flags = GetQueueFlags(*cb_state);
5388 LogObjectList objects(cb_state->commandBuffer);
5389 auto op_type =
5390 ComputeBarrierOperationsType(cb_state, bufferBarrierCount, pBufferMemBarriers, imageMemBarrierCount, pImageMemBarriers);
5391
5392 // NOTE: for vkCmdPipelineBarrier() and vkCmdWaitEvents() the access mask checks use the function name for {refpage}
5393 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5394 const auto &mem_barrier = pMemBarriers[i];
5395 CoreErrorLocation loc(outer_loc.func_name, outer_loc.refpage, Field::pMemoryBarriers, i);
5396 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5397 }
5398 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5399 const auto &mem_barrier = pImageMemBarriers[i];
5400 CoreErrorLocation loc(outer_loc.func_name, outer_loc.refpage, Field::pImageMemoryBarriers, i);
5401 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5402
5403 loc.refpage = RefPage::VkImageMemoryBarrier;
5404 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5405 }
5406 {
5407 CoreErrorLocation loc(outer_loc.func_name, RefPage::VkImageMemoryBarrier);
5408 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5409 }
5410 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5411 const auto &mem_barrier = pBufferMemBarriers[i];
5412 CoreErrorLocation loc(outer_loc.func_name, outer_loc.refpage, Field::pBufferMemoryBarriers, i);
5413 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5414
5415 loc.refpage = RefPage::VkBufferMemoryBarrier;
5416 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5417 }
5418 return skip;
5419}
5420
5421bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const CoreErrorLocation &outer_loc,
5422 const CMD_BUFFER_STATE *cb_state, BarrierOperationsType op_type,
5423 const VkDependencyInfoKHR *dep_info) const {
5424 bool skip = false;
5425
5426 if (cb_state->activeRenderPass) {
5427 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5428 if (skip) return true; // Early return to avoid redundant errors from below calls
5429 }
5430 auto queue_flags = GetQueueFlags(*cb_state);
5431 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5432 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
5433 CoreErrorLocation loc = outer_loc.dot(Field::pMemoryBarriers, i);
5434 loc.refpage = RefPage::VkMemoryBarrier2KHR;
5435 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5436 }
5437 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5438 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
5439 CoreErrorLocation loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
5440 loc.refpage = RefPage::VkImageMemoryBarrier2KHR;
5441 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5442 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5443 }
5444 {
5445 CoreErrorLocation loc(outer_loc.func_name, RefPage::VkImageMemoryBarrier2KHR);
5446 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5447 }
5448
5449 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5450 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
5451 CoreErrorLocation loc = outer_loc.dot(Field::pBufferMemoryBarriers, i);
5452 loc.refpage = RefPage::VkBufferMemoryBarrier2KHR;
5453 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5454 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5455 }
5456
5457 return skip;
5458}
5459
5460template <typename Barrier>
5461bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, BarrierOperationsType op_type,
5462 VkQueueFlags queue_flags, const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
5463 VkPipelineStageFlags dst_stage_mask) const {
5464 bool skip = false;
5465 if (op_type == kAllRelease || op_type == kGeneral) {
5466 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5467 }
5468 if (op_type == kAllAcquire || op_type == kGeneral) {
5469 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5470 }
5471 return skip;
5472}
5473
5474template <typename Barrier>
5475bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, BarrierOperationsType op_type,
5476 VkQueueFlags queue_flags, const Barrier &barrier) const {
5477 bool skip = false;
5478 if (op_type == kAllRelease || op_type == kGeneral) {
5479 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
5480 skip |=
5481 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5482 }
5483 if (op_type == kAllAcquire || op_type == kGeneral) {
5484 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
5485 skip |=
5486 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5487 }
5488 return skip;
5489}
5490
5491bool CoreChecks::ValidateSubpassBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, VkQueueFlags queue_flags,
5492 const VkSubpassDependency2 &barrier) const {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005493 bool skip = false;
5494 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(barrier.pNext);
5495 if (mem_barrier) {
5496 if (enabled_features.synchronization2_features.synchronization2) {
5497 if (barrier.srcAccessMask != 0) {
5498 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5499 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5500 loc.dot(Field::srcAccessMask).Message().c_str());
5501 }
5502 if (barrier.dstAccessMask != 0) {
5503 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5504 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5505 loc.dot(Field::dstAccessMask).Message().c_str());
5506 }
5507 if (barrier.srcStageMask != 0 || barrier.dstStageMask != 0) {
5508 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5509 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5510 loc.dot(Field::srcStageMask).Message().c_str());
5511 }
5512 if (barrier.dstStageMask != 0) {
5513 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5514 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5515 loc.dot(Field::dstStageMask).Message().c_str());
5516 }
5517
5518 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc.dot(Field::pNext), kGeneral, queue_flags, *mem_barrier);
5519 return skip;
5520 } else {
5521 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5522 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5523 loc.Message().c_str());
5524 }
5525 }
5526 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc, kGeneral, queue_flags, barrier);
5527 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005528}
5529
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005530bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5531 const VkImageUsageFlags image_usage) const {
5532 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5533 bool skip = false;
5534
5535 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5536 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5537
5538 if (image_state->has_ahb_format == true) {
5539 // AHB image view and image share same feature sets
5540 tiling_features = image_state->format_features;
5541 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5542 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
5543 assert(device_extensions.vk_ext_image_drm_format_modifier);
5544 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5545 nullptr};
5546 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
5547
5548 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5549 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5550 nullptr};
5551 format_properties_2.pNext = (void *)&drm_properties_list;
5552 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5553
5554 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5555 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5556 0) {
5557 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5558 }
5559 }
5560 } else {
5561 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5562 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5563 : format_properties.optimalTilingFeatures;
5564 }
5565
5566 if (tiling_features == 0) {
5567 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
5568 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5569 "physical device.",
5570 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5571 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
5572 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
5573 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5574 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5575 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5576 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
5577 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
5578 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5579 "VK_IMAGE_USAGE_STORAGE_BIT.",
5580 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5581 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
5582 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
5583 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5584 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5585 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5586 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5587 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
5588 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
5589 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5590 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5591 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5592 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5593 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
5594 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
5595 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5596 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5597 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005598 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5599 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5600 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5601 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-04550",
5602 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5603 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5604 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5605 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005606 }
5607
5608 return skip;
5609}
5610
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005611bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005612 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005613 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005614 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005615 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005616 skip |=
5617 ValidateImageUsageFlags(image_state,
5618 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5619 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005620 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5621 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5622 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005623 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005624 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005625 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005626 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005627 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005628 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005629 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005630 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005631
5632 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5633 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005634 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005635 VkFormat view_format = pCreateInfo->format;
5636 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005637 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005638 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005639
Dave Houltonbd2e2622018-04-10 16:41:14 -06005640 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005641 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005642 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005643 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005644 if (!device_extensions.vk_ext_separate_stencil_usage) {
5645 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005646 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5647 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5648 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005649 }
5650 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005651 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005652 if (image_stencil_struct == nullptr) {
5653 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005654 skip |= LogError(
5655 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005656 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5657 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5658 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5659 }
5660 } else {
5661 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5662 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5663 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005664 skip |= LogError(
5665 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005666 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5667 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5668 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5669 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5670 }
5671 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5672 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005673 skip |= LogError(
5674 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005675 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5676 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5677 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5678 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5679 }
5680 }
5681 }
5682 }
5683
Dave Houltonbd2e2622018-04-10 16:41:14 -06005684 image_usage = chained_ivuci_struct->usage;
5685 }
5686
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005687 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5688 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005689 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005690 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005691 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005692 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005693 std::stringstream ss;
5694 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005695 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005696 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005697 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005698 }
5699 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005700 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005701 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5702 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005703 const char *error_vuid;
5704 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5705 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5706 } else if ((device_extensions.vk_khr_maintenance2) &&
5707 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5708 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5709 } else if ((!device_extensions.vk_khr_maintenance2) &&
5710 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5711 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5712 } else {
5713 // both enabled
5714 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5715 }
Dave Houltonc7988072018-04-16 11:46:56 -06005716 std::stringstream ss;
5717 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005718 << " is not in the same format compatibility class as "
5719 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005720 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5721 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005722 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005723 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005724 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005725 }
5726 } else {
5727 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005728 // Unless it is a multi-planar color bit aspect
5729 if ((image_format != view_format) &&
5730 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5731 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5732 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005733 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005734 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005735 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005736 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005737 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005738 }
5739 }
5740
5741 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005742 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005743
5744 switch (image_type) {
5745 case VK_IMAGE_TYPE_1D:
5746 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005747 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5748 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5749 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005750 }
5751 break;
5752 case VK_IMAGE_TYPE_2D:
5753 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5754 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5755 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005756 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5757 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5758 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005759 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005760 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5761 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5762 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005763 }
5764 }
5765 break;
5766 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005767 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005768 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5769 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005770 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005771 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005772 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5773 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5774 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005775 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5776 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005777 skip |= LogError(
5778 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5779 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5780 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5781 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5782 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005783 }
5784 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005785 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5786 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5787 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005788 }
5789 }
5790 } else {
5791 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005792 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5793 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5794 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005795 }
5796 }
5797 break;
5798 default:
5799 break;
5800 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005801
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005802 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005803 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005804 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005805 }
5806
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005807 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005808
Tobias Hector6663c9b2020-11-05 10:18:02 +00005809 if (enabled_features.shading_rate_image.shadingRateImage) {
5810 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5811 if (view_format != VK_FORMAT_R8_UINT) {
5812 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5813 "vkCreateImageView() If image was created with usage containing "
5814 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5815 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005816 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005817 }
5818
5819 if (enabled_features.shading_rate_image.shadingRateImage ||
5820 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5821 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5822 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5823 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5824 "vkCreateImageView() If image was created with usage containing "
5825 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5826 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5827 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005828 }
5829 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005830
Tobias Hector6663c9b2020-11-05 10:18:02 +00005831 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5832 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5833 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5834 pCreateInfo->subresourceRange.layerCount != 1) {
5835 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5836 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5837 pCreateInfo->subresourceRange.layerCount);
5838 }
5839
Jeff Bolz99e3f632020-03-24 22:59:22 -05005840 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5841 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5842 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5843 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5844 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5845 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5846 }
5847 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5848 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5849 skip |= LogError(
5850 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5851 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5852 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5853 }
5854 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005855
5856 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5857 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005858 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005859 "vkCreateImageView(): If image was created with usage containing "
5860 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5861 pCreateInfo->subresourceRange.levelCount);
5862 }
5863 }
5864 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5865 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005866 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005867 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5868 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5869 }
5870 } else {
5871 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5872 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5873 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005874 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005875 "vkCreateImageView(): If image was created with usage containing "
5876 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5877 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5878 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5879 }
5880 }
5881 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005882
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005883 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5884 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5885 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5886 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5887 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5888 }
5889 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5890 skip |=
5891 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5892 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5893 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5894 }
5895 }
5896 if (device_extensions.vk_ext_fragment_density_map_2) {
5897 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5898 (pCreateInfo->subresourceRange.layerCount >
5899 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5900 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5901 "vkCreateImageView(): If image was created with flags containing "
5902 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5903 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5904 pCreateInfo->subresourceRange.layerCount,
5905 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5906 }
5907 }
5908
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005909 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005910 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5911 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5912 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5913 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5914 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5915 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5916 }
5917 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005918
5919 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5920 // If swizzling is disabled, make sure it isn't used
5921 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5922 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5923 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5924 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5925 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5926 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5927 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5928 }
5929
5930 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5931 // disabled
5932 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5933 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5934 // spec. See Github issue #2361.
5935 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5936 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5937 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5938 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5939 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5940 "vkCreateImageView (portability error): ImageView format must have"
5941 " the same number of components and bits per component as the Image's format");
5942 }
5943 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005944 }
5945 return skip;
5946}
5947
Jeff Leger178b1e52020-10-05 12:22:23 -04005948template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005949bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005950 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005951 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005952 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5953 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5954 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005955
5956 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5957 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5958 VkDeviceSize src_min = UINT64_MAX;
5959 VkDeviceSize src_max = 0;
5960 VkDeviceSize dst_min = UINT64_MAX;
5961 VkDeviceSize dst_max = 0;
5962
5963 for (uint32_t i = 0; i < regionCount; i++) {
5964 src_min = std::min(src_min, pRegions[i].srcOffset);
5965 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5966 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5967 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5968
5969 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5970 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005971 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5972 skip |= LogError(src_buffer_state->buffer, vuid,
5973 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5974 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005975 }
5976
5977 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5978 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005979 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5980 skip |= LogError(dst_buffer_state->buffer, vuid,
5981 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5982 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005983 }
5984
5985 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5986 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005987 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5988 skip |= LogError(src_buffer_state->buffer, vuid,
5989 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005990 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005991 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005992 }
5993
5994 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5995 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005996 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5997 skip |= LogError(dst_buffer_state->buffer, vuid,
5998 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005999 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006000 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006001 }
6002 }
6003
6004 // The union of the source regions, and the union of the destination regions, must not overlap in memory
6005 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
6006 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006007 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6008 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
6009 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006010 }
6011 }
6012
6013 return skip;
6014}
6015
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006016bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006017 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006018 const auto cb_node = GetCBState(commandBuffer);
6019 const auto src_buffer_state = GetBufferState(srcBuffer);
6020 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006021
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006022 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006023 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
6024 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006025 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06006026 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006027 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
6028 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06006029 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006030 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
6031 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07006032 skip |=
6033 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6034 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006035 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
6036 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04006037 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07006038 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
6039 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
6040 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006041 return skip;
6042}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006043
Jeff Leger178b1e52020-10-05 12:22:23 -04006044bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6045 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
6046 const auto cb_node = GetCBState(commandBuffer);
6047 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
6048 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
6049
6050 bool skip = false;
6051 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
6052 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
6053 // Validate that SRC & DST buffers have correct usage flags set
6054 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
6055 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
6056 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6057 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
6058 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
6059 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6060 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
6061 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6062 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
6063 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
6064 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
6065 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
6066 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
6067 skip |=
6068 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
6069 skip |=
6070 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
6071 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
6072 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
6073 return skip;
6074}
6075
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006076bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006077 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006078 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006079 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006080 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006081 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6082 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006083 }
6084 }
6085 return skip;
6086}
6087
Jeff Bolz5c801d12019-10-09 10:38:45 -05006088bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6089 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006090 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06006091 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006092
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006093 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006094 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006095 skip |=
6096 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006097 }
6098 return skip;
6099}
6100
Jeff Bolz5c801d12019-10-09 10:38:45 -05006101bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006102 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006103
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006104 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006105 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006106 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006107 }
6108 return skip;
6109}
6110
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006111bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006112 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006113 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06006114 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006115 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006116 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006117 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006118 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006119 }
6120 return skip;
6121}
6122
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006123bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006124 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006125 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006126 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006127 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006128 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07006129 skip |=
6130 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6131 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006132 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006133 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006134 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6135 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006136 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006137
sfricke-samsung022fa252020-07-24 03:26:16 -07006138 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6139 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6140
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006141 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006142 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6143 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6144 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6145 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006146 }
6147
6148 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006149 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6150 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6151 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6152 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006153 }
6154
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006155 return skip;
6156}
6157
Jeff Leger178b1e52020-10-05 12:22:23 -04006158template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006159bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006160 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006161 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006162 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006163 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6164 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006165
sfricke-samsung125d2b42020-05-28 06:32:43 -07006166 assert(image_state != nullptr);
6167 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006168
6169 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006170 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006171 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6172 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006173 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006174 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6175 "and 1, respectively.",
6176 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006177 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006178 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006179
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006180 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6181 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006182 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006183 "%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 -07006184 "must be 0 and 1, respectively.",
6185 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006186 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006187 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006188
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006189 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6190 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006191 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006192 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006193 "For 3D images these must be 0 and 1, respectively.",
6194 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006195 }
6196 }
6197
6198 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006199 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08006200 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
6201 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006202
sfricke-samsung8feecc12021-01-23 03:28:38 -08006203 if (FormatIsDepthOrStencil(image_format)) {
6204 if (SafeModulo(bufferOffset, 4) != 0) {
6205 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
6206 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6207 " must be a multiple 4 if using a depth/stencil format (%s).",
6208 function, i, bufferOffset, string_VkFormat(image_format));
6209 }
6210 } else {
6211 // If not depth/stencil and not multi-plane
6212 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
6213 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
6214 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6215 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
6216 skip |= LogError(image_state->image, vuid,
6217 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6218 " must be a multiple of this format's texel size (%" PRIu32 ").",
6219 function, i, bufferOffset, element_size);
6220 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006221 }
6222
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006223 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6224 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006225 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006226 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006227 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006228 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006229 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006230 }
6231
6232 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6233 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006234 vuid =
6235 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006236 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006237 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006238 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6239 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006240 }
6241
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006242 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006243 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006244 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006245 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 -06006246 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6247 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006248 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006249 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006250 "zero or <= image subresource width (%d).",
6251 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006252 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006253 }
6254
6255 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006256 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 -06006257 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6258 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006259 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006260 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006261 "zero or <= image subresource height (%d).",
6262 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006263 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006264 }
6265
6266 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006267 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 -06006268 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6269 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006270 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006271 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006272 "zero or <= image subresource depth (%d).",
6273 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006274 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006275 }
6276
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006277 // subresource aspectMask must have exactly 1 bit set
6278 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006279 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006280 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006281 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
6282 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006283 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006284 }
6285
6286 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006287 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006288 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006289 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006290 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6291 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006292 }
6293
6294 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006295 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6296 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006297
6298 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006299 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006300 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006301 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006302 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
6303 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006304 }
6305
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006306 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006307 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006308 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006309 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006310 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006311 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006312 }
6313
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006314 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006315 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6316 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6317 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006318 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006319 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006320 "width & height (%d, %d)..",
6321 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6322 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006323 }
6324
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006325 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07006326 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006327 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006328 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006329 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006330 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006331 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006332 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006333
6334 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07006335 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06006336 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006337 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006338 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006339 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006340 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
6341 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6342 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006343 }
6344
6345 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006346 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006347 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006348 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006349 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006350 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
6351 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6352 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006353 }
6354
6355 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006356 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006357 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006358 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006359 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006360 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
6361 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6362 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006363 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006364 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006365
6366 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006367 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006368 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006369 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006370 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006371 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006372 "format has three planes.",
6373 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006374 }
6375
6376 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006377 if (0 ==
6378 (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 -07006379 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006380 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006381 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6382 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006383 } else {
6384 // Know aspect mask is valid
6385 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6386 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006387 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006388 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006389 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006390 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006391 " 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 -08006392 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006393 string_VkFormat(compatible_format));
6394 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006395 }
6396 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006397
6398 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6399 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6400 assert(command_pool != nullptr);
6401 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6402 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6403 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
6404 LogObjectList objlist(cb_node->commandBuffer);
6405 objlist.add(command_pool->commandPool);
6406 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
6407 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6408 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6409 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6410 "VK_QUEUE_COMPUTE_BIT flag.",
6411 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6412 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6413 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006414 }
6415
6416 return skip;
6417}
6418
Jeff Leger178b1e52020-10-05 12:22:23 -04006419template <typename BufferImageCopyRegionType>
6420bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6421 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006422 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006423 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006424
6425 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006426 VkExtent3D extent = pRegions[i].imageExtent;
6427 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006428
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006429 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6430 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006431 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
6432 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6433 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006434 }
6435
6436 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
6437
6438 // 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 -06006439 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006440 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006441 if (image_extent.width % block_extent.width) {
6442 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6443 }
6444 if (image_extent.height % block_extent.height) {
6445 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6446 }
6447 if (image_extent.depth % block_extent.depth) {
6448 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6449 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006450 }
6451
Dave Houltonfc1a4052017-04-27 14:32:45 -06006452 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006453 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006454 }
6455 }
6456
6457 return skip;
6458}
6459
Jeff Leger178b1e52020-10-05 12:22:23 -04006460template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006461bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006462 const BufferImageCopyRegionType *pRegions, const char *func_name,
6463 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006464 bool skip = false;
6465
6466 VkDeviceSize buffer_size = buff_state->createInfo.size;
6467
6468 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07006469 VkDeviceSize max_buffer_offset =
6470 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
6471 if (buffer_size < max_buffer_offset) {
6472 skip |=
6473 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 -07006474 }
6475 }
6476
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006477 return skip;
6478}
6479
Jeff Leger178b1e52020-10-05 12:22:23 -04006480template <typename BufferImageCopyRegionType>
6481bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6482 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6483 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006484 const auto cb_node = GetCBState(commandBuffer);
6485 const auto src_image_state = GetImageState(srcImage);
6486 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006487
Jeff Leger178b1e52020-10-05 12:22:23 -04006488 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6489 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
6490 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
6491 const char *vuid;
6492
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006493 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006494
6495 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006496 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006497
6498 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006499 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006500
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006501 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006502
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006503 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006504 vuid =
6505 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6506 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6507 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6508 "or transfer capabilities.",
6509 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006510 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006511 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
6512 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6513 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6514 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006515
Jeff Leger178b1e52020-10-05 12:22:23 -04006516 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6517 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6518 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6519
6520 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6521 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6522 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6523 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006524
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006525 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006526 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6527 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006528 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006529 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6530 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006531 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006532 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6533 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6534 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6535 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6536 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6537 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006538
6539 // Validation for VK_EXT_fragment_density_map
6540 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006541 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
6542 skip |= LogError(cb_node->commandBuffer, vuid,
6543 "%s: srcImage must not have been created with flags containing "
6544 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6545 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006546 }
6547
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006548 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006549 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6550 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006551 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006552 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
6553 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06006554 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006555
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006556 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 -04006557 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6558 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6559 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6560 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
6561
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006562 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006563 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6564 vuid =
6565 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006566 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006567 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6568 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6569 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6570 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6571 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6572 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6573 "imageSubresource", vuid);
6574 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6575 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006576 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006577 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006578 }
6579 return skip;
6580}
6581
Jeff Leger178b1e52020-10-05 12:22:23 -04006582bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6583 VkBuffer dstBuffer, uint32_t regionCount,
6584 const VkBufferImageCopy *pRegions) const {
6585 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6586 COPY_COMMAND_VERSION_1);
6587}
6588
6589bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6590 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6591 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6592 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6593 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6594}
6595
John Zulauf1686f232019-07-09 16:27:11 -06006596void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6597 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6598 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6599
6600 auto cb_node = GetCBState(commandBuffer);
6601 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006602 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006603 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006604 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006605 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006606}
6607
Jeff Leger178b1e52020-10-05 12:22:23 -04006608void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6609 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6610 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6611
6612 auto cb_node = GetCBState(commandBuffer);
6613 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6614 // Make sure that all image slices record referenced layout
6615 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6616 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6617 pCopyImageToBufferInfo->srcImageLayout);
6618 }
6619}
6620
6621template <typename RegionType>
6622bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6623 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6624 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006625 const auto cb_node = GetCBState(commandBuffer);
6626 const auto src_buffer_state = GetBufferState(srcBuffer);
6627 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006628
Jeff Leger178b1e52020-10-05 12:22:23 -04006629 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6630 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
6631 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
6632 const char *vuid;
6633
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006634 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006635
6636 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006637 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006638
sfricke-samsungea4fd142020-10-17 23:51:59 -07006639 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
6640 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
6641
Jeff Leger178b1e52020-10-05 12:22:23 -04006642 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
6643 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6644 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6645 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6646
6647 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6648 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6649 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6650 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6651 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6652 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6653 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6654 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6655 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006656 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006657 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6658 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006659 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006660 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6661 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6662 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6663 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6664 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6665 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006666
6667 // Validation for VK_EXT_fragment_density_map
6668 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006669 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
6670 skip |= LogError(cb_node->commandBuffer, vuid,
6671 "%s: dstImage must not have been created with flags containing "
6672 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6673 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006674 }
6675
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006676 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006677 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6678 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006679 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006680 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
6681 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06006682 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006683
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006684 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 -04006685 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6686 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6687 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6688 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6689
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006690 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006691 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6692 vuid =
6693 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006694 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006695 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6696 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6697 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6698 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6699 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6700 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6701 "imageSubresource", vuid);
6702 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6703 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006704 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006705 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006706
6707 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6708 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6709 assert(command_pool != nullptr);
6710 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6711 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6712 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6713 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6714 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
6715 LogObjectList objlist(cb_node->commandBuffer);
6716 objlist.add(command_pool->commandPool);
6717 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6718 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
6719 skip |= LogError(dst_image_state->image, vuid,
6720 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6721 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6722 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
6723 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6724 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6725 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006726 }
6727 return skip;
6728}
6729
Jeff Leger178b1e52020-10-05 12:22:23 -04006730bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6731 VkImageLayout dstImageLayout, uint32_t regionCount,
6732 const VkBufferImageCopy *pRegions) const {
6733 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6734 COPY_COMMAND_VERSION_1);
6735}
6736
6737bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6738 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6739 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6740 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6741 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6742}
6743
John Zulauf1686f232019-07-09 16:27:11 -06006744void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6745 VkImageLayout dstImageLayout, uint32_t regionCount,
6746 const VkBufferImageCopy *pRegions) {
6747 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6748
6749 auto cb_node = GetCBState(commandBuffer);
6750 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006751 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006752 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006753 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006754 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006755}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006756
Jeff Leger178b1e52020-10-05 12:22:23 -04006757void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6758 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6759 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6760
6761 auto cb_node = GetCBState(commandBuffer);
6762 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6763 // Make sure that all image slices are record referenced layout
6764 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6765 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6766 pCopyBufferToImageInfo2KHR->dstImageLayout);
6767 }
6768}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006769bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006770 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006771 bool skip = false;
6772 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6773
Dave Houlton1d960ff2018-01-19 12:17:05 -07006774 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006775 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6776 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6777 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006778 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6779 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006780 }
6781
John Zulaufa26d3c82019-08-14 16:09:08 -06006782 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006783 if (!image_entry) {
6784 return skip;
6785 }
6786
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006787 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6788 if (device_extensions.vk_ext_image_drm_format_modifier) {
6789 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6790 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006791 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6792 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6793 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006794 }
6795 } else {
6796 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006797 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6798 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006799 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006800 }
6801
Dave Houlton1d960ff2018-01-19 12:17:05 -07006802 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006803 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006804 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6805 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6806 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006807 }
6808
Dave Houlton1d960ff2018-01-19 12:17:05 -07006809 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006810 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006811 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6812 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6813 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006814 }
6815
Dave Houlton1d960ff2018-01-19 12:17:05 -07006816 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006817 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006818 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6819 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006820 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006821 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6822 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006823 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006824 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6825 }
6826 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006827 skip |= LogError(image, vuid,
6828 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6829 ") must be a single-plane specifier flag.",
6830 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006831 }
6832 } else if (FormatIsColor(img_format)) {
6833 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006834 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6835 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6836 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006837 }
6838 } else if (FormatIsDepthOrStencil(img_format)) {
6839 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6840 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006841 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006842 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6843 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6844 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6845 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006846 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6847 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6848 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006849 }
6850 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006851
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006852 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006853 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006854 }
6855
Mike Weiblen672b58b2017-02-21 14:32:53 -07006856 return skip;
6857}
sfricke-samsung022fa252020-07-24 03:26:16 -07006858
6859// Validates the image is allowed to be protected
6860bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006861 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006862 bool skip = false;
6863 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6864 LogObjectList objlist(cb_state->commandBuffer);
6865 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006866 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 -07006867 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006868 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006869 }
6870 return skip;
6871}
6872
6873// Validates the image is allowed to be unprotected
6874bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006875 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006876 bool skip = false;
6877 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6878 LogObjectList objlist(cb_state->commandBuffer);
6879 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006880 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 -07006881 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006882 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006883 }
6884 return skip;
6885}
6886
6887// Validates the buffer is allowed to be protected
6888bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006889 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006890 bool skip = false;
6891 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6892 LogObjectList objlist(cb_state->commandBuffer);
6893 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006894 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 -07006895 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006896 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006897 }
6898 return skip;
6899}
6900
6901// Validates the buffer is allowed to be unprotected
6902bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006903 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006904 bool skip = false;
6905 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6906 LogObjectList objlist(cb_state->commandBuffer);
6907 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006908 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 -07006909 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006910 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006911 }
6912 return skip;
6913}