blob: a08bebd056cb15c8ed2f87d473107de89aae8d93 [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) {
380 bool matches = (a == b);
381 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700382 a = NormalizeSynchronization2Layout(aspect_mask, a);
383 b = NormalizeSynchronization2Layout(aspect_mask, b);
384 matches = (a == b);
385 if (!matches) {
386 // Relaxed rules when referencing *only* the depth or stencil aspects
387 if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
388 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
389 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
390 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
391 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700392 }
393 }
394 return matches;
395}
396
397// Utility type for ForRange callbacks
398struct LayoutUseCheckAndMessage {
399 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
400 const ImageSubresourceLayoutMap *layout_map;
401 const VkImageAspectFlags aspect_mask;
402 const char *message;
403 VkImageLayout layout;
404
405 LayoutUseCheckAndMessage() = delete;
406 LayoutUseCheckAndMessage(const ImageSubresourceLayoutMap *layout_map_, const VkImageAspectFlags aspect_mask_ = 0)
407 : layout_map(layout_map_), aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
408 bool Check(const VkImageSubresource &subres, VkImageLayout check, VkImageLayout current_layout, VkImageLayout initial_layout) {
409 message = nullptr;
410 layout = kInvalidLayout; // Success status
411 if (current_layout != kInvalidLayout && !ImageLayoutMatches(aspect_mask, check, current_layout)) {
412 message = "previous known";
413 layout = current_layout;
414 } else if ((initial_layout != kInvalidLayout) && !ImageLayoutMatches(aspect_mask, check, initial_layout)) {
415 // To check the relaxed rule matching we need to see how the initial use was used
416 const auto initial_layout_state = layout_map->GetSubresourceInitialLayoutState(subres);
417 assert(initial_layout_state); // If we have an initial layout, we better have a state for it
418 if (!((initial_layout_state->aspect_mask & kDepthOrStencil) &&
419 ImageLayoutMatches(initial_layout_state->aspect_mask, check, initial_layout))) {
420 message = "previously used";
421 layout = initial_layout;
422 }
423 }
424 return layout == kInvalidLayout;
425 }
426};
427
locke-lunarg540b2252020-08-03 13:23:36 -0600428bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600429 if (image_view == compare_view.image_view) {
430 return true;
431 }
locke-lunargdc287022020-08-21 12:03:57 -0600432 if (image_state->image != compare_view.image_state->image) {
433 return false;
434 }
locke-lunarg540b2252020-08-03 13:23:36 -0600435 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
436 return false;
437 }
438
439 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600440 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600441 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600442 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600443 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600444 }
445
446 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600447 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600448 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600449 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600450 }
451
452 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600453 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600454 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600455 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600456 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600457 }
458
459 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600460 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600461 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600462 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600463 }
locke-lunargdc287022020-08-21 12:03:57 -0600464 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600465}
466
Dave Houltond9611312018-11-19 17:03:36 -0700467uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
468 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700469 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700470}
471
472uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
473
474uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
475
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500476bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700477 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700478 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700479
John Zulauf2076e812020-01-08 14:55:54 -0700480 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
481 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700482 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
483 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
484
John Zulauf2076e812020-01-08 14:55:54 -0700485 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
486
487 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
488 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700489 return false;
490 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700491
John Zulauf2076e812020-01-08 14:55:54 -0700492 for (auto entry : *layout_range_map) {
493 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700494 }
495 return true;
496}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700497
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600498// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600499void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600500 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
501 VkImageLayout expected_layout) {
502 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
503 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600504 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600505 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700506 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700507 for (const auto &image : image_state.aliasing_images) {
508 auto alias_state = GetImageState(image);
509 // The map state of the aliases should all be in sync, so no need to check the return value
510 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
511 assert(subresource_map);
512 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
513 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700514}
John Zulauff660ad62019-03-23 07:16:05 -0600515
516// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600517void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600518 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500519 return;
520 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500521 IMAGE_STATE *image_state = view_state.image_state.get();
522 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700523 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700524 for (const auto &image : image_state->aliasing_images) {
525 image_state = GetImageState(image);
526 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
527 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
528 }
John Zulauff660ad62019-03-23 07:16:05 -0600529}
530
531// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600532void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600533 const VkImageSubresourceRange &range, VkImageLayout layout) {
534 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
535 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600536 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700537 for (const auto &image : image_state.aliasing_images) {
538 auto alias_state = GetImageState(image);
539 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
540 assert(subresource_map);
541 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
542 }
John Zulauff660ad62019-03-23 07:16:05 -0600543}
544
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600545void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600546 VkImageLayout layout) {
547 const IMAGE_STATE *image_state = GetImageState(image);
548 if (!image_state) return;
549 SetImageInitialLayout(cb_node, *image_state, range, layout);
550};
551
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600552void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600553 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
554 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600555}
Dave Houltonddd65c52018-05-08 14:58:01 -0600556
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600557// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700558void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
559 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500560 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600561
John Zulauff660ad62019-03-23 07:16:05 -0600562 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600563 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
564 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600565 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 -0600566 sub_range.baseArrayLayer = 0;
567 sub_range.layerCount = image_state->createInfo.extent.depth;
568 }
569
Piers Daniell4fde9b72019-11-27 16:19:46 -0700570 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
571 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
572 SetImageLayout(cb_node, *image_state, sub_range, layout);
573 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
574 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
575 } else {
576 SetImageLayout(cb_node, *image_state, sub_range, layout);
577 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600578}
579
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700580bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
581 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700582 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600583 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100584 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700585 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100586 const char *vuid;
587 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700588 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100589
590 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600591 LogObjectList objlist(image);
592 objlist.add(renderpass);
593 objlist.add(framebuffer);
594 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700595 skip |=
596 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
597 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
598 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
599 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100600 return skip;
601 }
602
603 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700604 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200605 if (stencil_usage_info) {
606 image_usage |= stencil_usage_info->stencilUsage;
607 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100608
609 // Check for layouts that mismatch image usages in the framebuffer
610 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800611 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600612 LogObjectList objlist(image);
613 objlist.add(renderpass);
614 objlist.add(framebuffer);
615 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700616 skip |= LogError(objlist, vuid,
617 "%s: Layout/usage mismatch for attachment %u in %s"
618 " - the %s is %s but the image attached to %s via %s"
619 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
620 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
621 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
622 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100623 }
624
625 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
626 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800627 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600628 LogObjectList objlist(image);
629 objlist.add(renderpass);
630 objlist.add(framebuffer);
631 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700632 skip |= LogError(objlist, vuid,
633 "%s: Layout/usage mismatch for attachment %u in %s"
634 " - the %s is %s but the image attached to %s via %s"
635 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
636 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
637 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
638 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100639 }
640
641 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800642 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600643 LogObjectList objlist(image);
644 objlist.add(renderpass);
645 objlist.add(framebuffer);
646 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700647 skip |= LogError(objlist, vuid,
648 "%s: Layout/usage mismatch for attachment %u in %s"
649 " - the %s is %s but the image attached to %s via %s"
650 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
651 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
652 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
653 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100654 }
655
656 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800657 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600658 LogObjectList objlist(image);
659 objlist.add(renderpass);
660 objlist.add(framebuffer);
661 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700662 skip |= LogError(objlist, vuid,
663 "%s: Layout/usage mismatch for attachment %u in %s"
664 " - the %s is %s but the image attached to %s via %s"
665 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
666 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
667 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
668 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100669 }
670
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600671 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100672 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
673 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
674 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
675 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
676 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800677 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600678 LogObjectList objlist(image);
679 objlist.add(renderpass);
680 objlist.add(framebuffer);
681 objlist.add(image_view);
682 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700683 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700684 " - the %s is %s but the image attached to %s via %s"
685 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700686 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700687 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
688 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100689 }
690 } else {
691 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
692 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
693 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
694 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600695 LogObjectList objlist(image);
696 objlist.add(renderpass);
697 objlist.add(framebuffer);
698 objlist.add(image_view);
699 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700700 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700701 " - the %s is %s but the image attached to %s via %s"
702 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700703 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700704 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
705 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100706 }
707 }
708 return skip;
709}
710
John Zulauf17a01bb2019-08-09 16:41:19 -0600711bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700712 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600713 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600714 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700715 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
716 auto const &framebuffer_info = framebuffer_state->createInfo;
717 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100718
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700719 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100720 auto framebuffer = framebuffer_state->framebuffer;
721
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700722 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700723 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
724 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700725 }
John Zulauf8e308292018-09-21 11:34:37 -0600726
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700727 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800728 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700729 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100730 }
731
Tobias Hectorc9057422019-07-23 12:15:52 +0100732 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700733 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
734 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100735 auto image_view = attachments[i];
736 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100737
Tobias Hectorc9057422019-07-23 12:15:52 +0100738 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600739 LogObjectList objlist(pRenderPassBegin->renderPass);
740 objlist.add(framebuffer_state->framebuffer);
741 objlist.add(image_view);
742 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700743 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
744 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
745 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100746 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100747 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100748
749 const VkImage image = view_state->create_info.image;
750 const IMAGE_STATE *image_state = GetImageState(image);
751
752 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600753 LogObjectList objlist(pRenderPassBegin->renderPass);
754 objlist.add(framebuffer_state->framebuffer);
755 objlist.add(image_view);
756 objlist.add(image);
757 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700758 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
759 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
760 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100761 continue;
762 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700763 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
764 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100765
Piers Daniell7f894f62020-01-09 16:33:48 -0700766 // Default to expecting stencil in the same layout.
767 auto attachment_stencil_initial_layout = attachment_initial_layout;
768
769 // If a separate layout is specified, look for that.
770 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700771 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700772 if (attachment_description_stencil_layout) {
773 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
774 }
775
Tobias Hectorc9057422019-07-23 12:15:52 +0100776 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
777 // in common with the non-const version.)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700778 const ImageSubresourceLayoutMap *subresource_map = (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED)
779 ? GetImageSubresourceLayoutMap(const_p_cb, image)
780 : nullptr;
Tobias Hectorc9057422019-07-23 12:15:52 +0100781
782 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
783 LayoutUseCheckAndMessage layout_check(subresource_map);
784 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700785 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700786 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
787 // the next "constant value" range
788 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700789 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700790
John Zulauf5e617452019-11-19 14:44:16 -0700791 // Allow for differing depth and stencil layouts
792 VkImageLayout check_layout = attachment_initial_layout;
793 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
794
795 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700796 subres_skip |= LogError(
797 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700798 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
799 "and the %s layout of the attachment is %s. The layouts must match, or the render "
800 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700801 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100802 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700803 }
John Zulauf5e617452019-11-19 14:44:16 -0700804
Tobias Hectorc9057422019-07-23 12:15:52 +0100805 skip |= subres_skip;
806 }
807
808 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
809 framebuffer, render_pass, i, "initial layout");
810
811 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
812 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100813 }
814
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700815 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
816 auto &subpass = render_pass_info->pSubpasses[j];
817 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100818 auto &attachment_ref = subpass.pInputAttachments[k];
819 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
820 auto image_view = attachments[attachment_ref.attachment];
821 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100822
Tobias Hectorc9057422019-07-23 12:15:52 +0100823 if (view_state) {
824 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700825 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
826 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100827 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100828 }
829 }
830 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100831
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700832 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100833 auto &attachment_ref = subpass.pColorAttachments[k];
834 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
835 auto image_view = attachments[attachment_ref.attachment];
836 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100837
Tobias Hectorc9057422019-07-23 12:15:52 +0100838 if (view_state) {
839 auto image = view_state->create_info.image;
840 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
841 framebuffer, render_pass, attachment_ref.attachment,
842 "color attachment layout");
843 if (subpass.pResolveAttachments) {
844 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
845 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
846 attachment_ref.attachment, "resolve attachment layout");
847 }
848 }
849 }
850 }
851
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700852 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100853 auto &attachment_ref = *subpass.pDepthStencilAttachment;
854 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
855 auto image_view = attachments[attachment_ref.attachment];
856 auto view_state = GetImageViewState(image_view);
857
858 if (view_state) {
859 auto image = view_state->create_info.image;
860 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
861 framebuffer, render_pass, attachment_ref.attachment,
862 "input attachment layout");
863 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100864 }
865 }
866 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700867 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600868 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700869}
870
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600871void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700872 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700873 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinski8d46f802020-12-07 16:33:54 -0700874 IMAGE_VIEW_STATE *image_view = GetActiveAttachmentImageViewState(pCB, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600875 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700876 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700877 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700878 if (attachment_reference_stencil_layout) {
879 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
880 }
881
882 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600883 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700884 }
885}
886
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600887void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
888 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700889 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700890
891 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700892 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700893 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700894 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700895 }
896 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700897 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700898 }
899 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700900 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700901 }
902 }
903}
904
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700905// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
906// 1. Transition into initialLayout state
907// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600908void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700909 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700910 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700911 auto const rpci = render_pass_state->createInfo.ptr();
912 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -0700913 auto *view_state = GetActiveAttachmentImageViewState(cb_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600914 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700915 IMAGE_STATE *image_state = view_state->image_state.get();
916 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700917 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700918 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700919 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700920 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
921 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
922 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
923 SetImageInitialLayout(cb_state, *image_state, sub_range, initial_layout);
924 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
925 SetImageInitialLayout(cb_state, *image_state, sub_range, stencil_initial_layout);
926 } else {
927 SetImageInitialLayout(cb_state, *image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700928 }
John Zulauf8e308292018-09-21 11:34:37 -0600929 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700930 }
931 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700932 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700933}
934
Dave Houlton10b39482017-03-16 13:18:15 -0600935bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600936 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600937 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600938 }
939 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600940 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600941 }
942 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600943 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600944 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800945 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 -0700946 if (FormatPlaneCount(format) == 1) return false;
947 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600948 return true;
949}
950
Mike Weiblen62d08a32017-03-07 22:18:27 -0700951// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700952bool CoreChecks::ValidateBarrierLayoutToImageUsage(const CoreErrorLocation &loc, VkImage image, VkImageLayout layout,
953 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700954 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700955 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700956 switch (layout) {
957 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700958 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700959 break;
960 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_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_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700964 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700965 break;
966 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700967 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700968 break;
969 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700970 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700971 break;
972 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700973 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700974 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600975 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700976 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500977 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700978 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_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;
981 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700982 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700983 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700984 default:
985 // Other VkImageLayout values do not have VUs defined in this context.
986 break;
987 }
988
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700989 if (is_error) {
990 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
991
992 skip |=
993 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
994 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700995 }
996 return skip;
997}
998
999// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001000template <typename ImageBarrier>
1001bool CoreChecks::ValidateBarriersToImages(const CoreErrorLocation &outer_loc, const CMD_BUFFER_STATE *cb_state,
1002 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001003 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001004 using sync_vuid_maps::GetImageBarrierVUID;
1005 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +02001006 // Scoreboard for checking for duplicate and inconsistent barriers to images
1007 struct ImageBarrierScoreboardEntry {
1008 uint32_t index;
1009 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
1010 // 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 -07001011 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +02001012 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001013 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
1014 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
1015 // when creating maps full of maps.
1016 struct ImageBarrierScoreboardSubresMap {
1017 std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
1018 };
Petr Krausad0096a2019-08-09 18:35:04 +02001019 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
1020
John Zulauf463c51e2018-05-31 13:29:20 -06001021 // Scoreboard for duplicate layout transition barriers within the list
1022 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
1023 ImageBarrierScoreboardImageMap layout_transitions;
1024
Mike Weiblen62d08a32017-03-07 22:18:27 -07001025 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001026 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +02001027 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -07001028
John Zulauf463c51e2018-05-31 13:29:20 -06001029 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
1030 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
1031 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +02001032 if (img_barrier.oldLayout != img_barrier.newLayout) {
1033 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
1034 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -06001035 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001036 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +02001037 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -06001038 if (subres_it != subres_map.end()) {
1039 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001040 auto entry_layout =
1041 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
1042 auto old_layout =
1043 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
1044 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +02001045 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001046 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001047 skip = LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001048 cb_state->commandBuffer, vuid,
1049 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -06001050 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
1051 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001052 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +02001053 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
1054 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -06001055 }
1056 entry = new_entry;
1057 } else {
Petr Krausad0096a2019-08-09 18:35:04 +02001058 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001059 }
1060 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001061 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001062 }
1063 }
1064
Petr Krausad0096a2019-08-09 18:35:04 +02001065 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001066 if (image_state) {
1067 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001068 skip |=
1069 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
1070 skip |=
1071 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001072
1073 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
1074 if (image_state->layout_locked) {
1075 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001076 skip |= LogError(
1077 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001078 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001079 " 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 -07001080 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1081 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001082 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001083
John Zulaufa4472282019-08-22 14:44:34 -06001084 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -07001085 const VkFormat image_format = image_create_info.format;
1086 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -06001087 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001088 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -07001089 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001090 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06001091 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001092 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
1093 skip |= LogError(img_barrier.image, vuid,
1094 "%s references %s of format %s that must have either the depth or stencil "
1095 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1096 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1097 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001098 }
1099 } else {
1100 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1101 if ((aspect_mask & ds_mask) != (ds_mask)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001102 auto error = device_extensions.vk_khr_separate_depth_stencil_layouts
1103 ? ImageError::kNotSeparateDepthAndStencilAspect
1104 : ImageError::kNotDepthAndStencilAspect;
1105 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -07001106 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001107 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001108 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001109 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001110 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001111 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001112 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001113 }
John Zulauff660ad62019-03-23 07:16:05 -06001114
Petr Krausad0096a2019-08-09 18:35:04 +02001115 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1116 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001117 // TODO: Set memory invalid which is in mem_tracker currently
1118 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1119 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001120 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001121 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001122 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001123 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001124 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1125 // the next "constant value" range
1126 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001127 const auto &value = *pos;
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001128 auto old_layout =
1129 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
1130 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001131 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
1132 subres_skip = LogError(cb_state->commandBuffer, vuid,
1133 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
1134 "%s layout is %s.",
1135 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1136 value.subresource.aspectMask, value.subresource.mipLevel,
1137 value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1138 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001139 }
John Zulauf5e617452019-11-19 14:44:16 -07001140 }
John Zulauff660ad62019-03-23 07:16:05 -06001141 skip |= subres_skip;
1142 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001143
1144 // checks color format and (single-plane or non-disjoint)
1145 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1146 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001147 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001148 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001149 auto error = device_extensions.vk_khr_sampler_ycbcr_conversion ? ImageError::kNotColorAspect
1150 : ImageError::kNotColorAspectYcbcr;
1151 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -07001152 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001153 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -07001154 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001155 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001156 string_VkFormat(image_format), aspect_mask);
1157 }
1158 }
1159
1160 VkImageAspectFlags valid_disjoint_mask =
1161 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 -07001162 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001163 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001164 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
1165 skip |= LogError(img_barrier.image, vuid,
1166 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -07001167 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001168 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001169 string_VkFormat(image_format), aspect_mask);
1170 }
1171
1172 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001173 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1174 skip |= LogError(img_barrier.image, vuid,
1175 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -07001176 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001177 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001178 string_VkFormat(image_format), aspect_mask);
1179 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001180 }
1181 }
1182 return skip;
1183}
1184
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001185template <typename Barrier, typename TransferBarrier>
1186bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
1187 const Barrier &barrier,
1188 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001189 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001190 auto pool = cb_state->command_pool.get();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001191 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001192 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001193 if (!IsTransferOp(barrier)) {
1194 return skip;
1195 }
1196 const TransferBarrier *barrier_record = nullptr;
1197 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, barrier) &&
1198 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1199 const auto found = barrier_sets.release.find(barrier);
1200 if (found != barrier_sets.release.cend()) {
1201 barrier_record = &(*found);
1202 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001203 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001204 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, barrier) &&
1205 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1206 const auto found = barrier_sets.acquire.find(barrier);
1207 if (found != barrier_sets.acquire.cend()) {
1208 barrier_record = &(*found);
1209 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001210 }
1211 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001212 if (barrier_record != nullptr) {
1213 skip |=
1214 LogWarning(cb_state->commandBuffer, TransferBarrier::ErrMsgDuplicateQFOInCB(),
1215 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1216 " duplicates existing barrier recorded in this command buffer.",
1217 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1218 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1219 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001220 return skip;
1221}
1222
John Zulaufa4472282019-08-22 14:44:34 -06001223VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1224 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1225}
1226
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001227VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1228 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1229}
1230
John Zulaufa4472282019-08-22 14:44:34 -06001231const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1232 return device_state.GetImageState(barrier.image);
1233}
1234
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001235const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1236 return device_state.GetImageState(barrier.image);
1237}
1238
John Zulaufa4472282019-08-22 14:44:34 -06001239VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1240 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1241}
1242
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001243VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1244 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1245}
1246
John Zulaufa4472282019-08-22 14:44:34 -06001247const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1248 return device_state.GetBufferState(barrier.buffer);
1249}
1250
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001251const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1252 return device_state.GetBufferState(barrier.buffer);
1253}
John Zulaufa4472282019-08-22 14:44:34 -06001254
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001255template <typename Barrier, typename TransferBarrier>
1256void CoreChecks::RecordBarrierValidationInfo(const CoreErrorLocation &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
1257 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001258 auto pool = cb_state->command_pool.get();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001259 if (IsTransferOp(barrier)) {
1260 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, barrier) &&
1261 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1262 barrier_sets.release.emplace(barrier);
1263 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, barrier) &&
1264 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1265 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001266 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001267 }
John Zulaufa4472282019-08-22 14:44:34 -06001268
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001269 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1270 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1271 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1272 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1273 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1274 auto handle_state = BarrierHandleState(*this, barrier);
1275 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1276 if (!mode_concurrent) {
1277 const auto typed_handle = BarrierTypedHandle(barrier);
John Zulaufb4438f02021-02-20 20:22:16 -07001278 CoreErrorLocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001279 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001280 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1281 const QUEUE_STATE *queue_state) {
1282 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001283 src_queue_family, dst_queue_family);
1284 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001285 }
1286 }
1287}
1288
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001289// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001290template <typename ImgBarrier>
1291bool CoreChecks::ValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001292 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1293 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001294 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1295 using sync_vuid_maps::GetImageBarrierVUID;
1296 using sync_vuid_maps::ImageError;
1297
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001298 bool skip = false;
1299 const auto *fb_state = framebuffer;
1300 assert(fb_state);
1301 const auto img_bar_image = img_barrier.image;
1302 bool image_match = false;
1303 bool sub_image_found = false; // Do we find a corresponding subpass description
1304 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1305 uint32_t attach_index = 0;
1306 // Verify that a framebuffer image matches barrier image
1307 const auto attachment_count = fb_state->createInfo.attachmentCount;
1308 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
1309 auto view_state = GetActiveAttachmentImageViewState(cb_state, attachment, primary_cb_state);
1310 if (view_state && (img_bar_image == view_state->create_info.image)) {
1311 image_match = true;
1312 attach_index = attachment;
1313 break;
1314 }
1315 }
1316 if (image_match) { // Make sure subpass is referring to matching attachment
1317 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1318 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1319 sub_image_found = true;
1320 }
1321 if (!sub_image_found && device_extensions.vk_khr_depth_stencil_resolve) {
1322 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1323 if (resolve && resolve->pDepthStencilResolveAttachment &&
1324 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1325 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1326 sub_image_found = true;
1327 }
1328 }
1329 if (!sub_image_found) {
1330 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1331 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1332 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1333 sub_image_found = true;
1334 break;
1335 }
1336 if (!sub_image_found && sub_desc.pResolveAttachments &&
1337 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1338 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1339 sub_image_found = true;
1340 break;
1341 }
1342 }
1343 }
1344 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001345 auto img_loc = loc.dot(Field::image);
1346 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1347 skip |=
1348 LogError(rp_handle, vuid,
1349 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1350 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1351 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001352 }
1353 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001354 auto img_loc = loc.dot(Field::image);
1355 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1356 skip |= LogError(fb_state->framebuffer, vuid, "%s Barrier for %s does not match an image from the current %s.",
1357 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
1358 report_data->FormatHandle(fb_state->framebuffer).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001359 }
1360 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001361 auto layout_loc = loc.dot(Field::oldLayout);
1362 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1363 skip |= LogError(cb_state->commandBuffer, vuid,
1364 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001365 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001366 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001367 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1368 } else {
1369 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1370 LogObjectList objlist(rp_handle);
1371 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001372 auto layout_loc = loc.dot(Field::oldLayout);
1373 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1374 skip |= LogError(objlist, vuid,
1375 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001376 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001377 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001378 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1379 string_VkImageLayout(img_barrier.oldLayout));
1380 }
1381 }
1382 return skip;
1383}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001384// explictly instantiate so these can be used in core_validation.cpp
1385template bool CoreChecks::ValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE const *cb_state,
1386 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1387 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1388 const VkImageMemoryBarrier &img_barrier,
1389 const CMD_BUFFER_STATE *primary_cb_state) const;
1390template bool CoreChecks::ValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE const *cb_state,
1391 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1392 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1393 const VkImageMemoryBarrier2KHR &img_barrier,
1394 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001395
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001396template <typename ImgBarrier>
1397void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE *cb_state,
1398 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001399 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1400 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1401 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1402 const auto active_subpass = cb_state->activeSubpass;
1403 const auto rp_state = cb_state->activeRenderPass;
1404 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001405 // Secondary CB case w/o FB specified delay validation
1406 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
John Zulaufb4438f02021-02-20 20:22:16 -07001407 CoreErrorLocationCapture loc_capture(loc);
1408 const auto render_pass = rp_state->renderPass;
1409 cb_state->cmd_execute_commands_functions.emplace_back(
1410 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1411 const FRAMEBUFFER_STATE *fb) {
1412 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1413 render_pass, barrier, primary_cb);
1414 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001415 }
1416}
1417
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001418void CoreChecks::RecordBarriers(ErrFunc func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1419 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1420 const VkImageMemoryBarrier *pImageMemBarriers) {
1421 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
1422 CoreErrorLocation loc(func_name, RefPage::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
1423 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1424 }
1425 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
1426 CoreErrorLocation loc(func_name, RefPage::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
1427 const auto &img_barrier = pImageMemBarriers[i];
1428 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1429 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1430 }
1431}
1432
1433void CoreChecks::RecordBarriers(ErrFunc func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
1434 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
1435 CoreErrorLocation loc(func_name, RefPage::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
1436 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1437 }
1438 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
1439 CoreErrorLocation loc(func_name, RefPage::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
1440 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1441 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1442 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1443 }
1444}
1445
1446template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001447bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001448 const char *operation, const TransferBarrier &barrier,
1449 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001450 // Record to the scoreboard or report that we have a duplication
1451 bool skip = false;
1452 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1453 if (!inserted.second && inserted.first->second != cb_state) {
1454 // 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 -06001455 LogObjectList objlist(cb_state->commandBuffer);
1456 objlist.add(barrier.handle);
1457 objlist.add(inserted.first->second->commandBuffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001458 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001459 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1460 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001461 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001462 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1463 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001464 }
1465 return skip;
1466}
1467
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001468template <typename TransferBarrier>
1469bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1470 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1471 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001472 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001473 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TransferBarrier());
1474 const char *barrier_name = TransferBarrier::BarrierName();
1475 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001476 // No release should have an extant duplicate (WARNING)
1477 for (const auto &release : cb_barriers.release) {
1478 // Check the global pending release barriers
1479 const auto set_it = global_release_barriers.find(release.handle);
1480 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001481 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001482 const auto found = set_for_handle.find(release);
1483 if (found != set_for_handle.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001484 skip |= LogWarning(cb_state->commandBuffer, TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001485 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1486 " to dstQueueFamilyIndex %" PRIu32
1487 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1488 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1489 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001490 }
1491 }
1492 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1493 }
1494 // Each acquire must have a matching release (ERROR)
1495 for (const auto &acquire : cb_barriers.acquire) {
1496 const auto set_it = global_release_barriers.find(acquire.handle);
1497 bool matching_release_found = false;
1498 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001499 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001500 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1501 }
1502 if (!matching_release_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001503 skip |= LogError(cb_state->commandBuffer, TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001504 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1505 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1506 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1507 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001508 }
1509 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1510 }
1511 return skip;
1512}
1513
John Zulauf3b04ebd2019-07-18 14:08:11 -06001514bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001515 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1516 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001517 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001518 skip |=
1519 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1520 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1521 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001522 return skip;
1523}
1524
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001525template <typename TransferBarrier>
1526void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1527 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001528 // Add release barriers from this submit to the global map
1529 for (const auto &release : cb_barriers.release) {
1530 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1531 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1532 global_release_barriers[release.handle].insert(release);
1533 }
1534
1535 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1536 for (const auto &acquire : cb_barriers.acquire) {
1537 // NOTE: We're not using [] because we don't want to create entries for missing releases
1538 auto set_it = global_release_barriers.find(acquire.handle);
1539 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001540 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001541 set_for_handle.erase(acquire);
1542 if (set_for_handle.size() == 0) { // Clean up empty sets
1543 global_release_barriers.erase(set_it);
1544 }
1545 }
1546 }
1547}
1548
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001549void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001550 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1551 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1552 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001553}
1554
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001555template <typename ImgBarrier>
1556void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1557 // For ownership transfers, the barrier is specified twice; as a release
1558 // operation on the yielding queue family, and as an acquire operation
1559 // on the acquiring queue family. This barrier may also include a layout
1560 // transition, which occurs 'between' the two operations. For validation
1561 // purposes it doesn't seem important which side performs the layout
1562 // transition, but it must not be performed twice. We'll arbitrarily
1563 // choose to perform it as part of the acquire operation.
1564 //
1565 // However, we still need to record initial layout for the "initial layout" validation
1566 for (uint32_t i = 0; i < barrier_count; i++) {
1567 const auto &mem_barrier = barriers[i];
John Zulauf2be3fe02019-12-30 09:48:02 -07001568 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001569 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001570 if (image_state) {
1571 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1572 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001573 }
1574}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001575// explictly instantiate this template so it can be used in core_validation.cpp
1576template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1577 const VkImageMemoryBarrier *barrier);
1578template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1579 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001580
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001581VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1582
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001583template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001584void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001585 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001586 if (enabled_features.synchronization2_features.synchronization2) {
1587 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1588 return;
1589 }
1590 }
unknown86bcb3a2019-07-11 13:05:36 -06001591 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1592 const auto &image_create_info = image_state->createInfo;
1593
Mike Schuchardt2df08912020-12-15 16:28:09 -08001594 // 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 -07001595 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
unknown86bcb3a2019-07-11 13:05:36 -06001596 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001597 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001598 normalized_isr.baseArrayLayer = 0;
1599 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1600 }
1601
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001602 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1603 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001604
1605 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001606 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001607 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1608 }
1609
John Zulauf2be3fe02019-12-30 09:48:02 -07001610 if (is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001611 SetImageInitialLayout(cb_state, *image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001612 } else {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001613 SetImageLayout(cb_state, *image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001614 }
unknown86bcb3a2019-07-11 13:05:36 -06001615}
1616
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001617bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1618 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1619 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1620 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001621 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001622 assert(cb_node);
1623 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001624 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001625 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001626
John Zulauff660ad62019-03-23 07:16:05 -06001627 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1628 if (subresource_map) {
1629 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001630 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001631 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1632 // the next "constant value" range
1633 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001634 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001635 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001636 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1637 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1638 "%s layout %s.",
1639 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1640 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1641 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001642 }
John Zulauf5e617452019-11-19 14:44:16 -07001643 }
John Zulauff660ad62019-03-23 07:16:05 -06001644 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001645 }
John Zulauff660ad62019-03-23 07:16:05 -06001646
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001647 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1648 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1649 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001650 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1651 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001652 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1653 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1654 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001655 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001656 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001657 if (image_state->shared_presentable) {
1658 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001659 skip |=
1660 LogError(device, layout_invalid_msg_code,
1661 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1662 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001663 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001664 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001665 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001666 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001667 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1668 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1669 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1670 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001671 }
1672 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001673 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001674}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001675bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001676 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1677 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001678 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001679 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1680 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1681}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001682
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001683void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001684 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001685 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1686 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001687
Mike Schuchardt2df08912020-12-15 16:28:09 -08001688 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001689 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001690 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001691 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001692 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001693 VkImageLayout stencil_layout = kInvalidLayout;
1694 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001695 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001696 if (attachment_description_stencil_layout) {
1697 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1698 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001699 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001700 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001701 }
1702 }
1703}
Dave Houltone19e20d2018-02-02 16:32:41 -07001704
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001705#ifdef VK_USE_PLATFORM_ANDROID_KHR
1706// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1707// This could also move into a seperate core_validation_android.cpp file... ?
1708
1709//
1710// AHB-specific validation within non-AHB APIs
1711//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001712bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001713 bool skip = false;
1714
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001715 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001716 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001717 if (0 != ext_fmt_android->externalFormat) {
1718 if (VK_FORMAT_UNDEFINED != create_info->format) {
1719 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001720 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1721 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1722 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001723 }
1724
1725 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001726 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1727 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1728 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001729 }
1730
1731 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001732 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1733 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001734 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1735 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1736 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001737 }
1738
1739 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001740 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1741 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1742 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001743 }
1744 }
1745
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001746 if ((0 != ext_fmt_android->externalFormat) &&
1747 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001748 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001749 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1750 ") which has "
1751 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1752 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001753 }
1754 }
1755
Dave Houltond9611312018-11-19 17:03:36 -07001756 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001757 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001758 skip |=
1759 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1760 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1761 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001762 }
1763 }
1764
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001765 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001766 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1767 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001768 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001769 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1770 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1771 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1772 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001773 }
1774
1775 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001776 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1777 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1778 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1779 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1780 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001781 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001782 }
1783
1784 return skip;
1785}
1786
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001787bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001788 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001789 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001790
1791 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001792 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001793 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1794 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001795 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001796 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001797 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001798
Dave Houltond9611312018-11-19 17:03:36 -07001799 // Chain must include a compatible ycbcr conversion
1800 bool conv_found = false;
1801 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001802 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001803 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001804 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001805 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001806 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001807 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001808 }
Dave Houltond9611312018-11-19 17:03:36 -07001809 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001810 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001811 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001812 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1813 "an externalFormat (%" PRIu64
1814 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1815 "with the same external format.",
1816 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001817 }
1818
1819 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001820 if (IsIdentitySwizzle(create_info->components) == false) {
1821 skip |= LogError(
1822 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1823 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1824 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1825 "= %s.",
1826 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1827 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001828 }
1829 }
Dave Houltond9611312018-11-19 17:03:36 -07001830
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001831 return skip;
1832}
1833
John Zulaufa26d3c82019-08-14 16:09:08 -06001834bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001835 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001836
John Zulaufa26d3c82019-08-14 16:09:08 -06001837 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001838 if (image_state != nullptr) {
1839 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1840 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1841 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1842 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1843 "bound to memory.");
1844 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001845 }
1846 return skip;
1847}
1848
1849#else
1850
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001851bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001852 return false;
1853}
1854
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001855bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001856
John Zulaufa26d3c82019-08-14 16:09:08 -06001857bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001858
1859#endif // VK_USE_PLATFORM_ANDROID_KHR
1860
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001861bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1862 bool skip = false;
1863
1864 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1865 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1866 const VkImageTiling image_tiling = pCreateInfo->tiling;
1867 const VkFormat image_format = pCreateInfo->format;
1868
1869 if (image_format == VK_FORMAT_UNDEFINED) {
1870 // VU 01975 states format can't be undefined unless an android externalFormat
1871#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001872 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001873 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1874 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1875 if (it != ahb_ext_formats_map.end()) {
1876 tiling_features = it->second;
1877 }
1878 }
1879#endif
1880 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1881 uint64_t drm_format_modifier = 0;
1882 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001883 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001884 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001885 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001886
1887 if (drm_explicit != nullptr) {
1888 drm_format_modifier = drm_explicit->drmFormatModifier;
1889 } else {
1890 // VUID 02261 makes sure its only explict or implict in parameter checking
1891 assert(drm_implicit != nullptr);
1892 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1893 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1894 }
1895 }
1896
1897 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1898 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1899 nullptr};
1900 format_properties_2.pNext = (void *)&drm_properties_list;
1901 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001902 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1903 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1904 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1905 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001906
1907 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1908 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1909 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1910 }
1911 }
1912 } else {
1913 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1914 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1915 : format_properties.optimalTilingFeatures;
1916 }
1917
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001918 // Lack of disjoint format feature support while using the flag
1919 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1920 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1921 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1922 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1923 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1924 string_VkFormat(pCreateInfo->format));
1925 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001926
1927 return skip;
1928}
1929
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001930bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001931 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001932 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001933
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001934 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001935 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001936 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1937 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001938 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1939 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001940 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001941 }
1942
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001943 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1944 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001945 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1946 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1947 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001948 }
1949
1950 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001951 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1952 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1953 "height (%d) and arrayLayers (%d) must be >= 6.",
1954 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001955 }
Dave Houlton130c0212018-01-29 13:39:56 -07001956 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001957
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001958 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001959 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1960 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1961 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001962 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001963 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1964 "device maxFramebufferWidth (%u).",
1965 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001966 }
1967
1968 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001969 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001970 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1971 "device maxFramebufferHeight (%u).",
1972 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001973 }
1974
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001975 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001976 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1977 static_cast<float>(device_limits->maxFramebufferWidth) /
1978 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001979 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1980 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001981 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1982 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1983 "ceiling of device "
1984 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1985 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1986 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001987 }
1988
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001989 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1990 static_cast<float>(device_limits->maxFramebufferHeight) /
1991 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001992 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1993 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001994 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1995 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1996 "ceiling of device "
1997 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1998 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1999 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07002000 }
2001 }
2002
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002003 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06002004 VkResult result = VK_SUCCESS;
2005 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
2006 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
2007 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
2008 &format_limits);
2009 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002010 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
2011 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002012 if (modifier_list) {
2013 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002014 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002015 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002016 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002017 image_format_info.type = pCreateInfo->imageType;
2018 image_format_info.format = pCreateInfo->format;
2019 image_format_info.tiling = pCreateInfo->tiling;
2020 image_format_info.usage = pCreateInfo->usage;
2021 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002022 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002023
2024 result =
2025 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
2026 format_limits = image_format_properties.imageFormatProperties;
2027
2028 /* The application gives a list of modifier and the driver
2029 * selects one. If one is wrong, stop there.
2030 */
2031 if (result != VK_SUCCESS) break;
2032 }
2033 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002034 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002035 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002036 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002037 image_format_info.type = pCreateInfo->imageType;
2038 image_format_info.format = pCreateInfo->format;
2039 image_format_info.tiling = pCreateInfo->tiling;
2040 image_format_info.usage = pCreateInfo->usage;
2041 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002042 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002043
2044 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
2045 format_limits = image_format_properties.imageFormatProperties;
2046 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06002047 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06002048
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002049 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
2050 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
2051 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
2052 if (result != VK_SUCCESS) {
2053 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06002054#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002055 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06002056#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002057 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07002058 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002059 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
2060 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002061#ifdef VK_USE_PLATFORM_ANDROID_KHR
2062 }
2063#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002064 } else {
2065 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
2066 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002067 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
2068 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
2069 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002070 }
Dave Houlton130c0212018-01-29 13:39:56 -07002071
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002072 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
2073 static_cast<uint64_t>(pCreateInfo->extent.height) *
2074 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
2075 static_cast<uint64_t>(pCreateInfo->samples);
2076 uint64_t total_size =
2077 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07002078
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002079 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002080 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
2081 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002082 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002083
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002084 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002085 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
2086 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
2087 ", maximum resource size = 0x%" PRIxLEAST64 " ",
2088 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002089 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002090
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002091 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002092 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
2093 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
2094 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002095 }
2096
2097 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002098 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
2099 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
2100 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002101 }
sfricke-samsung612f3622020-06-20 20:42:46 -07002102
2103 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
2104 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
2105 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
2106 pCreateInfo->extent.width, format_limits.maxExtent.width);
2107 }
2108
2109 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
2110 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
2111 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
2112 pCreateInfo->extent.height, format_limits.maxExtent.height);
2113 }
2114
2115 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
2116 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
2117 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
2118 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
2119 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002120 }
2121
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002122 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08002123 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
2124 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
2125 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
2126 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002127 skip |= LogError(device, error_vuid,
2128 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
2129 "YCbCr Conversion format, arrayLayers must be 1",
2130 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002131 }
2132
2133 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002134 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
2135 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
2136 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002137 }
2138
2139 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002140 skip |= LogError(
2141 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08002142 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
2143 string_VkSampleCountFlagBits(pCreateInfo->samples));
2144 }
2145
2146 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002147 skip |= LogError(
2148 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08002149 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2150 string_VkImageType(pCreateInfo->imageType));
2151 }
2152 }
2153
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002154 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002155 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07002156 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06002157 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002158 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2159 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2160 "format must be block, ETC or ASTC compressed, but is %s",
2161 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002162 }
2163 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002164 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2165 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2166 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002167 }
2168 }
2169 }
2170
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002171 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002172 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
2173 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
2174 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002175 }
2176
unknown2c877272019-07-11 12:56:50 -06002177 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2178 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2179 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002180 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2181 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2182 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002183 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002184
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002185 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002186 if (swapchain_create_info != nullptr) {
2187 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2188 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2189 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2190
2191 // Validate rest of Swapchain Image create check that require swapchain state
2192 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2193 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2194 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2195 skip |= LogError(
2196 device, vuid,
2197 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2198 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2199 }
2200 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2201 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2202 skip |= LogError(device, vuid,
2203 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2204 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2205 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002206 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002207 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2208 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2209 skip |= LogError(device, vuid,
2210 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2211 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002212 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002213 }
2214 }
2215 }
2216
sfricke-samsungedce77a2020-07-03 22:35:13 -07002217 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2218 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2219 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2220 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2221 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2222 }
2223 const VkImageCreateFlags invalid_flags =
2224 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2225 if ((pCreateInfo->flags & invalid_flags) != 0) {
2226 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2227 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2228 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2229 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2230 }
2231 }
2232
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002233 skip |= ValidateImageFormatFeatures(pCreateInfo);
2234
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002235 // Check compatibility with VK_KHR_portability_subset
2236 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
2237 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2238 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2239 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2240 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2241 }
2242 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2243 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2244 skip |=
2245 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2246 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2247 }
2248 }
2249
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002250 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002251}
2252
John Zulauf7eeb6f72019-06-17 11:56:36 -06002253void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2254 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2255 if (VK_SUCCESS != result) return;
2256
2257 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002258 auto image_state = Get<IMAGE_STATE>(*pImage);
2259 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002260}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002261
Jeff Bolz5c801d12019-10-09 10:38:45 -05002262bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002263 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06002264 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002265 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002266 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002267 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002268 }
2269 return skip;
2270}
2271
John Zulauf7eeb6f72019-06-17 11:56:36 -06002272void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2273 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002274 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002275
locke-lunargcba7d5f2019-12-30 16:59:11 -07002276 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002277
2278 // Clean up generic image state
2279 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002280}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002281
sfricke-samsungcd924d92020-05-20 23:51:17 -07002282bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2283 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002284 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002285 const VkImage image = image_state->image;
2286 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002287
2288 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002289 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2290 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002291 }
2292
sfricke-samsungcd924d92020-05-20 23:51:17 -07002293 if (FormatIsDepthOrStencil(format)) {
2294 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2295 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2296 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2297 } else if (FormatIsCompressed(format)) {
2298 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2299 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2300 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002301 }
2302
2303 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002304 skip |=
2305 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2306 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2307 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002308 }
2309 return skip;
2310}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002311
John Zulauf07288512019-07-05 11:09:50 -06002312bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2313 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2314 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002315 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002316 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2317 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002318 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2319 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2320 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002321 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002322
2323 } else {
2324 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2325 if (!device_extensions.vk_khr_shared_presentable_image) {
2326 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002327 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2328 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2329 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002330 }
2331 } else {
2332 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2333 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002334 skip |= LogError(
2335 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002336 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2337 func_name, string_VkImageLayout(dest_image_layout));
2338 }
2339 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002340 }
2341
John Zulauff660ad62019-03-23 07:16:05 -06002342 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002343 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002344 if (subresource_map) {
2345 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002346 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002347 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002348 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2349 // the next "constant value" range
2350 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002351 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002352 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2353 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2354 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2355 } else {
2356 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002357 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002358 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2359 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2360 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2361 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002362 }
John Zulauf5e617452019-11-19 14:44:16 -07002363 }
John Zulauff660ad62019-03-23 07:16:05 -06002364 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002365 }
2366
2367 return skip;
2368}
2369
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002370bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2371 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002372 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002373 bool skip = false;
2374 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002375 const auto *cb_node = GetCBState(commandBuffer);
2376 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002377 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002378 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002379 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002380 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002381 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002382 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002383 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2384 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002385 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002386 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002387 skip |=
2388 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2389 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2390 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002391 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002392 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002393 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002394 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002395 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002396 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002397 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2398 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2399 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2400 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2401 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2402 string_VkFormat(image_state->createInfo.format));
2403 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002404 }
2405 return skip;
2406}
2407
John Zulaufeabb4462019-07-05 14:13:03 -06002408void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2409 const VkClearColorValue *pColor, uint32_t rangeCount,
2410 const VkImageSubresourceRange *pRanges) {
2411 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2412
2413 auto cb_node = GetCBState(commandBuffer);
2414 auto image_state = GetImageState(image);
2415 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002416 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002417 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002418 }
2419 }
2420}
2421
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002422bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2423 const char *apiName) const {
2424 bool skip = false;
2425
2426 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2427 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2428 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2429 // Also VUID-VkClearDepthStencilValue-depth-00022
2430 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2431 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2432 "(=%f) is not within the [0.0, 1.0] range.",
2433 apiName, clearValue.depth);
2434 }
2435 }
2436
2437 return skip;
2438}
2439
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002440bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2441 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002442 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002443 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002444
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002445 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002446 const auto *cb_node = GetCBState(commandBuffer);
2447 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002448 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002449 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002450 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002451 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002452 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002453 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002454 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002455 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002456 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002457 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002458 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002459 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002460 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002461 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2462 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2463 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2464 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002465
2466 bool any_include_aspect_depth_bit = false;
2467 bool any_include_aspect_stencil_bit = false;
2468
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002469 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002470 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002471 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002472 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002473 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002474 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2475 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002476 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2477 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2478 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2479 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002480 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002481 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2482 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002483 if (FormatHasDepth(image_format) == false) {
2484 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2485 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2486 "doesn't have a depth component.",
2487 i, string_VkFormat(image_format));
2488 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002489 }
2490 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2491 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002492 if (FormatHasStencil(image_format) == false) {
2493 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2494 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2495 "%s doesn't have a stencil component.",
2496 i, string_VkFormat(image_format));
2497 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002498 }
2499 }
2500 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002501 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002502 if (image_stencil_struct != nullptr) {
2503 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2504 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002505 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2506 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2507 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2508 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002509 }
2510 } else {
2511 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002512 skip |= LogError(
2513 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002514 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2515 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2516 "in VkImageCreateInfo::usage used to create image");
2517 }
2518 }
2519 }
2520 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002521 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2522 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2523 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002524 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002525 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002526 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2527 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002528 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002529 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002530 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002531 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2532 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2533 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2534 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002535 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002536 }
2537 return skip;
2538}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002539
John Zulaufeabb4462019-07-05 14:13:03 -06002540void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2541 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2542 const VkImageSubresourceRange *pRanges) {
2543 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2544 auto cb_node = GetCBState(commandBuffer);
2545 auto image_state = GetImageState(image);
2546 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002547 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002548 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002549 }
2550 }
2551}
2552
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002553// Returns true if [x, xoffset] and [y, yoffset] overlap
2554static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2555 bool result = false;
2556 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2557 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2558
2559 if (intersection_max > intersection_min) {
2560 result = true;
2561 }
2562 return result;
2563}
2564
Jeff Leger178b1e52020-10-05 12:22:23 -04002565// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002566// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002567template <typename RegionType>
2568static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002569 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002570
Dave Houltonc991cc92018-03-06 11:08:51 -07002571 // Separate planes within a multiplane image cannot intersect
2572 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002573 return result;
2574 }
2575
Dave Houltonc991cc92018-03-06 11:08:51 -07002576 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2577 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2578 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002579 result = true;
2580 switch (type) {
2581 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002582 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002583 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002584 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002585 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002586 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002587 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002588 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002589 break;
2590 default:
2591 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2592 assert(false);
2593 }
2594 }
2595 return result;
2596}
2597
Dave Houltonfc1a4052017-04-27 14:32:45 -06002598// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002599static const uint32_t kXBit = 1;
2600static const uint32_t kYBit = 2;
2601static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002602static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002603 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002604 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002605 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2606 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002607 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002608 }
2609 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2610 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002611 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002612 }
2613 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2614 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002615 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002616 }
2617 return result;
2618}
2619
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002620// Test if two VkExtent3D structs are equivalent
2621static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2622 bool result = true;
2623 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2624 (extent->depth != other_extent->depth)) {
2625 result = false;
2626 }
2627 return result;
2628}
2629
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002630// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002631static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002632 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2633}
2634
2635// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002636VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002637 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2638 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002639 auto pool = cb_node->command_pool.get();
2640 if (pool) {
2641 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002642 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002643 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002644 granularity.width *= block_size.width;
2645 granularity.height *= block_size.height;
2646 }
2647 }
2648 return granularity;
2649}
2650
2651// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2652static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2653 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002654 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2655 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002656 valid = false;
2657 }
2658 return valid;
2659}
2660
2661// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002662bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002663 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002664 bool skip = false;
2665 VkExtent3D offset_extent = {};
2666 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2667 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2668 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002669 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002670 // 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 -07002671 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002672 skip |= LogError(cb_node->commandBuffer, vuid,
2673 "%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 "
2674 "image transfer granularity is (w=0, h=0, d=0).",
2675 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002676 }
2677 } else {
2678 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2679 // integer multiples of the image transfer granularity.
2680 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002681 skip |= LogError(cb_node->commandBuffer, vuid,
2682 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2683 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2684 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2685 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002686 }
2687 }
2688 return skip;
2689}
2690
2691// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002692bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002693 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002694 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002695 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002696 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002697 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2698 // subresource extent.
2699 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002700 skip |= LogError(cb_node->commandBuffer, vuid,
2701 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2702 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2703 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2704 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002705 }
2706 } else {
2707 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2708 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2709 // subresource extent dimensions.
2710 VkExtent3D offset_extent_sum = {};
2711 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2712 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2713 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002714 bool x_ok = true;
2715 bool y_ok = true;
2716 bool z_ok = true;
2717 switch (image_type) {
2718 case VK_IMAGE_TYPE_3D:
2719 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2720 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002721 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002722 case VK_IMAGE_TYPE_2D:
2723 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2724 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002725 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002726 case VK_IMAGE_TYPE_1D:
2727 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2728 (subresource_extent->width == offset_extent_sum.width));
2729 break;
2730 default:
2731 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2732 assert(false);
2733 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002734 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002735 skip |=
2736 LogError(cb_node->commandBuffer, vuid,
2737 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2738 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2739 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2740 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2741 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2742 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002743 }
2744 }
2745 return skip;
2746}
2747
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002748bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002749 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002750 bool skip = false;
2751 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002752 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2753 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002754 }
2755 return skip;
2756}
2757
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002758bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002759 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002760 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002761 bool skip = false;
2762 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2763 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002764 skip |= LogError(cb_node->commandBuffer, vuid,
2765 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2766 "%u, but provided %s has %u array layers.",
2767 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2768 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002769 }
2770 return skip;
2771}
2772
Jeff Leger178b1e52020-10-05 12:22:23 -04002773// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2774template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002775bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002776 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002777 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002778 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002779 VkExtent3D granularity = GetScaledItg(cb_node, img);
2780 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002781 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002782 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002783 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002784 return skip;
2785}
2786
Jeff Leger178b1e52020-10-05 12:22:23 -04002787// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2788template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002789bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002790 const IMAGE_STATE *dst_img, const RegionType *region,
2791 const uint32_t i, const char *function,
2792 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002793 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002794 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2795 const char *vuid;
2796
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002797 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002798 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002799 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2800 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002801 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002802 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002803 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002804 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002805 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002806
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002807 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002808 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002809 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2810 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002811 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002812 const VkExtent3D dest_effective_extent =
2813 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002814 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002815 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002816 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002817 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002818 return skip;
2819}
2820
Jeff Leger178b1e52020-10-05 12:22:23 -04002821// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2822template <typename ImageCopyRegionType>
2823bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2824 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2825 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002826 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002827 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2828 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2829 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002830
2831 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002832 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002833
2834 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002835 const VkExtent3D src_copy_extent = region.extent;
2836 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002837 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2838
Dave Houlton6f9059e2017-05-02 17:15:13 -06002839 bool slice_override = false;
2840 uint32_t depth_slices = 0;
2841
2842 // Special case for copying between a 1D/2D array and a 3D image
2843 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2844 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002845 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002846 slice_override = (depth_slices != 1);
2847 } 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 -07002848 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002849 slice_override = (depth_slices != 1);
2850 }
2851
2852 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002853 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002854 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002855 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2856 skip |= LogError(src_state->image, vuid,
2857 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2858 "be 0 and 1, respectively.",
2859 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002860 }
2861 }
2862
Dave Houlton533be9f2018-03-26 17:08:30 -06002863 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 -04002864 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2865 skip |= LogError(src_state->image, vuid,
2866 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002867 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002868 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002869 }
2870
Dave Houlton533be9f2018-03-26 17:08:30 -06002871 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002872 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2873 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2874 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002875 }
2876
Dave Houltonc991cc92018-03-06 11:08:51 -07002877 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002878 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002879 if (FormatIsCompressed(src_state->createInfo.format) ||
2880 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002881 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002882 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002883 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2884 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2885 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002886 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002887 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002888 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002889 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002890 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002891 }
2892
Dave Houlton94a00372017-12-14 15:08:47 -07002893 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002894 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2895 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002896 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2897 skip |= LogError(src_state->image, vuid,
2898 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2899 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2900 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002901 }
2902
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002903 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002904 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2905 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002906 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2907 skip |= LogError(src_state->image, vuid,
2908 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2909 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2910 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002911 }
2912
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002913 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002914 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2915 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002916 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2917 skip |= LogError(src_state->image, vuid,
2918 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2919 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2920 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002921 }
2922 } // Compressed
2923
2924 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002925 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002926 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002927 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2928 skip |= LogError(dst_state->image, vuid,
2929 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002930 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002931 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002932 }
2933 }
2934
Dave Houlton533be9f2018-03-26 17:08:30 -06002935 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 -04002936 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2937 skip |= LogError(dst_state->image, vuid,
2938 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2939 "and 1, respectively.",
2940 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002941 }
2942
Dave Houlton533be9f2018-03-26 17:08:30 -06002943 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002944 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2945 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2946 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002947 }
2948
sfricke-samsung30b094c2020-05-30 11:42:11 -07002949 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002950 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002951 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2952 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002953 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2954 skip |= LogError(src_state->image, vuid,
2955 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2956 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2957 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002958 }
2959 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002960 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002961 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002962 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2963 skip |= LogError(dst_state->image, vuid,
2964 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2965 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2966 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002967 }
2968 }
2969 } else { // Pre maint 1
2970 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002971 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002972 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2973 skip |= LogError(src_state->image, vuid,
2974 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002975 "srcSubresource.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.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002978 }
Dave Houltonee281a52017-12-08 13:51:02 -07002979 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002980 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2981 skip |= LogError(dst_state->image, vuid,
2982 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002983 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2984 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002985 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002986 }
2987 }
2988 }
2989
Dave Houltonc991cc92018-03-06 11:08:51 -07002990 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2991 if (FormatIsCompressed(dst_state->createInfo.format) ||
2992 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002993 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002994
2995 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002996 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2997 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2998 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002999 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003000 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003001 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003002 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003003 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003004 }
3005
Dave Houlton94a00372017-12-14 15:08:47 -07003006 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07003007 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
3008 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003009 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
3010 skip |= LogError(dst_state->image, vuid,
3011 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3012 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
3013 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06003014 }
3015
Dave Houltonee281a52017-12-08 13:51:02 -07003016 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
3017 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
3018 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003019 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003020 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003021 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003022 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
3023 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003024 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003025 }
3026
Dave Houltonee281a52017-12-08 13:51:02 -07003027 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
3028 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
3029 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003030 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
3031 skip |= LogError(dst_state->image, vuid,
3032 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3033 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
3034 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003035 }
3036 } // Compressed
3037 }
3038 return skip;
3039}
3040
Jeff Leger178b1e52020-10-05 12:22:23 -04003041template <typename RegionType>
3042bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3043 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3044 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003045 const auto *cb_node = GetCBState(commandBuffer);
3046 const auto *src_image_state = GetImageState(srcImage);
3047 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08003048 const VkFormat src_format = src_image_state->createInfo.format;
3049 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04003050 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003051 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003052
Jeff Leger178b1e52020-10-05 12:22:23 -04003053 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
3054 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
3055 const char *vuid;
3056
3057 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003058
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003059 VkCommandBuffer command_buffer = cb_node->commandBuffer;
3060
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003061 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003062 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07003063
3064 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
3065 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08003066 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07003067
Dave Houlton6f9059e2017-05-02 17:15:13 -06003068 bool slice_override = false;
3069 uint32_t depth_slices = 0;
3070
3071 // Special case for copying between a 1D/2D array and a 3D image
3072 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
3073 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3074 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003075 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003076 slice_override = (depth_slices != 1);
3077 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3078 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003079 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003080 slice_override = (depth_slices != 1);
3081 }
3082
Jeff Leger178b1e52020-10-05 12:22:23 -04003083 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
3084 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
3085 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
3086 skip |=
3087 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3088 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
3089 skip |=
3090 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3091 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003092 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003093 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3094 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003095 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003096 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003097
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003098 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06003099 // No chance of mismatch if we're overriding depth slice count
3100 if (!slice_override) {
3101 // The number of depth slices in srcSubresource and dstSubresource must match
3102 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
3103 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003104 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
3105 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003106 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003107 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
3108 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003109 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003110 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
3111 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003112 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
3113 "do not match.",
3114 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003115 }
3116 }
3117 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003118 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07003119 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003120 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003121 skip |=
3122 LogError(command_buffer, vuid,
3123 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
3124 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003125 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003126 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003127
Dave Houltonc991cc92018-03-06 11:08:51 -07003128 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003129 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003130 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3131 // If neither image is multi-plane the aspectMask member of src and dst must match
3132 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
3133 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
3134 skip |= LogError(command_buffer, vuid,
3135 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3136 "source (0x%x) destination (0x%x).",
3137 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3138 }
3139 } else {
3140 // Source image multiplane checks
3141 uint32_t planes = FormatPlaneCount(src_format);
3142 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3143 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3144 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
3145 skip |= LogError(command_buffer, vuid,
3146 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3147 i, aspect);
3148 }
3149 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3150 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3151 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
3152 skip |= LogError(command_buffer, vuid,
3153 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3154 i, aspect);
3155 }
3156 // Single-plane to multi-plane
3157 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3158 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3159 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3160 skip |= LogError(command_buffer, vuid,
3161 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3162 func_name, i, aspect);
3163 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003164
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003165 // Dest image multiplane checks
3166 planes = FormatPlaneCount(dst_format);
3167 aspect = region.dstSubresource.aspectMask;
3168 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3169 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3170 skip |= LogError(command_buffer, vuid,
3171 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3172 i, aspect);
3173 }
3174 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3175 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3176 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3177 skip |= LogError(command_buffer, vuid,
3178 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3179 i, aspect);
3180 }
3181 // Multi-plane to single-plane
3182 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3183 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3184 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3185 skip |= LogError(command_buffer, vuid,
3186 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3187 func_name, i, aspect);
3188 }
3189 }
3190 } else {
3191 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003192 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3193 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003194 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003195 skip |= LogError(
3196 command_buffer, vuid,
3197 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3198 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003199 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003200 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003201
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003202 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003203 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003204 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003205 skip |=
3206 LogError(command_buffer, vuid,
3207 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3208 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003209 }
3210
3211 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003212 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003213 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003214 skip |= LogError(
3215 command_buffer, vuid,
3216 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3217 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003218 }
3219
Dave Houltonfc1a4052017-04-27 14:32:45 -06003220 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07003221 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
3222 if (slice_override) src_copy_extent.depth = depth_slices;
3223 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003224 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003225 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3226 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003227 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003228 "width [%1d].",
3229 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003230 }
3231
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003232 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003233 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3234 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003235 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003236 "height [%1d].",
3237 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003238 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003239 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003240 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3241 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003242 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003243 "depth [%1d].",
3244 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003245 }
3246
Dave Houltonee281a52017-12-08 13:51:02 -07003247 // Adjust dest extent if necessary
3248 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
3249 if (slice_override) dst_copy_extent.depth = depth_slices;
3250
3251 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003252 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003253 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3254 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003255 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003256 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003257 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003258 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003259 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003260 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3261 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003262 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003263 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003264 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003265 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003266 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003267 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3268 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003269 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003270 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003271 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003272 }
3273
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003274 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3275 // must not overlap in memory
3276 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003277 for (uint32_t j = 0; j < regionCount; j++) {
3278 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003279 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003280 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003281 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003282 }
3283 }
3284 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003285
3286 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3287 if (device_extensions.vk_khr_maintenance1) {
3288 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3289 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3290 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003291 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3292 skip |= LogError(command_buffer, vuid,
3293 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3294 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003295 }
3296 } else {
3297 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3298 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3299 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003300 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3301 skip |= LogError(command_buffer, vuid,
3302 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3303 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003304 }
3305 }
3306
3307 // Check if 2D with 3D and depth not equal to 2D layerCount
3308 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3309 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3310 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003311 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3312 skip |= LogError(command_buffer, vuid,
3313 "%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 -08003314 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003315 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003316 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3317 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3318 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003319 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3320 skip |= LogError(command_buffer, vuid,
3321 "%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 -08003322 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003323 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003324 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003325
3326 // Check for multi-plane format compatiblity
3327 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3328 size_t src_format_size = 0;
3329 size_t dst_format_size = 0;
3330 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003331 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3332 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003333 } else {
3334 src_format_size = FormatElementSize(src_format);
3335 }
3336 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003337 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3338 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003339 } else {
3340 dst_format_size = FormatElementSize(dst_format);
3341 }
3342 // If size is still zero, then format is invalid and will be caught in another VU
3343 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003344 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3345 skip |= LogError(command_buffer, vuid,
3346 "%s: pRegions[%u] called with non-compatible image formats. "
3347 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3348 func_name, i, string_VkFormat(src_format),
3349 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3350 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003351 }
3352 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003353 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003354
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003355 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3356 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3357 // because because both texels are 4 bytes in size.
3358 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003359 const char *compatible_vuid =
3360 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3361 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3362 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003363 // Depth/stencil formats must match exactly.
3364 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3365 if (src_format != dst_format) {
3366 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003367 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003368 string_VkFormat(src_format), string_VkFormat(dst_format));
3369 }
3370 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003371 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003372 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003373 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003374 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003375 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003376 FormatElementSize(dst_format));
3377 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003378 }
3379 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003380
Dave Houlton33c22b72017-02-28 13:16:02 -07003381 // Source and dest image sample counts must match
3382 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003383 std::stringstream ss;
3384 ss << func_name << " called on image pair with non-identical sample counts.";
3385 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003386 skip |=
3387 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3388 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3389 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003390 }
3391
Tony-LunarG5a066372021-01-21 10:31:34 -07003392 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3393 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3394 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003395 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
Tony-LunarG5a066372021-01-21 10:31:34 -07003396 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3397 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3398 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3399 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003400 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003401 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3402 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3403 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3404 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3405 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3406 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3407 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3408 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3409 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3410 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3411 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3412 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003413
3414 // Validation for VK_EXT_fragment_density_map
3415 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003416 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3417 skip |=
3418 LogError(command_buffer, vuid,
3419 "%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 +02003420 }
3421 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003422 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3423 skip |=
3424 LogError(command_buffer, vuid,
3425 "%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 +02003426 }
3427
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003428 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003429 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3430 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3431 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3432 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003433 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003434 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3435 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3436 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3437 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3438 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003439 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003440
3441 const char *invalid_src_layout_vuid =
3442 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3443 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3444 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3445 const char *invalid_dst_layout_vuid =
3446 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3447 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3448 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3449
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003450 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003451 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003452 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003453 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3454 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003455 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003456 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003457 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003458 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003459 }
3460
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003461 return skip;
3462}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003463
Jeff Leger178b1e52020-10-05 12:22:23 -04003464bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3465 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3466 const VkImageCopy *pRegions) const {
3467 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3468 COPY_COMMAND_VERSION_1);
3469}
3470
3471bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3472 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3473 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3474 COPY_COMMAND_VERSION_2);
3475}
3476
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003477void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3478 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3479 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003480 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3481 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003482 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003483 auto src_image_state = GetImageState(srcImage);
3484 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003485
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003486 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003487 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003488 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3489 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003490 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003491}
3492
Jeff Leger178b1e52020-10-05 12:22:23 -04003493void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3494 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3495 auto cb_node = GetCBState(commandBuffer);
3496 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3497 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3498
3499 // Make sure that all image slices are updated to correct layout
3500 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3501 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3502 pCopyImageInfo->srcImageLayout);
3503 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3504 pCopyImageInfo->dstImageLayout);
3505 }
3506}
3507
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003508// Returns true if sub_rect is entirely contained within rect
3509static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3510 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 -07003511 (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 -07003512 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003513 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003514 return true;
3515}
3516
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003517bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003518 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003519 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3520 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003521 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003522 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3523 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003524 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003525 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003526
3527 for (uint32_t j = 0; j < rect_count; j++) {
3528 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003529 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3530 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3531 "the current render pass instance.",
3532 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003533 }
3534
3535 if (image_view_state) {
3536 // The layers specified by a given element of pRects must be contained within every attachment that
3537 // pAttachments refers to
3538 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3539 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3540 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003541 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3542 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3543 "of pAttachment[%d].",
3544 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003545 }
3546 }
3547 }
3548 return skip;
3549}
3550
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003551bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3552 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003553 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003554 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003555 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003556 if (!cb_node) return skip;
3557
3558 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3559 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3560 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003561 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003562
3563 // Validate that attachment is in reference list of active subpass
3564 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003565 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003566 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003567 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003568 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003569 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003570
John Zulauf3a548ef2019-02-01 16:14:07 -07003571 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3572 auto clear_desc = &pAttachments[attachment_index];
3573 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003574 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003575
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003576 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3577 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3578 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3579 attachment_index);
3580 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3581 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3582 skip |=
3583 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3584 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3585 attachment_index);
3586 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003587 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3588 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3589 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3590 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003591 skip |= LogError(
3592 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3593 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3594 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3595 attachment_index, clear_desc->colorAttachment,
3596 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3597 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003598
John Zulauff2582972019-02-09 14:53:30 -07003599 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3600 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003601 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003602 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3603 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3604 " subpass %u. colorAttachmentCount=%u",
3605 attachment_index, clear_desc->colorAttachment,
3606 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3607 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003608 }
John Zulauff2582972019-02-09 14:53:30 -07003609 fb_attachment = color_attachment;
3610
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003611 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3612 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3613 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3614 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3615 "of a color attachment.",
3616 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003617 }
3618 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003619 bool subpass_depth = false;
3620 bool subpass_stencil = false;
3621 if (subpass_desc->pDepthStencilAttachment &&
3622 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3623 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3624 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3625 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3626 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003627 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003628 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3629 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003630 skip |= LogError(
3631 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3632 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003633 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003634 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003635 }
3636 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003637 skip |= LogError(
3638 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3639 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003640 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003641 attachment_index);
3642 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003643 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003644 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003645 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003646 if (subpass_depth) {
3647 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3648 "vkCmdClearAttachments()");
3649 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003650 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003651 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003652 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3653 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003654 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003655
3656 // Once the framebuffer attachment is found, can get the image view state
3657 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3658 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3659 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003660 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003661 if (image_view_state != nullptr) {
3662 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3663 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3664 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3665 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3666 }
3667 }
John Zulauf441558b2019-08-12 11:47:39 -06003668 }
3669 }
3670 return skip;
3671}
3672
3673void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3674 const VkClearAttachment *pAttachments, uint32_t rectCount,
3675 const VkClearRect *pRects) {
3676 auto *cb_node = GetCBState(commandBuffer);
3677 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003678 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3679 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003680 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3681 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3682 const auto clear_desc = &pAttachments[attachment_index];
3683 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3684 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3685 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3686 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3687 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3688 subpass_desc->pDepthStencilAttachment) {
3689 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3690 }
3691 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003692 if (!clear_rect_copy) {
3693 // We need a copy of the clear rectangles that will persist until the last lambda executes
3694 // but we want to create it as lazily as possible
3695 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003696 }
John Zulauf441558b2019-08-12 11:47:39 -06003697 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3698 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003699 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003700 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003701 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003702 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3703 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003704 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003705 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003706 return skip;
3707 };
3708 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003709 }
3710 }
3711 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003712}
3713
Jeff Leger178b1e52020-10-05 12:22:23 -04003714template <typename RegionType>
3715bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3716 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3717 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003718 const auto *cb_node = GetCBState(commandBuffer);
3719 const auto *src_image_state = GetImageState(srcImage);
3720 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003721 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3722 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3723 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3724 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003725
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003726 bool skip = false;
3727 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003728 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3729 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3730 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3731 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3732 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3733 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3734 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3735 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3736 skip |= InsideRenderPass(cb_node, func_name, vuid);
3737 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3738 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3739 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3740 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3741 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3742 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3743 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3744 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003745
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003746 // Validation for VK_EXT_fragment_density_map
3747 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003748 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3749 skip |= LogError(cb_node->commandBuffer, vuid,
3750 "%s: srcImage must not have been created with flags containing "
3751 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3752 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003753 }
3754 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003755 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3756 skip |= LogError(cb_node->commandBuffer, vuid,
3757 "%s: dstImage must not have been created with flags containing "
3758 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3759 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003760 }
3761
Cort Stratton7df30962018-05-17 19:45:57 -07003762 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003763 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003764 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3765 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003766 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003767 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3768 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3769 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003770 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003771 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3772 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3773 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3774 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3775 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3776 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003777 // For each region, the number of layers in the image subresource should not be zero
3778 // For each region, src and dest image aspect must be color only
3779 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003780 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003781 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3782 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3784 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3785 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003786 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003787 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3788 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003789 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003790 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3791 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3792 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3793 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3794 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3795 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003796 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003797 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3798 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003799 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003800 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003801
3802 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003803 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003804 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3805 skip |=
3806 LogError(cb_node->commandBuffer, vuid,
3807 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003808 }
Cort Stratton7df30962018-05-17 19:45:57 -07003809 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003810 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3811 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003812 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3813 skip |= LogError(cb_node->commandBuffer, vuid,
3814 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3815 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003816 }
3817
3818 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3819 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3820
3821 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003822 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003823 LogObjectList objlist(cb_node->commandBuffer);
3824 objlist.add(src_image_state->image);
3825 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003826 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3827 skip |= LogError(objlist, vuid,
3828 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003829 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003830 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003831 }
3832 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3833 LogObjectList objlist(cb_node->commandBuffer);
3834 objlist.add(src_image_state->image);
3835 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003836 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3837 skip |= LogError(objlist, vuid,
3838 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003839 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003840 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003841 }
3842 }
3843
3844 if (VK_IMAGE_TYPE_1D == src_image_type) {
3845 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3846 LogObjectList objlist(cb_node->commandBuffer);
3847 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003848 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3849 skip |= LogError(objlist, vuid,
3850 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003851 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003852 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3853 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003854 }
3855 }
3856 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3857 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3858 LogObjectList objlist(cb_node->commandBuffer);
3859 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003860 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3861 skip |= LogError(objlist, vuid,
3862 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003863 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003864 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3865 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003866 }
3867 }
3868
3869 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3870 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3871 LogObjectList objlist(cb_node->commandBuffer);
3872 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003873 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3874 skip |= LogError(objlist, vuid,
3875 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003876 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003877 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3878 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003879 }
3880 }
3881 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3882 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3883 LogObjectList objlist(cb_node->commandBuffer);
3884 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003885 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3886 skip |= LogError(objlist, vuid,
3887 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003888 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003889 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3890 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003891 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003892 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003893
3894 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3895 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3896 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3897 // developer
3898 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3899 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003900 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003901 LogObjectList objlist(cb_node->commandBuffer);
3902 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003903 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3904 skip |= LogError(objlist, vuid,
3905 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003906 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003907 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003908 region.extent.width, subresource_extent.width);
3909 }
3910
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003911 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003912 LogObjectList objlist(cb_node->commandBuffer);
3913 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003914 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3915 skip |= LogError(objlist, vuid,
3916 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003917 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003918 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003919 region.extent.height, subresource_extent.height);
3920 }
3921
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003922 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003923 LogObjectList objlist(cb_node->commandBuffer);
3924 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003925 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3926 skip |= LogError(objlist, vuid,
3927 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003928 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003929 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003930 region.extent.depth, subresource_extent.depth);
3931 }
3932 }
3933
3934 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3935 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3936 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3937 // developer
3938 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3939 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003940 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003941 LogObjectList objlist(cb_node->commandBuffer);
3942 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003943 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3944 skip |= LogError(objlist, vuid,
3945 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003946 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003947 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003948 region.extent.width, subresource_extent.width);
3949 }
3950
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003951 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003952 LogObjectList objlist(cb_node->commandBuffer);
3953 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003954 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3955 skip |= LogError(objlist, vuid,
3956 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003957 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003958 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003959 region.extent.height, subresource_extent.height);
3960 }
3961
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003962 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003963 LogObjectList objlist(cb_node->commandBuffer);
3964 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003965 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3966 skip |= LogError(objlist, vuid,
3967 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003968 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003969 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003970 region.extent.depth, subresource_extent.depth);
3971 }
3972 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003973 }
3974
3975 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003976 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3977 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3978 func_name, string_VkFormat(src_image_state->createInfo.format),
3979 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003980 }
3981 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003982 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003983 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003984 string_VkImageType(src_image_state->createInfo.imageType),
3985 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003986 }
3987 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003988 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3989 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 -07003990 }
3991 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003992 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3993 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3994 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003995 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003996 } else {
3997 assert(0);
3998 }
3999 return skip;
4000}
4001
Jeff Leger178b1e52020-10-05 12:22:23 -04004002bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4003 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4004 const VkImageResolve *pRegions) const {
4005 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
4006 COPY_COMMAND_VERSION_1);
4007}
4008
4009bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
4010 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
4011 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4012 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
4013 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
4014}
4015
4016template <typename RegionType>
4017bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4018 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4019 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004020 const auto *cb_node = GetCBState(commandBuffer);
4021 const auto *src_image_state = GetImageState(srcImage);
4022 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004023
Jeff Leger178b1e52020-10-05 12:22:23 -04004024 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
4025 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
4026 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
4027
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004028 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07004029 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004030 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07004031 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004032 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004033 const char *vuid;
4034 const char *location;
4035 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
4036 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
4037 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
4038 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4039 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
4040 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
4041 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
4042 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
4043 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
4044 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
4045 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
4046 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
4047 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
4048 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
4049 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
4050 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
4051 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
4052 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
4053 skip |= ValidateCmd(cb_node, cmd_type, func_name);
4054 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
4055 skip |= InsideRenderPass(cb_node, func_name, vuid);
4056 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4057 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
4058 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4059 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
4060 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
4061 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
4062 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
4063 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
4064 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
4065 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004066
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004067 // Validation for VK_EXT_fragment_density_map
4068 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004069 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
4070 skip |= LogError(cb_node->commandBuffer, vuid,
4071 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4072 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004073 }
4074 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004075 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
4076 skip |= LogError(cb_node->commandBuffer, vuid,
4077 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4078 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004079 }
4080
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004081 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004082
Dave Houlton33c2d252017-06-09 17:08:32 -06004083 VkFormat src_format = src_image_state->createInfo.format;
4084 VkFormat dst_format = dst_image_state->createInfo.format;
4085 VkImageType src_type = src_image_state->createInfo.imageType;
4086 VkImageType dst_type = dst_image_state->createInfo.imageType;
4087
Cort Stratton186b1a22018-05-01 20:18:06 -04004088 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004089 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4090 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
4091 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004092 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004093 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004094 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04004095 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004096 }
4097
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004098 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004099 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
4100 skip |= LogError(device, vuid,
4101 "%s: srcImage 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(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004104 }
4105
4106 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004107 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
4108 skip |= LogError(device, vuid,
4109 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004110 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004111 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004112 }
4113
Dave Houlton33c2d252017-06-09 17:08:32 -06004114 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004115 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
4116 skip |= LogError(cb_node->commandBuffer, vuid,
4117 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004118 }
4119
Dave Houlton33c2d252017-06-09 17:08:32 -06004120 // Validate consistency for unsigned formats
4121 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
4122 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004123 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004124 << "the other one must also have unsigned integer format. "
4125 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004126 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
4127 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004128 }
4129
4130 // Validate consistency for signed formats
4131 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
4132 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004133 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004134 << "the other one must also have signed integer format. "
4135 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004136 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
4137 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004138 }
4139
4140 // Validate filter for Depth/Stencil formats
4141 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4142 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004143 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004144 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04004145 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
4146 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004147 }
4148
4149 // Validate aspect bits and formats for depth/stencil images
4150 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4151 if (src_format != dst_format) {
4152 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004153 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 -06004154 << "stencil, the other one must have exactly the same format. "
4155 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4156 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004157 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
4158 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004159 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004160 } // Depth or Stencil
4161
4162 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004163 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004164 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4165 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4166 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
4167 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4168 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4169 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004170 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004171 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4172 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4173 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
4174 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4175 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4176 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004177 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004178 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004179 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004180 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004181 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004182 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4183 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004184 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004185 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4186 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4187 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4188 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4189 skip |=
4190 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4191 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4192 skip |=
4193 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4194 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004195 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004196 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4197 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004198 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004199 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004200 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004201 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4202 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004203 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004204 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004205 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004206 }
Dave Houlton48989f32017-05-26 15:01:46 -06004207 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4208 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004209 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004210 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004211 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004212 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004213
4214 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004215 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004216 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4217 skip |=
4218 LogError(cb_node->commandBuffer, vuid,
4219 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004220 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004221
Dave Houlton48989f32017-05-26 15:01:46 -06004222 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004223 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4224 skip |=
4225 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004226 }
Dave Houlton48989f32017-05-26 15:01:46 -06004227
Dave Houlton33c2d252017-06-09 17:08:32 -06004228 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004229 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
4230 skip |= LogError(cb_node->commandBuffer, vuid,
4231 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004232 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004233 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004234 }
4235
4236 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004237 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
4238 skip |= LogError(cb_node->commandBuffer, vuid,
4239 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4240 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004241 }
4242
Dave Houlton48989f32017-05-26 15:01:46 -06004243 // Validate source image offsets
4244 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004245 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004246 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004247 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
4248 skip |= LogError(cb_node->commandBuffer, vuid,
4249 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4250 "of (%1d, %1d). These must be (0, 1).",
4251 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004252 }
4253 }
4254
Dave Houlton33c2d252017-06-09 17:08:32 -06004255 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004256 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004257 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
4258 skip |= LogError(cb_node->commandBuffer, vuid,
4259 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4260 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4261 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004262 }
4263 }
4264
Dave Houlton33c2d252017-06-09 17:08:32 -06004265 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004266 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4267 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004268 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004269 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
4270 skip |= LogError(cb_node->commandBuffer, vuid,
4271 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4272 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004273 }
4274 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4275 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004276 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004277 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
4278 skip |= LogError(cb_node->commandBuffer, vuid,
4279 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4280 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004281 }
4282 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4283 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004284 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004285 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
4286 skip |= LogError(cb_node->commandBuffer, vuid,
4287 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4288 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004289 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004290 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004291 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4292 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4293 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004294 }
Dave Houlton48989f32017-05-26 15:01:46 -06004295
4296 // Validate dest image offsets
4297 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004298 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004299 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004300 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4301 skip |= LogError(cb_node->commandBuffer, vuid,
4302 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4303 "(%1d, %1d). These must be (0, 1).",
4304 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004305 }
4306 }
4307
Dave Houlton33c2d252017-06-09 17:08:32 -06004308 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004309 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004310 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4311 skip |= LogError(cb_node->commandBuffer, vuid,
4312 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004313 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004314 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004315 }
4316 }
4317
Dave Houlton33c2d252017-06-09 17:08:32 -06004318 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004319 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4320 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004321 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004322 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4323 skip |= LogError(cb_node->commandBuffer, vuid,
4324 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4325 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004326 }
4327 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4328 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004329 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004330 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4331 skip |= LogError(cb_node->commandBuffer, vuid,
4332 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4333 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004334 }
4335 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4336 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004337 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004338 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4339 skip |= LogError(cb_node->commandBuffer, vuid,
4340 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4341 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004342 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004343 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004344 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4345 skip |= LogError(cb_node->commandBuffer, vuid,
4346 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004347 }
4348
Dave Houlton33c2d252017-06-09 17:08:32 -06004349 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4350 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4351 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004352 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4353 skip |= LogError(cb_node->commandBuffer, vuid,
4354 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4355 "layerCount other than 1.",
4356 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004357 }
4358 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004359 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004360 } else {
4361 assert(0);
4362 }
4363 return skip;
4364}
4365
Jeff Leger178b1e52020-10-05 12:22:23 -04004366bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4367 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4368 const VkImageBlit *pRegions, VkFilter filter) const {
4369 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4370 COPY_COMMAND_VERSION_1);
4371}
4372
4373bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4374 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4375 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4376 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4377}
4378
4379template <typename RegionType>
4380void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4381 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4382 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004383 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004384 auto src_image_state = GetImageState(srcImage);
4385 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004386
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004387 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004388 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004389 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4390 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004391 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004392}
4393
Jeff Leger178b1e52020-10-05 12:22:23 -04004394void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4395 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4396 const VkImageBlit *pRegions, VkFilter filter) {
4397 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4398 pRegions, filter);
4399 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4400}
4401
4402void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4403 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4404 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4405 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4406 pBlitImageInfo->filter);
4407}
4408
John Zulauf2076e812020-01-08 14:55:54 -07004409GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4410 assert(map);
4411 // This approach allows for a single hash lookup or/create new
4412 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4413 if (inserted.second) {
4414 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004415 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004416 inserted.first->second.reset(layout_map);
4417 return layout_map;
4418 } else {
4419 assert(nullptr != inserted.first->second.get());
4420 return inserted.first->second.get();
4421 }
4422 return nullptr;
4423}
4424
4425const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4426 auto it = map.find(image);
4427 if (it != map.end()) {
4428 return it->second.get();
4429 }
4430 return nullptr;
4431}
4432
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004433// 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 -07004434bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4435 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004436 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004437 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004438 GlobalImageLayoutMap &overlay_layout_map = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004439 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004440 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004441 for (const auto &layout_map_entry : pCB->image_layout_map) {
4442 const auto image = layout_map_entry.first;
4443 const auto *image_state = GetImageState(image);
4444 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004445 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004446 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004447 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004448 if (initial_layout_map.empty()) continue;
4449
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004450 auto *overlay_map = GetLayoutRangeMap(&overlay_layout_map, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004451 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4452 if (global_map == nullptr) {
4453 global_map = &empty_map;
4454 }
4455
4456 // Note: don't know if it would matter
4457 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4458
4459 auto pos = initial_layout_map.begin();
4460 const auto end = initial_layout_map.end();
4461 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4462 pos->first.begin);
4463 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004464 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004465 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004466 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 -07004467 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004468 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004469 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004470 image_layout = current_layout->pos_B->lower_bound->second;
4471 }
4472 const auto intersected_range = pos->first & current_layout->range;
4473 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4474 // TODO: Set memory invalid which is in mem_tracker currently
4475 } else if (image_layout != initial_layout) {
4476 // Need to look up the inital layout *state* to get a bit more information
4477 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4478 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4479 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4480 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004481 // We can report all the errors for the intersected range directly
4482 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004483 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004484 skip |= LogError(
4485 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004486 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004487 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004488 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004489 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004490 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004491 }
4492 }
John Zulauf2076e812020-01-08 14:55:54 -07004493 if (pos->first.includes(intersected_range.end)) {
4494 current_layout.seek(intersected_range.end);
4495 } else {
4496 ++pos;
4497 if (pos != end) {
4498 current_layout.seek(pos->first.begin);
4499 }
4500 }
John Zulauff660ad62019-03-23 07:16:05 -06004501 }
4502
locke-lunargf155ccf2020-02-18 11:34:15 -07004503 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004504 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004505 }
John Zulauff660ad62019-03-23 07:16:05 -06004506
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004507 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004508}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004509
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004510void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004511 for (const auto &layout_map_entry : pCB->image_layout_map) {
4512 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004513 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004514 const auto *image_state = GetImageState(image);
4515 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004516 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4517 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004518 }
4519}
4520
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004521// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004522// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4523// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004524bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4525 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004526 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004527 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004528 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4529
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004530 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004531 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4532 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004533 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004534 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4535 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4536 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004537 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004538 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004539 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004540 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4541 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4542 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004543 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004544 string_VkImageLayout(first_layout));
4545 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4546 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004547 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004548 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004549 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004550 }
4551 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004552
4553 // Same as above for loadOp, but for stencilLoadOp
4554 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4555 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4556 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4557 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4558 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004559 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004560 string_VkImageLayout(first_layout));
4561 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4562 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4563 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004564 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004565 string_VkImageLayout(first_layout));
4566 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4567 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4568 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004569 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004570 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004571 }
4572 }
4573
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004574 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004575}
4576
Mark Lobodzinski96210742017-02-09 10:33:46 -07004577// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4578// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004579template <typename T1>
4580bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4581 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4582 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004583 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004584 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004585 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004586 if (strict) {
4587 correct_usage = ((actual & desired) == desired);
4588 } else {
4589 correct_usage = ((actual & desired) != 0);
4590 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004591
Mark Lobodzinski96210742017-02-09 10:33:46 -07004592 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004593 // All callers should have a valid VUID
4594 assert(msgCode != kVUIDUndefined);
4595 skip =
4596 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4597 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004598 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004599 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004600}
4601
4602// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4603// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004604bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004605 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004606 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004607 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004608}
4609
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004610bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004611 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004612 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004613 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4614 if ((image_format_features & desired) != desired) {
4615 // Same error, but more details if it was an AHB external format
4616 if (image_state->has_ahb_format == true) {
4617 skip |= LogError(image_state->image, vuid,
4618 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4619 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4620 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004621 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004622 } else {
4623 skip |= LogError(image_state->image, vuid,
4624 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4625 "with tiling %s.",
4626 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4627 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4628 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004629 }
4630 }
4631 return skip;
4632}
4633
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004634bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004635 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004636 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004637 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004638 // layerCount must not be zero
4639 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004640 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4641 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004642 }
4643 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004644 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004645 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4646 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004647 }
4648 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004649 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 -07004650 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4651 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4652 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4653 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004654 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004655 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4656 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4657 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4658 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4659 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4660 member);
4661 }
Cort Strattond619a302018-05-17 19:46:32 -07004662 return skip;
4663}
4664
Mark Lobodzinski96210742017-02-09 10:33:46 -07004665// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4666// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004667bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004668 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004669 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004670 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004671}
4672
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004673bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004674 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004675 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004676
4677 const VkDeviceSize &range = pCreateInfo->range;
4678 if (range != VK_WHOLE_SIZE) {
4679 // Range must be greater than 0
4680 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004681 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
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 greater than 0.",
4684 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004685 }
4686 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004687 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4688 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004689 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
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 must be a multiple of the element size of the format "
4692 "(%" PRIu32 ").",
4693 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004694 }
4695 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004696 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004697 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
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, range divided by the element size of the format (%" PRIu32
4700 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4701 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004702 }
4703 // The sum of range and offset must be less than or equal to the size of buffer
4704 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004705 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004706 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004707 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4708 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4709 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004710 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004711 } else {
4712 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4713
4714 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4715 // VkPhysicalDeviceLimits::maxTexelBufferElements
4716 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4717 device_limits->maxTexelBufferElements) {
4718 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4719 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4720 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4721 "), divided by the element size of the format (%" PRIu32
4722 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4723 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4724 device_limits->maxTexelBufferElements);
4725 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004726 }
4727 return skip;
4728}
4729
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004730bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004731 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004732 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004733 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4734 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004735 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
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_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4738 "be supported for uniform texel buffers",
4739 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004740 }
4741 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4742 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004743 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004744 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004745 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4746 "be supported for storage texel buffers",
4747 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004748 }
4749 return skip;
4750}
4751
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004752bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004753 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004754 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004755
Dave Houltond8ed0212018-05-16 17:18:24 -06004756 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004757
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004758 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004759 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004760 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004761 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004762 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4763 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004764 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004765 }
4766 }
4767
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004768 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004769 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004770 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004771 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004772 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004773 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4774 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004775 }
4776 }
4777
Mike Schuchardt2df08912020-12-15 16:28:09 -08004778 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004779 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4780 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004781 skip |= LogError(
4782 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004783 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004784 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004785 }
4786
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004787 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004788 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4789 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4790 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004791 }
4792
sfricke-samsungedce77a2020-07-03 22:35:13 -07004793 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4794 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4795 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4796 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4797 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4798 }
4799 const VkBufferCreateFlags invalid_flags =
4800 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4801 if ((pCreateInfo->flags & invalid_flags) != 0) {
4802 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4803 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4804 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4805 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4806 }
4807 }
4808
Mark Lobodzinski96210742017-02-09 10:33:46 -07004809 return skip;
4810}
4811
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004812bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004813 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004814 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004815 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004816 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4817 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004818 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004819 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4820 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004821 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004822 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4823 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4824 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004825
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004826 // Buffer view offset must be less than the size of buffer
4827 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004828 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004829 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004830 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4831 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004832 }
4833
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004834 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004835 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4836 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4837 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004838 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4839 : "VUID-VkBufferViewCreateInfo-offset-00926";
4840 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004841 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004842 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4843 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004844 }
4845
4846 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004847 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4848 if ((element_size % 3) == 0) {
4849 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004850 }
4851 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004852 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004853 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4854 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004855 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004856 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004857 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004858 skip |= LogError(
4859 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004860 "vkCreateBufferView(): If buffer was created with usage containing "
4861 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004862 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4863 ") must be a multiple of the lesser of "
4864 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4865 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4866 "(%" PRId32
4867 ") is VK_TRUE, the size of a texel of the requested format. "
4868 "If the size of a texel is a multiple of three bytes, then the size of a "
4869 "single component of format is used instead",
4870 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4871 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4872 }
4873 }
4874 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004875 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004876 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4877 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004878 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004879 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004880 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004881 skip |= LogError(
4882 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004883 "vkCreateBufferView(): If buffer was created with usage containing "
4884 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004885 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4886 ") must be a multiple of the lesser of "
4887 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4888 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4889 "(%" PRId32
4890 ") is VK_TRUE, the size of a texel of the requested format. "
4891 "If the size of a texel is a multiple of three bytes, then the size of a "
4892 "single component of format is used instead",
4893 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4894 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4895 }
4896 }
4897 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004898
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004899 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004900
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004901 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004902 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004903 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004904}
4905
Mark Lobodzinski602de982017-02-09 11:01:33 -07004906// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004907bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004908 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004909 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004910 const IMAGE_STATE *image_state = GetImageState(image);
4911 // checks color format and (single-plane or non-disjoint)
4912 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004913 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004914 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004915 skip |= LogError(
4916 image, vuid,
4917 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4918 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004919 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004920 skip |= LogError(image, vuid,
4921 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4922 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4923 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004924 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004925 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004926 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004927 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004928 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4929 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4930 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004931 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004932 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004933 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4934 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4935 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004936 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004937 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004938 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004939 skip |= LogError(image, vuid,
4940 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4941 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4942 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004943 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004944 skip |= LogError(image, vuid,
4945 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4946 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4947 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004948 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004949 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004950 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004951 skip |= LogError(image, vuid,
4952 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4953 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4954 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004955 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004956 skip |= LogError(image, vuid,
4957 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4958 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4959 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004960 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004961 } else if (FormatIsMultiplane(format)) {
4962 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4963 if (3 == FormatPlaneCount(format)) {
4964 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4965 }
4966 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004967 skip |= LogError(image, vuid,
4968 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4969 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4970 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004971 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004972 }
4973 return skip;
4974}
4975
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004976bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4977 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004978 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4979 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004980 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004981
4982 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004983 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004984 skip |= LogError(image, errorCodes.base_mip_err,
4985 "%s: %s.baseMipLevel (= %" PRIu32
4986 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4987 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004988 }
Petr Kraus4d718682017-05-18 03:38:41 +02004989
Petr Krausffa94af2017-08-08 21:46:02 +02004990 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4991 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004992 skip |=
4993 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004994 } else {
4995 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004996
Petr Krausffa94af2017-08-08 21:46:02 +02004997 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004998 skip |= LogError(image, errorCodes.mip_count_err,
4999 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5000 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
5001 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
5002 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005003 }
Petr Kraus4d718682017-05-18 03:38:41 +02005004 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005005 }
Petr Kraus4d718682017-05-18 03:38:41 +02005006
5007 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02005008 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005009 skip |= LogError(image, errorCodes.base_layer_err,
5010 "%s: %s.baseArrayLayer (= %" PRIu32
5011 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5012 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005013 }
Petr Kraus4d718682017-05-18 03:38:41 +02005014
Petr Krausffa94af2017-08-08 21:46:02 +02005015 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5016 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005017 skip |=
5018 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005019 } else {
5020 const uint64_t necessary_layer_count =
5021 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005022
Petr Krausffa94af2017-08-08 21:46:02 +02005023 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005024 skip |= LogError(image, errorCodes.layer_count_err,
5025 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5026 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5027 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5028 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005029 }
Petr Kraus4d718682017-05-18 03:38:41 +02005030 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005031 }
Petr Kraus4d718682017-05-18 03:38:41 +02005032
Mark Lobodzinski602de982017-02-09 11:01:33 -07005033 return skip;
5034}
5035
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005036bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005037 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005038 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02005039 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08005040 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005041 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 +02005042
David McFarland2853f2f2020-11-30 15:50:39 -04005043 uint32_t image_layer_count;
5044
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005045 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005046 const auto layers = LayersFromRange(subresourceRange);
5047 const auto extent = GetImageSubresourceExtent(image_state, &layers);
5048 image_layer_count = extent.depth;
5049 } else {
5050 image_layer_count = image_state->createInfo.arrayLayers;
5051 }
5052
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005053 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005054
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005055 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5056 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5057 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5058 subresource_range_error_codes.base_layer_err =
5059 is_khr_maintenance1
5060 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
5061 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
5062 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
5063 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5064 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
5065 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005066
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005067 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005068 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005069 image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005070}
5071
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005072bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005073 const VkImageSubresourceRange &subresourceRange,
5074 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005075 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5076 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5077 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5078 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5079 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005080
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005081 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005082 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005083 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005084}
5085
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005086bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005087 const VkImageSubresourceRange &subresourceRange,
5088 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005089 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5090 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5091 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5092 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5093 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005094
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005095 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005096 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005097 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005098}
5099
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005100bool CoreChecks::ValidateImageBarrierSubresourceRange(const CoreErrorLocation &loc, const IMAGE_STATE *image_state,
5101 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005102 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005103 loc.StringFuncName().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image,
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005104 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005105}
5106
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005107namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005108using sync_vuid_maps::GetBarrierQueueVUID;
5109using sync_vuid_maps::kQueueErrorSummary;
5110using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005111
5112class ValidatorState {
5113 public:
John Zulaufbea70432021-02-23 07:03:12 -07005114 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const CoreErrorLocation &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005115 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5116 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005117 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005118 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005119 barrier_handle_(barrier_handle),
5120 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005121 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5122 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5123
5124 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5125 // 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 -07005126 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5127 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005128 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005129 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5130 loc_.Message().c_str(), GetTypeString(),
5131 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5132 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005133 }
5134
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005135 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5136 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005137 const char *src_annotation = GetFamilyAnnotation(src_family);
5138 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5139 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005140 objects_, val_code,
5141 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5142 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5143 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005144 }
5145
5146 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5147 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5148 // application input.
5149 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5150 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005151 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005152 uint32_t queue_family = queue_state->queueFamilyIndex;
5153 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005154 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005155 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5156 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5157 return device_data->LogError(
5158 queue_state->queue, val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005159 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005160 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005161 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005162 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005163 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005164 }
5165 return false;
5166 }
5167 // Logical helpers for semantic clarity
5168 inline bool KhrExternalMem() const { return mem_ext_; }
5169 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5170 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5171 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5172 }
5173
5174 // Helpers for LogMsg
5175 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5176
5177 // Descriptive text for the various types of queue family index
5178 const char *GetFamilyAnnotation(uint32_t family) const {
5179 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5180 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5181 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5182 const char *valid = " (VALID)";
5183 const char *invalid = " (INVALID)";
5184 switch (family) {
5185 case VK_QUEUE_FAMILY_EXTERNAL:
5186 return external;
5187 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5188 return foreign;
5189 case VK_QUEUE_FAMILY_IGNORED:
5190 return ignored;
5191 default:
5192 if (IsValid(family)) {
5193 return valid;
5194 }
5195 return invalid;
5196 };
5197 }
5198 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5199 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5200
5201 protected:
5202 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005203 const LogObjectList objects_;
5204 const CoreErrorLocation loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005205 const VulkanTypedHandle barrier_handle_;
5206 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005207 const uint32_t limit_;
5208 const bool mem_ext_;
5209};
5210
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005211bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005212 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5213 bool skip = false;
5214
5215 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5216 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5217 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5218 if (val.KhrExternalMem()) {
5219 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005220 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5221 // this requirement is removed by VK_KHR_synchronization2
5222 if (!(src_ignored || dst_ignored) && !sync2) {
5223 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005224 }
5225 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5226 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005227 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005228 }
5229 } else {
5230 // VK_SHARING_MODE_EXCLUSIVE
5231 if (src_queue_family != dst_queue_family) {
5232 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005233 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005234 }
5235 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005236 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005237 }
5238 }
5239 }
5240 } else {
5241 // No memory extension
5242 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005243 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5244 // this requirement is removed by VK_KHR_synchronization2
5245 if ((!src_ignored || !dst_ignored) && !sync2) {
5246 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005247 }
5248 } else {
5249 // VK_SHARING_MODE_EXCLUSIVE
5250 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005251 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005252 }
5253 }
5254 }
5255 return skip;
5256}
5257} // namespace barrier_queue_families
5258
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005259bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const CoreErrorLocation &loc, const ValidationStateTracker *state_data,
5260 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005261 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5262 uint32_t dst_queue_family) {
5263 using barrier_queue_families::ValidatorState;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005264 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005265 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5266}
5267
5268// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005269template <typename ImgBarrier>
5270bool CoreChecks::ValidateBarrierQueueFamilies(const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5271 const ImgBarrier &barrier, const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005272 // State data is required
5273 if (!state_data) {
5274 return false;
5275 }
5276
5277 // Create the validator state from the image state
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005278 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer), loc,
5279 VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005280 state_data->createInfo.sharingMode);
5281 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5282 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005283 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005284}
5285
5286// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005287template <typename BufBarrier>
5288bool CoreChecks::ValidateBarrierQueueFamilies(const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5289 const BufBarrier &barrier, const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005290 // State data is required
5291 if (!state_data) {
5292 return false;
5293 }
5294
5295 // Create the validator state from the buffer state
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005296 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer), loc,
5297 VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer),
5298 state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005299 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5300 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005301 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5302}
5303
5304template <typename Barrier>
5305bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5306 const Barrier &mem_barrier) const {
5307 using sync_vuid_maps::BufferError;
5308 using sync_vuid_maps::GetBufferBarrierVUID;
5309
5310 bool skip = false;
5311
5312 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5313
5314 // Validate buffer barrier queue family indices
5315 auto buffer_state = GetBufferState(mem_barrier.buffer);
5316 if (buffer_state) {
5317 auto buf_loc = loc.dot(Field::buffer);
5318 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
5319 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFuncName().c_str(), mem_vuid.c_str());
5320
5321 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5322
5323 auto buffer_size = buffer_state->createInfo.size;
5324 if (mem_barrier.offset >= buffer_size) {
5325 auto offset_loc = loc.dot(Field::offset);
5326 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5327
5328 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5329 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5330 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5331 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5332 auto size_loc = loc.dot(Field::size);
5333 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5334 skip |= LogError(objects, vuid,
5335 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5336 ".",
5337 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5338 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5339 }
5340 if (mem_barrier.size == 0) {
5341 auto size_loc = loc.dot(Field::size);
5342 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5343 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5344 report_data->FormatHandle(mem_barrier.buffer).c_str());
5345 }
5346 }
5347 return skip;
5348}
5349
5350template <typename Barrier>
5351bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5352 const Barrier &mem_barrier) const {
5353 bool skip = false;
5354
5355 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5356
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005357 bool is_ilt = true;
5358 if (enabled_features.synchronization2_features.synchronization2) {
5359 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5360 }
5361
5362 if (is_ilt) {
5363 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5364 auto layout_loc = loc.dot(Field::newLayout);
5365 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5366 skip |=
5367 LogError(cb_state->commandBuffer, vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005368 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005369 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005370 }
5371
5372 auto image_data = GetImageState(mem_barrier.image);
5373 if (image_data) {
5374 auto image_loc = loc.dot(Field::image);
5375
John Zulaufbea70432021-02-23 07:03:12 -07005376 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005377
5378 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5379
Jeremy Gebbenb1c48512021-02-22 17:34:28 -07005380 skip |= ValidateImageAspectMask(image_data->image, image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
5381 loc.StringFuncName().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005382
5383 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
5384 }
5385 return skip;
5386}
5387
5388bool CoreChecks::ValidateBarriers(const CoreErrorLocation &outer_loc, const CMD_BUFFER_STATE *cb_state,
5389 VkPipelineStageFlags src_stage_mask, VkPipelineStageFlags dst_stage_mask,
5390 uint32_t memBarrierCount, const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
5391 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5392 const VkImageMemoryBarrier *pImageMemBarriers) const {
5393 bool skip = false;
5394 auto queue_flags = GetQueueFlags(*cb_state);
5395 LogObjectList objects(cb_state->commandBuffer);
5396 auto op_type =
5397 ComputeBarrierOperationsType(cb_state, bufferBarrierCount, pBufferMemBarriers, imageMemBarrierCount, pImageMemBarriers);
5398
5399 // NOTE: for vkCmdPipelineBarrier() and vkCmdWaitEvents() the access mask checks use the function name for {refpage}
5400 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5401 const auto &mem_barrier = pMemBarriers[i];
5402 CoreErrorLocation loc(outer_loc.func_name, outer_loc.refpage, Field::pMemoryBarriers, i);
5403 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5404 }
5405 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5406 const auto &mem_barrier = pImageMemBarriers[i];
5407 CoreErrorLocation loc(outer_loc.func_name, outer_loc.refpage, Field::pImageMemoryBarriers, i);
5408 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5409
5410 loc.refpage = RefPage::VkImageMemoryBarrier;
5411 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5412 }
5413 {
5414 CoreErrorLocation loc(outer_loc.func_name, RefPage::VkImageMemoryBarrier);
5415 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5416 }
5417 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5418 const auto &mem_barrier = pBufferMemBarriers[i];
5419 CoreErrorLocation loc(outer_loc.func_name, outer_loc.refpage, Field::pBufferMemoryBarriers, i);
5420 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5421
5422 loc.refpage = RefPage::VkBufferMemoryBarrier;
5423 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5424 }
5425 return skip;
5426}
5427
5428bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const CoreErrorLocation &outer_loc,
5429 const CMD_BUFFER_STATE *cb_state, BarrierOperationsType op_type,
5430 const VkDependencyInfoKHR *dep_info) const {
5431 bool skip = false;
5432
5433 if (cb_state->activeRenderPass) {
5434 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5435 if (skip) return true; // Early return to avoid redundant errors from below calls
5436 }
5437 auto queue_flags = GetQueueFlags(*cb_state);
5438 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5439 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
5440 CoreErrorLocation loc = outer_loc.dot(Field::pMemoryBarriers, i);
5441 loc.refpage = RefPage::VkMemoryBarrier2KHR;
5442 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5443 }
5444 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5445 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
5446 CoreErrorLocation loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
5447 loc.refpage = RefPage::VkImageMemoryBarrier2KHR;
5448 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5449 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5450 }
5451 {
5452 CoreErrorLocation loc(outer_loc.func_name, RefPage::VkImageMemoryBarrier2KHR);
5453 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5454 }
5455
5456 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5457 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
5458 CoreErrorLocation loc = outer_loc.dot(Field::pBufferMemoryBarriers, i);
5459 loc.refpage = RefPage::VkBufferMemoryBarrier2KHR;
5460 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5461 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5462 }
5463
5464 return skip;
5465}
5466
5467template <typename Barrier>
5468bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, BarrierOperationsType op_type,
5469 VkQueueFlags queue_flags, const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
5470 VkPipelineStageFlags dst_stage_mask) const {
5471 bool skip = false;
5472 if (op_type == kAllRelease || op_type == kGeneral) {
5473 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5474 }
5475 if (op_type == kAllAcquire || op_type == kGeneral) {
5476 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5477 }
5478 return skip;
5479}
5480
5481template <typename Barrier>
5482bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, BarrierOperationsType op_type,
5483 VkQueueFlags queue_flags, const Barrier &barrier) const {
5484 bool skip = false;
5485 if (op_type == kAllRelease || op_type == kGeneral) {
5486 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
5487 skip |=
5488 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5489 }
5490 if (op_type == kAllAcquire || op_type == kGeneral) {
5491 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
5492 skip |=
5493 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5494 }
5495 return skip;
5496}
5497
5498bool CoreChecks::ValidateSubpassBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, VkQueueFlags queue_flags,
5499 const VkSubpassDependency2 &barrier) const {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005500 bool skip = false;
5501 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(barrier.pNext);
5502 if (mem_barrier) {
5503 if (enabled_features.synchronization2_features.synchronization2) {
5504 if (barrier.srcAccessMask != 0) {
5505 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5506 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5507 loc.dot(Field::srcAccessMask).Message().c_str());
5508 }
5509 if (barrier.dstAccessMask != 0) {
5510 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5511 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5512 loc.dot(Field::dstAccessMask).Message().c_str());
5513 }
5514 if (barrier.srcStageMask != 0 || barrier.dstStageMask != 0) {
5515 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5516 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5517 loc.dot(Field::srcStageMask).Message().c_str());
5518 }
5519 if (barrier.dstStageMask != 0) {
5520 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5521 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5522 loc.dot(Field::dstStageMask).Message().c_str());
5523 }
5524
5525 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc.dot(Field::pNext), kGeneral, queue_flags, *mem_barrier);
5526 return skip;
5527 } else {
5528 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5529 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5530 loc.Message().c_str());
5531 }
5532 }
5533 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc, kGeneral, queue_flags, barrier);
5534 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005535}
5536
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005537bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5538 const VkImageUsageFlags image_usage) const {
5539 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5540 bool skip = false;
5541
5542 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5543 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5544
5545 if (image_state->has_ahb_format == true) {
5546 // AHB image view and image share same feature sets
5547 tiling_features = image_state->format_features;
5548 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5549 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
5550 assert(device_extensions.vk_ext_image_drm_format_modifier);
5551 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5552 nullptr};
5553 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
5554
5555 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5556 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5557 nullptr};
5558 format_properties_2.pNext = (void *)&drm_properties_list;
5559 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5560
5561 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5562 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5563 0) {
5564 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5565 }
5566 }
5567 } else {
5568 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5569 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5570 : format_properties.optimalTilingFeatures;
5571 }
5572
5573 if (tiling_features == 0) {
5574 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
5575 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5576 "physical device.",
5577 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5578 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
5579 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
5580 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5581 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5582 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5583 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
5584 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
5585 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5586 "VK_IMAGE_USAGE_STORAGE_BIT.",
5587 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5588 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
5589 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
5590 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5591 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5592 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5593 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5594 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
5595 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
5596 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5597 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5598 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5599 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5600 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
5601 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
5602 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5603 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5604 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005605 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5606 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5607 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5608 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-04550",
5609 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5610 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5611 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5612 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005613 }
5614
5615 return skip;
5616}
5617
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005618bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005619 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005620 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005621 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005622 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005623 skip |=
5624 ValidateImageUsageFlags(image_state,
5625 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5626 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005627 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5628 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5629 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005630 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005631 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005632 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005633 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005634 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005635 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005636 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005637 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005638
5639 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5640 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005641 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005642 VkFormat view_format = pCreateInfo->format;
5643 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005644 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005645 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005646
Dave Houltonbd2e2622018-04-10 16:41:14 -06005647 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005648 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005649 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005650 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005651 if (!device_extensions.vk_ext_separate_stencil_usage) {
5652 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005653 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5654 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5655 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005656 }
5657 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005658 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005659 if (image_stencil_struct == nullptr) {
5660 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005661 skip |= LogError(
5662 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005663 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5664 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5665 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5666 }
5667 } else {
5668 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5669 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5670 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005671 skip |= LogError(
5672 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005673 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5674 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5675 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5676 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5677 }
5678 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5679 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005680 skip |= LogError(
5681 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005682 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5683 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5684 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5685 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5686 }
5687 }
5688 }
5689 }
5690
Dave Houltonbd2e2622018-04-10 16:41:14 -06005691 image_usage = chained_ivuci_struct->usage;
5692 }
5693
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005694 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5695 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005696 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005697 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005698 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005699 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005700 std::stringstream ss;
5701 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005702 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005703 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005704 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005705 }
5706 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005707 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005708 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5709 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005710 const char *error_vuid;
5711 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5712 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5713 } else if ((device_extensions.vk_khr_maintenance2) &&
5714 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5715 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5716 } else if ((!device_extensions.vk_khr_maintenance2) &&
5717 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5718 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5719 } else {
5720 // both enabled
5721 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5722 }
Dave Houltonc7988072018-04-16 11:46:56 -06005723 std::stringstream ss;
5724 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005725 << " is not in the same format compatibility class as "
5726 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005727 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5728 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005729 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005730 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005731 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005732 }
5733 } else {
5734 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005735 // Unless it is a multi-planar color bit aspect
5736 if ((image_format != view_format) &&
5737 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5738 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5739 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005740 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005741 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005742 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005743 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005744 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005745 }
5746 }
5747
5748 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005749 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005750
5751 switch (image_type) {
5752 case VK_IMAGE_TYPE_1D:
5753 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005754 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5755 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5756 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005757 }
5758 break;
5759 case VK_IMAGE_TYPE_2D:
5760 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5761 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5762 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005763 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5764 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5765 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005766 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005767 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5768 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5769 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005770 }
5771 }
5772 break;
5773 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005774 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005775 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5776 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005777 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005778 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005779 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5780 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5781 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005782 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5783 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005784 skip |= LogError(
5785 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5786 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5787 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5788 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5789 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005790 }
5791 } else {
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 } else {
5798 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005799 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5800 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5801 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005802 }
5803 }
5804 break;
5805 default:
5806 break;
5807 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005808
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005809 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005810 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005811 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005812 }
5813
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005814 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005815
Tobias Hector6663c9b2020-11-05 10:18:02 +00005816 if (enabled_features.shading_rate_image.shadingRateImage) {
5817 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5818 if (view_format != VK_FORMAT_R8_UINT) {
5819 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5820 "vkCreateImageView() If image was created with usage containing "
5821 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5822 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005823 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005824 }
5825
5826 if (enabled_features.shading_rate_image.shadingRateImage ||
5827 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5828 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5829 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5830 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5831 "vkCreateImageView() If image was created with usage containing "
5832 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5833 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5834 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005835 }
5836 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005837
Tobias Hector6663c9b2020-11-05 10:18:02 +00005838 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5839 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5840 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5841 pCreateInfo->subresourceRange.layerCount != 1) {
5842 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5843 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5844 pCreateInfo->subresourceRange.layerCount);
5845 }
5846
Jeff Bolz99e3f632020-03-24 22:59:22 -05005847 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5848 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5849 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5850 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5851 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5852 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5853 }
5854 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5855 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5856 skip |= LogError(
5857 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5858 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5859 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5860 }
5861 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005862
5863 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5864 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005865 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005866 "vkCreateImageView(): If image was created with usage containing "
5867 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5868 pCreateInfo->subresourceRange.levelCount);
5869 }
5870 }
5871 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5872 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005873 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005874 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5875 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5876 }
5877 } else {
5878 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5879 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5880 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005881 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005882 "vkCreateImageView(): If image was created with usage containing "
5883 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5884 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5885 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5886 }
5887 }
5888 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005889
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005890 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5891 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5892 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5893 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5894 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5895 }
5896 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5897 skip |=
5898 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5899 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5900 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5901 }
5902 }
5903 if (device_extensions.vk_ext_fragment_density_map_2) {
5904 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5905 (pCreateInfo->subresourceRange.layerCount >
5906 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5907 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5908 "vkCreateImageView(): If image was created with flags containing "
5909 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5910 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5911 pCreateInfo->subresourceRange.layerCount,
5912 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5913 }
5914 }
5915
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005916 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005917 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5918 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5919 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5920 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5921 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5922 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5923 }
5924 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005925
5926 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5927 // If swizzling is disabled, make sure it isn't used
5928 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5929 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5930 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5931 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5932 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5933 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5934 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5935 }
5936
5937 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5938 // disabled
5939 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5940 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5941 // spec. See Github issue #2361.
5942 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5943 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5944 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5945 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5946 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5947 "vkCreateImageView (portability error): ImageView format must have"
5948 " the same number of components and bits per component as the Image's format");
5949 }
5950 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005951 }
5952 return skip;
5953}
5954
Jeff Leger178b1e52020-10-05 12:22:23 -04005955template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005956bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005957 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005958 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005959 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5960 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5961 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005962
5963 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5964 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5965 VkDeviceSize src_min = UINT64_MAX;
5966 VkDeviceSize src_max = 0;
5967 VkDeviceSize dst_min = UINT64_MAX;
5968 VkDeviceSize dst_max = 0;
5969
5970 for (uint32_t i = 0; i < regionCount; i++) {
5971 src_min = std::min(src_min, pRegions[i].srcOffset);
5972 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5973 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5974 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5975
5976 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5977 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005978 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5979 skip |= LogError(src_buffer_state->buffer, vuid,
5980 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5981 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005982 }
5983
5984 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5985 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005986 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5987 skip |= LogError(dst_buffer_state->buffer, vuid,
5988 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5989 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005990 }
5991
5992 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5993 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005994 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5995 skip |= LogError(src_buffer_state->buffer, vuid,
5996 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005997 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005998 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005999 }
6000
6001 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
6002 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006003 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
6004 skip |= LogError(dst_buffer_state->buffer, vuid,
6005 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006006 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006007 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006008 }
6009 }
6010
6011 // The union of the source regions, and the union of the destination regions, must not overlap in memory
6012 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
6013 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006014 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6015 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
6016 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006017 }
6018 }
6019
6020 return skip;
6021}
6022
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006023bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006024 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006025 const auto cb_node = GetCBState(commandBuffer);
6026 const auto src_buffer_state = GetBufferState(srcBuffer);
6027 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006028
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006029 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006030 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
6031 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006032 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06006033 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006034 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
6035 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06006036 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006037 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
6038 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07006039 skip |=
6040 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6041 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006042 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
6043 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04006044 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07006045 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
6046 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
6047 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006048 return skip;
6049}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006050
Jeff Leger178b1e52020-10-05 12:22:23 -04006051bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6052 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
6053 const auto cb_node = GetCBState(commandBuffer);
6054 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
6055 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
6056
6057 bool skip = false;
6058 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
6059 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
6060 // Validate that SRC & DST buffers have correct usage flags set
6061 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
6062 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
6063 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6064 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
6065 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
6066 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6067 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
6068 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6069 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
6070 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
6071 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
6072 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
6073 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
6074 skip |=
6075 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
6076 skip |=
6077 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
6078 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
6079 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
6080 return skip;
6081}
6082
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006083bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006084 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006085 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006086 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006087 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006088 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6089 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006090 }
6091 }
6092 return skip;
6093}
6094
Jeff Bolz5c801d12019-10-09 10:38:45 -05006095bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6096 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006097 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06006098 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006099
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006100 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006101 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006102 skip |=
6103 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006104 }
6105 return skip;
6106}
6107
Jeff Bolz5c801d12019-10-09 10:38:45 -05006108bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006109 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006110
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006111 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006112 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006113 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006114 }
6115 return skip;
6116}
6117
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006118bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006119 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006120 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06006121 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006122 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006123 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006124 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006125 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006126 }
6127 return skip;
6128}
6129
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006130bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006131 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006132 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006133 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006134 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006135 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07006136 skip |=
6137 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6138 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006139 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006140 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006141 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6142 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006143 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006144
sfricke-samsung022fa252020-07-24 03:26:16 -07006145 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6146 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6147
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006148 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006149 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6150 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6151 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6152 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006153 }
6154
6155 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006156 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6157 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6158 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6159 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006160 }
6161
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006162 return skip;
6163}
6164
Jeff Leger178b1e52020-10-05 12:22:23 -04006165template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006166bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006167 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006168 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006169 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006170 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6171 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006172
sfricke-samsung125d2b42020-05-28 06:32:43 -07006173 assert(image_state != nullptr);
6174 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006175
6176 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006177 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006178 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6179 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006180 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006181 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6182 "and 1, respectively.",
6183 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006184 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006185 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006186
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006187 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6188 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006189 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006190 "%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 -07006191 "must be 0 and 1, respectively.",
6192 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006193 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006194 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006195
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006196 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6197 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006198 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006199 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006200 "For 3D images these must be 0 and 1, respectively.",
6201 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006202 }
6203 }
6204
6205 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006206 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08006207 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
6208 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006209
sfricke-samsung8feecc12021-01-23 03:28:38 -08006210 if (FormatIsDepthOrStencil(image_format)) {
6211 if (SafeModulo(bufferOffset, 4) != 0) {
6212 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
6213 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6214 " must be a multiple 4 if using a depth/stencil format (%s).",
6215 function, i, bufferOffset, string_VkFormat(image_format));
6216 }
6217 } else {
6218 // If not depth/stencil and not multi-plane
6219 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
6220 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
6221 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6222 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
6223 skip |= LogError(image_state->image, vuid,
6224 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6225 " must be a multiple of this format's texel size (%" PRIu32 ").",
6226 function, i, bufferOffset, element_size);
6227 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006228 }
6229
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006230 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6231 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006232 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006233 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006234 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006235 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006236 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006237 }
6238
6239 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6240 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006241 vuid =
6242 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006243 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006244 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006245 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6246 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006247 }
6248
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006249 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006250 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006251 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006252 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 -06006253 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6254 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006255 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006256 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006257 "zero or <= image subresource width (%d).",
6258 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006259 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006260 }
6261
6262 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006263 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 -06006264 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6265 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006266 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006267 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006268 "zero or <= image subresource height (%d).",
6269 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006270 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006271 }
6272
6273 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006274 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 -06006275 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6276 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006277 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006278 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006279 "zero or <= image subresource depth (%d).",
6280 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006281 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006282 }
6283
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006284 // subresource aspectMask must have exactly 1 bit set
6285 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006286 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006287 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006288 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
6289 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006290 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006291 }
6292
6293 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006294 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006295 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006296 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006297 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6298 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006299 }
6300
6301 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006302 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6303 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006304
6305 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006306 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006307 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006308 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006309 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
6310 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006311 }
6312
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006313 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006314 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006315 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006316 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006317 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006318 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006319 }
6320
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006321 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006322 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6323 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6324 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006325 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006326 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006327 "width & height (%d, %d)..",
6328 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6329 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006330 }
6331
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006332 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07006333 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006334 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006335 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006336 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006337 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006338 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006339 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006340
6341 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07006342 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06006343 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006344 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006345 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006346 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006347 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
6348 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6349 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006350 }
6351
6352 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006353 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006354 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006355 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006356 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006357 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
6358 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6359 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006360 }
6361
6362 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006363 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006364 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006365 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006366 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006367 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
6368 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6369 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006370 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006371 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006372
6373 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006374 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006375 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006376 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006377 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006378 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006379 "format has three planes.",
6380 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006381 }
6382
6383 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006384 if (0 ==
6385 (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 -07006386 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006387 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006388 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6389 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006390 } else {
6391 // Know aspect mask is valid
6392 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6393 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006394 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006395 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006396 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006397 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006398 " 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 -08006399 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006400 string_VkFormat(compatible_format));
6401 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006402 }
6403 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006404
6405 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6406 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6407 assert(command_pool != nullptr);
6408 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6409 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6410 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
6411 LogObjectList objlist(cb_node->commandBuffer);
6412 objlist.add(command_pool->commandPool);
6413 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
6414 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6415 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6416 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6417 "VK_QUEUE_COMPUTE_BIT flag.",
6418 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6419 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6420 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006421 }
6422
6423 return skip;
6424}
6425
Jeff Leger178b1e52020-10-05 12:22:23 -04006426template <typename BufferImageCopyRegionType>
6427bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6428 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006429 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006430 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006431
6432 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006433 VkExtent3D extent = pRegions[i].imageExtent;
6434 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006435
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006436 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6437 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006438 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
6439 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6440 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006441 }
6442
6443 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
6444
6445 // 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 -06006446 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006447 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006448 if (image_extent.width % block_extent.width) {
6449 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6450 }
6451 if (image_extent.height % block_extent.height) {
6452 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6453 }
6454 if (image_extent.depth % block_extent.depth) {
6455 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6456 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006457 }
6458
Dave Houltonfc1a4052017-04-27 14:32:45 -06006459 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006460 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006461 }
6462 }
6463
6464 return skip;
6465}
6466
Jeff Leger178b1e52020-10-05 12:22:23 -04006467template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006468bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006469 const BufferImageCopyRegionType *pRegions, const char *func_name,
6470 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006471 bool skip = false;
6472
6473 VkDeviceSize buffer_size = buff_state->createInfo.size;
6474
6475 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07006476 VkDeviceSize max_buffer_offset =
6477 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
6478 if (buffer_size < max_buffer_offset) {
6479 skip |=
6480 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 -07006481 }
6482 }
6483
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006484 return skip;
6485}
6486
Jeff Leger178b1e52020-10-05 12:22:23 -04006487template <typename BufferImageCopyRegionType>
6488bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6489 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6490 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006491 const auto cb_node = GetCBState(commandBuffer);
6492 const auto src_image_state = GetImageState(srcImage);
6493 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006494
Jeff Leger178b1e52020-10-05 12:22:23 -04006495 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6496 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
6497 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
6498 const char *vuid;
6499
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006500 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006501
6502 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006503 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006504
6505 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006506 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006507
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006508 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006509
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006510 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006511 vuid =
6512 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6513 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6514 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6515 "or transfer capabilities.",
6516 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006517 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006518 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
6519 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6520 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6521 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006522
Jeff Leger178b1e52020-10-05 12:22:23 -04006523 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6524 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6525 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6526
6527 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6528 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6529 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6530 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006531
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006532 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006533 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6534 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006535 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006536 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6537 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006538 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006539 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6540 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6541 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6542 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6543 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6544 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006545
6546 // Validation for VK_EXT_fragment_density_map
6547 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006548 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
6549 skip |= LogError(cb_node->commandBuffer, vuid,
6550 "%s: srcImage must not have been created with flags containing "
6551 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6552 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006553 }
6554
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006555 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006556 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6557 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006558 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006559 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
6560 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06006561 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006562
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006563 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 -04006564 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6565 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6566 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6567 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
6568
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006569 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006570 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6571 vuid =
6572 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006573 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006574 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6575 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6576 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6577 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6578 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6579 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6580 "imageSubresource", vuid);
6581 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6582 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006583 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006584 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006585 }
6586 return skip;
6587}
6588
Jeff Leger178b1e52020-10-05 12:22:23 -04006589bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6590 VkBuffer dstBuffer, uint32_t regionCount,
6591 const VkBufferImageCopy *pRegions) const {
6592 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6593 COPY_COMMAND_VERSION_1);
6594}
6595
6596bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6597 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6598 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6599 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6600 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6601}
6602
John Zulauf1686f232019-07-09 16:27:11 -06006603void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6604 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6605 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6606
6607 auto cb_node = GetCBState(commandBuffer);
6608 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006609 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006610 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006611 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006612 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006613}
6614
Jeff Leger178b1e52020-10-05 12:22:23 -04006615void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6616 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6617 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6618
6619 auto cb_node = GetCBState(commandBuffer);
6620 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6621 // Make sure that all image slices record referenced layout
6622 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6623 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6624 pCopyImageToBufferInfo->srcImageLayout);
6625 }
6626}
6627
6628template <typename RegionType>
6629bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6630 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6631 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006632 const auto cb_node = GetCBState(commandBuffer);
6633 const auto src_buffer_state = GetBufferState(srcBuffer);
6634 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006635
Jeff Leger178b1e52020-10-05 12:22:23 -04006636 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6637 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
6638 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
6639 const char *vuid;
6640
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006641 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006642
6643 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006644 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006645
sfricke-samsungea4fd142020-10-17 23:51:59 -07006646 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
6647 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
6648
Jeff Leger178b1e52020-10-05 12:22:23 -04006649 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
6650 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6651 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6652 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6653
6654 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6655 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6656 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6657 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6658 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6659 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6660 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6661 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6662 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006663 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006664 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6665 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006666 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006667 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6668 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6669 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6670 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6671 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6672 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006673
6674 // Validation for VK_EXT_fragment_density_map
6675 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006676 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
6677 skip |= LogError(cb_node->commandBuffer, vuid,
6678 "%s: dstImage must not have been created with flags containing "
6679 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6680 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006681 }
6682
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006683 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006684 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6685 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006686 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006687 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
6688 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06006689 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006690
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006691 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 -04006692 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6693 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6694 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6695 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6696
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006697 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006698 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6699 vuid =
6700 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006701 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006702 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6703 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6704 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6705 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6706 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6707 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6708 "imageSubresource", vuid);
6709 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6710 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006711 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006712 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006713
6714 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6715 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6716 assert(command_pool != nullptr);
6717 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6718 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6719 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6720 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6721 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
6722 LogObjectList objlist(cb_node->commandBuffer);
6723 objlist.add(command_pool->commandPool);
6724 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6725 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
6726 skip |= LogError(dst_image_state->image, vuid,
6727 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6728 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6729 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
6730 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6731 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6732 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006733 }
6734 return skip;
6735}
6736
Jeff Leger178b1e52020-10-05 12:22:23 -04006737bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6738 VkImageLayout dstImageLayout, uint32_t regionCount,
6739 const VkBufferImageCopy *pRegions) const {
6740 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6741 COPY_COMMAND_VERSION_1);
6742}
6743
6744bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6745 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6746 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6747 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6748 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6749}
6750
John Zulauf1686f232019-07-09 16:27:11 -06006751void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6752 VkImageLayout dstImageLayout, uint32_t regionCount,
6753 const VkBufferImageCopy *pRegions) {
6754 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6755
6756 auto cb_node = GetCBState(commandBuffer);
6757 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006758 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006759 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006760 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006761 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006762}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006763
Jeff Leger178b1e52020-10-05 12:22:23 -04006764void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6765 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6766 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6767
6768 auto cb_node = GetCBState(commandBuffer);
6769 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6770 // Make sure that all image slices are record referenced layout
6771 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6772 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6773 pCopyBufferToImageInfo2KHR->dstImageLayout);
6774 }
6775}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006776bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006777 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006778 bool skip = false;
6779 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6780
Dave Houlton1d960ff2018-01-19 12:17:05 -07006781 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006782 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6783 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6784 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006785 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6786 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006787 }
6788
John Zulaufa26d3c82019-08-14 16:09:08 -06006789 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006790 if (!image_entry) {
6791 return skip;
6792 }
6793
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006794 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6795 if (device_extensions.vk_ext_image_drm_format_modifier) {
6796 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6797 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006798 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6799 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6800 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006801 }
6802 } else {
6803 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006804 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6805 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006806 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006807 }
6808
Dave Houlton1d960ff2018-01-19 12:17:05 -07006809 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006810 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006811 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6812 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6813 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006814 }
6815
Dave Houlton1d960ff2018-01-19 12:17:05 -07006816 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006817 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006818 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6819 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6820 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006821 }
6822
Dave Houlton1d960ff2018-01-19 12:17:05 -07006823 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006824 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006825 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6826 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006827 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006828 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6829 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006830 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006831 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6832 }
6833 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006834 skip |= LogError(image, vuid,
6835 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6836 ") must be a single-plane specifier flag.",
6837 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006838 }
6839 } else if (FormatIsColor(img_format)) {
6840 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006841 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6842 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6843 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006844 }
6845 } else if (FormatIsDepthOrStencil(img_format)) {
6846 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6847 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006848 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006849 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6850 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6851 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6852 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006853 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6854 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6855 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006856 }
6857 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006858
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006859 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006860 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006861 }
6862
Mike Weiblen672b58b2017-02-21 14:32:53 -07006863 return skip;
6864}
sfricke-samsung022fa252020-07-24 03:26:16 -07006865
6866// Validates the image is allowed to be protected
6867bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006868 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006869 bool skip = false;
6870 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6871 LogObjectList objlist(cb_state->commandBuffer);
6872 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006873 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 -07006874 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006875 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006876 }
6877 return skip;
6878}
6879
6880// Validates the image is allowed to be unprotected
6881bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006882 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006883 bool skip = false;
6884 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6885 LogObjectList objlist(cb_state->commandBuffer);
6886 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006887 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 -07006888 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006889 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006890 }
6891 return skip;
6892}
6893
6894// Validates the buffer is allowed to be protected
6895bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006896 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006897 bool skip = false;
6898 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6899 LogObjectList objlist(cb_state->commandBuffer);
6900 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006901 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 -07006902 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006903 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006904 }
6905 return skip;
6906}
6907
6908// Validates the buffer is allowed to be unprotected
6909bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006910 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006911 bool skip = false;
6912 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6913 LogObjectList objlist(cb_state->commandBuffer);
6914 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006915 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 -07006916 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006917 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006918 }
6919 return skip;
6920}