blob: 9f3269322b7e5f27e575e024d105c6ed25cf81d7 [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
John Zulauf2d60a452021-03-04 15:12:03 -0700476bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
477 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image_state.image);
John Zulauf2076e812020-01-08 14:55:54 -0700478 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700479 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
480 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
481
John Zulauf2076e812020-01-08 14:55:54 -0700482 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
483
484 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
John Zulauf2d60a452021-03-04 15:12:03 -0700485 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700486 return false;
487 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700488
John Zulauf79f06582021-02-27 18:38:39 -0700489 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700490 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700491 }
492 return true;
493}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700494
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600495// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600496void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600497 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
498 VkImageLayout expected_layout) {
499 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
500 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600501 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600502 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700503 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700504 for (const auto &image : image_state.aliasing_images) {
505 auto alias_state = GetImageState(image);
506 // The map state of the aliases should all be in sync, so no need to check the return value
507 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
508 assert(subresource_map);
509 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
510 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700511}
John Zulauff660ad62019-03-23 07:16:05 -0600512
513// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600514void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600515 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500516 return;
517 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500518 IMAGE_STATE *image_state = view_state.image_state.get();
519 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700520 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700521 for (const auto &image : image_state->aliasing_images) {
522 image_state = GetImageState(image);
523 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
524 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
525 }
John Zulauff660ad62019-03-23 07:16:05 -0600526}
527
528// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600529void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600530 const VkImageSubresourceRange &range, VkImageLayout layout) {
531 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
532 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600533 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700534 for (const auto &image : image_state.aliasing_images) {
535 auto alias_state = GetImageState(image);
536 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
537 assert(subresource_map);
538 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
539 }
John Zulauff660ad62019-03-23 07:16:05 -0600540}
541
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600542void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600543 VkImageLayout layout) {
544 const IMAGE_STATE *image_state = GetImageState(image);
545 if (!image_state) return;
546 SetImageInitialLayout(cb_node, *image_state, range, layout);
547};
548
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600549void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600550 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
551 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600552}
Dave Houltonddd65c52018-05-08 14:58:01 -0600553
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600554// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700555void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
556 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500557 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600558
John Zulauff660ad62019-03-23 07:16:05 -0600559 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600560 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
561 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600562 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state.create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
Dave Houltonddd65c52018-05-08 14:58:01 -0600563 sub_range.baseArrayLayer = 0;
564 sub_range.layerCount = image_state->createInfo.extent.depth;
565 }
566
Piers Daniell4fde9b72019-11-27 16:19:46 -0700567 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
568 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
569 SetImageLayout(cb_node, *image_state, sub_range, layout);
570 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
571 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
572 } else {
573 SetImageLayout(cb_node, *image_state, sub_range, layout);
574 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600575}
576
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700577bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
578 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700579 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600580 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100581 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700582 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100583 const char *vuid;
584 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700585 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100586
587 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600588 LogObjectList objlist(image);
589 objlist.add(renderpass);
590 objlist.add(framebuffer);
591 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700592 skip |=
593 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
594 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
595 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
596 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100597 return skip;
598 }
599
600 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700601 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200602 if (stencil_usage_info) {
603 image_usage |= stencil_usage_info->stencilUsage;
604 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100605
606 // Check for layouts that mismatch image usages in the framebuffer
607 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800608 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600609 LogObjectList objlist(image);
610 objlist.add(renderpass);
611 objlist.add(framebuffer);
612 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700613 skip |= LogError(objlist, vuid,
614 "%s: Layout/usage mismatch for attachment %u in %s"
615 " - the %s is %s but the image attached to %s via %s"
616 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
617 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
618 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
619 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100620 }
621
622 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
623 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800624 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600625 LogObjectList objlist(image);
626 objlist.add(renderpass);
627 objlist.add(framebuffer);
628 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700629 skip |= LogError(objlist, vuid,
630 "%s: Layout/usage mismatch for attachment %u in %s"
631 " - the %s is %s but the image attached to %s via %s"
632 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
633 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
634 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
635 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100636 }
637
638 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800639 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600640 LogObjectList objlist(image);
641 objlist.add(renderpass);
642 objlist.add(framebuffer);
643 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700644 skip |= LogError(objlist, vuid,
645 "%s: Layout/usage mismatch for attachment %u in %s"
646 " - the %s is %s but the image attached to %s via %s"
647 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
648 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
649 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
650 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100651 }
652
653 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800654 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600655 LogObjectList objlist(image);
656 objlist.add(renderpass);
657 objlist.add(framebuffer);
658 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700659 skip |= LogError(objlist, vuid,
660 "%s: Layout/usage mismatch for attachment %u in %s"
661 " - the %s is %s but the image attached to %s via %s"
662 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
663 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
664 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
665 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100666 }
667
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600668 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100669 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
670 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
671 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
672 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
673 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800674 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600675 LogObjectList objlist(image);
676 objlist.add(renderpass);
677 objlist.add(framebuffer);
678 objlist.add(image_view);
679 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700680 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700681 " - the %s is %s but the image attached to %s via %s"
682 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700683 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700684 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
685 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100686 }
687 } else {
688 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
689 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
690 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
691 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600692 LogObjectList objlist(image);
693 objlist.add(renderpass);
694 objlist.add(framebuffer);
695 objlist.add(image_view);
696 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700697 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700698 " - the %s is %s but the image attached to %s via %s"
699 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700700 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700701 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
702 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100703 }
704 }
705 return skip;
706}
707
John Zulauf17a01bb2019-08-09 16:41:19 -0600708bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700709 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600710 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600711 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700712 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
713 auto const &framebuffer_info = framebuffer_state->createInfo;
714 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100715
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700716 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100717 auto framebuffer = framebuffer_state->framebuffer;
718
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700719 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700720 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
721 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700722 }
John Zulauf8e308292018-09-21 11:34:37 -0600723
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700724 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800725 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700726 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100727 }
728
Tobias Hectorc9057422019-07-23 12:15:52 +0100729 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700730 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
731 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100732 auto image_view = attachments[i];
733 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100734
Tobias Hectorc9057422019-07-23 12:15:52 +0100735 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600736 LogObjectList objlist(pRenderPassBegin->renderPass);
737 objlist.add(framebuffer_state->framebuffer);
738 objlist.add(image_view);
739 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700740 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
741 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
742 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100743 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100744 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100745
746 const VkImage image = view_state->create_info.image;
747 const IMAGE_STATE *image_state = GetImageState(image);
748
749 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600750 LogObjectList objlist(pRenderPassBegin->renderPass);
751 objlist.add(framebuffer_state->framebuffer);
752 objlist.add(image_view);
753 objlist.add(image);
754 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700755 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
756 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
757 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100758 continue;
759 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700760 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
761 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100762
Piers Daniell7f894f62020-01-09 16:33:48 -0700763 // Default to expecting stencil in the same layout.
764 auto attachment_stencil_initial_layout = attachment_initial_layout;
765
766 // If a separate layout is specified, look for that.
767 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700768 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700769 if (attachment_description_stencil_layout) {
770 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
771 }
772
Tobias Hectorc9057422019-07-23 12:15:52 +0100773 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
774 // in common with the non-const version.)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700775 const ImageSubresourceLayoutMap *subresource_map = (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED)
776 ? GetImageSubresourceLayoutMap(const_p_cb, image)
777 : nullptr;
Tobias Hectorc9057422019-07-23 12:15:52 +0100778
779 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
780 LayoutUseCheckAndMessage layout_check(subresource_map);
781 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700782 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700783 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
784 // the next "constant value" range
785 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700786 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700787
John Zulauf5e617452019-11-19 14:44:16 -0700788 // Allow for differing depth and stencil layouts
789 VkImageLayout check_layout = attachment_initial_layout;
790 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
791
792 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700793 subres_skip |= LogError(
794 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700795 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
796 "and the %s layout of the attachment is %s. The layouts must match, or the render "
797 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700798 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100799 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700800 }
John Zulauf5e617452019-11-19 14:44:16 -0700801
Tobias Hectorc9057422019-07-23 12:15:52 +0100802 skip |= subres_skip;
803 }
804
805 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
806 framebuffer, render_pass, i, "initial layout");
807
808 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
809 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100810 }
811
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700812 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
813 auto &subpass = render_pass_info->pSubpasses[j];
814 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100815 auto &attachment_ref = subpass.pInputAttachments[k];
816 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
817 auto image_view = attachments[attachment_ref.attachment];
818 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100819
Tobias Hectorc9057422019-07-23 12:15:52 +0100820 if (view_state) {
821 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700822 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
823 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100824 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100825 }
826 }
827 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100828
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700829 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100830 auto &attachment_ref = subpass.pColorAttachments[k];
831 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
832 auto image_view = attachments[attachment_ref.attachment];
833 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100834
Tobias Hectorc9057422019-07-23 12:15:52 +0100835 if (view_state) {
836 auto image = view_state->create_info.image;
837 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
838 framebuffer, render_pass, attachment_ref.attachment,
839 "color attachment layout");
840 if (subpass.pResolveAttachments) {
841 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
842 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
843 attachment_ref.attachment, "resolve attachment layout");
844 }
845 }
846 }
847 }
848
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700849 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100850 auto &attachment_ref = *subpass.pDepthStencilAttachment;
851 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
852 auto image_view = attachments[attachment_ref.attachment];
853 auto view_state = GetImageViewState(image_view);
854
855 if (view_state) {
856 auto image = view_state->create_info.image;
857 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
858 framebuffer, render_pass, attachment_ref.attachment,
859 "input attachment layout");
860 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100861 }
862 }
863 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700864 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600865 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700866}
867
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600868void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700869 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700870 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinski8d46f802020-12-07 16:33:54 -0700871 IMAGE_VIEW_STATE *image_view = GetActiveAttachmentImageViewState(pCB, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600872 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700873 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700874 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700875 if (attachment_reference_stencil_layout) {
876 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
877 }
878
879 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600880 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700881 }
882}
883
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600884void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
885 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700886 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700887
888 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700889 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700890 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700891 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700892 }
893 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700894 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700895 }
896 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700897 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700898 }
899 }
900}
901
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700902// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
903// 1. Transition into initialLayout state
904// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600905void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700906 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700907 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700908 auto const rpci = render_pass_state->createInfo.ptr();
909 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -0700910 auto *view_state = GetActiveAttachmentImageViewState(cb_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600911 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700912 IMAGE_STATE *image_state = view_state->image_state.get();
913 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700914 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700915 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700916 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700917 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
918 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
919 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
920 SetImageInitialLayout(cb_state, *image_state, sub_range, initial_layout);
921 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
922 SetImageInitialLayout(cb_state, *image_state, sub_range, stencil_initial_layout);
923 } else {
924 SetImageInitialLayout(cb_state, *image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700925 }
John Zulauf8e308292018-09-21 11:34:37 -0600926 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700927 }
928 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700929 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700930}
931
Dave Houlton10b39482017-03-16 13:18:15 -0600932bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600933 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600934 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600935 }
936 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600937 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600938 }
939 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600940 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600941 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800942 if (0 != (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700943 if (FormatPlaneCount(format) == 1) return false;
944 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600945 return true;
946}
947
Mike Weiblen62d08a32017-03-07 22:18:27 -0700948// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700949bool CoreChecks::ValidateBarrierLayoutToImageUsage(const CoreErrorLocation &loc, VkImage image, VkImageLayout layout,
950 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700951 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700952 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700953 switch (layout) {
954 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700955 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700956 break;
957 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700958 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700959 break;
960 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700961 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700962 break;
963 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700964 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700965 break;
966 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700967 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700968 break;
969 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700970 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700971 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600972 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700973 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500974 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700975 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700976 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700977 break;
978 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700979 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700980 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700981 default:
982 // Other VkImageLayout values do not have VUs defined in this context.
983 break;
984 }
985
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700986 if (is_error) {
987 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
988
989 skip |=
990 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
991 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700992 }
993 return skip;
994}
995
996// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700997template <typename ImageBarrier>
998bool CoreChecks::ValidateBarriersToImages(const CoreErrorLocation &outer_loc, const CMD_BUFFER_STATE *cb_state,
999 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001000 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001001 using sync_vuid_maps::GetImageBarrierVUID;
1002 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +02001003 // Scoreboard for checking for duplicate and inconsistent barriers to images
1004 struct ImageBarrierScoreboardEntry {
1005 uint32_t index;
1006 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
1007 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001008 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +02001009 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001010 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
1011 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
1012 // when creating maps full of maps.
1013 struct ImageBarrierScoreboardSubresMap {
1014 std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
1015 };
Petr Krausad0096a2019-08-09 18:35:04 +02001016 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
1017
John Zulauf463c51e2018-05-31 13:29:20 -06001018 // Scoreboard for duplicate layout transition barriers within the list
1019 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
1020 ImageBarrierScoreboardImageMap layout_transitions;
1021
Mike Weiblen62d08a32017-03-07 22:18:27 -07001022 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001023 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +02001024 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -07001025
John Zulauf463c51e2018-05-31 13:29:20 -06001026 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
1027 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
1028 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +02001029 if (img_barrier.oldLayout != img_barrier.newLayout) {
1030 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
1031 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -06001032 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001033 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +02001034 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -06001035 if (subres_it != subres_map.end()) {
1036 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001037 auto entry_layout =
1038 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
1039 auto old_layout =
1040 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
1041 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +02001042 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001043 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001044 skip = LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001045 cb_state->commandBuffer, vuid,
1046 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -06001047 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
1048 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001049 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +02001050 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
1051 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -06001052 }
1053 entry = new_entry;
1054 } else {
Petr Krausad0096a2019-08-09 18:35:04 +02001055 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001056 }
1057 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001058 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001059 }
1060 }
1061
Petr Krausad0096a2019-08-09 18:35:04 +02001062 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001063 if (image_state) {
1064 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001065 skip |=
1066 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
1067 skip |=
1068 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001069
1070 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
1071 if (image_state->layout_locked) {
1072 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001073 skip |= LogError(
1074 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001075 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001076 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001077 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1078 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001079 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001080
John Zulaufa4472282019-08-22 14:44:34 -06001081 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -07001082 const VkFormat image_format = image_create_info.format;
1083 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -06001084 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001085 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -07001086 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001087 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06001088 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001089 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
1090 skip |= LogError(img_barrier.image, vuid,
1091 "%s references %s of format %s that must have either the depth or stencil "
1092 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1093 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1094 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001095 }
1096 } else {
1097 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1098 if ((aspect_mask & ds_mask) != (ds_mask)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001099 auto error = device_extensions.vk_khr_separate_depth_stencil_layouts
1100 ? ImageError::kNotSeparateDepthAndStencilAspect
1101 : ImageError::kNotDepthAndStencilAspect;
1102 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -07001103 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001104 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001105 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001106 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001107 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001108 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001109 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001110 }
John Zulauff660ad62019-03-23 07:16:05 -06001111
Petr Krausad0096a2019-08-09 18:35:04 +02001112 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1113 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001114 // TODO: Set memory invalid which is in mem_tracker currently
1115 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1116 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001117 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001118 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001119 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001120 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001121 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1122 // the next "constant value" range
1123 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001124 const auto &value = *pos;
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001125 auto old_layout =
1126 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
1127 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001128 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
1129 subres_skip = LogError(cb_state->commandBuffer, vuid,
1130 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
1131 "%s layout is %s.",
1132 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1133 value.subresource.aspectMask, value.subresource.mipLevel,
1134 value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1135 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001136 }
John Zulauf5e617452019-11-19 14:44:16 -07001137 }
John Zulauff660ad62019-03-23 07:16:05 -06001138 skip |= subres_skip;
1139 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001140
1141 // checks color format and (single-plane or non-disjoint)
1142 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1143 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001144 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001145 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001146 auto error = device_extensions.vk_khr_sampler_ycbcr_conversion ? ImageError::kNotColorAspect
1147 : ImageError::kNotColorAspectYcbcr;
1148 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -07001149 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001150 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -07001151 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001152 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001153 string_VkFormat(image_format), aspect_mask);
1154 }
1155 }
1156
1157 VkImageAspectFlags valid_disjoint_mask =
1158 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
sfricke-samsung71bc6572020-04-29 15:49:43 -07001159 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001160 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001161 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
1162 skip |= LogError(img_barrier.image, vuid,
1163 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -07001164 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001165 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001166 string_VkFormat(image_format), aspect_mask);
1167 }
1168
1169 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001170 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1171 skip |= LogError(img_barrier.image, vuid,
1172 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -07001173 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001174 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001175 string_VkFormat(image_format), aspect_mask);
1176 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001177 }
1178 }
1179 return skip;
1180}
1181
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001182template <typename Barrier, typename TransferBarrier>
1183bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
1184 const Barrier &barrier,
1185 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001186 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001187 auto pool = cb_state->command_pool.get();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001188 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001189 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001190 if (!IsTransferOp(barrier)) {
1191 return skip;
1192 }
1193 const TransferBarrier *barrier_record = nullptr;
1194 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, barrier) &&
1195 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1196 const auto found = barrier_sets.release.find(barrier);
1197 if (found != barrier_sets.release.cend()) {
1198 barrier_record = &(*found);
1199 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001200 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001201 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, barrier) &&
1202 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1203 const auto found = barrier_sets.acquire.find(barrier);
1204 if (found != barrier_sets.acquire.cend()) {
1205 barrier_record = &(*found);
1206 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001207 }
1208 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001209 if (barrier_record != nullptr) {
1210 skip |=
1211 LogWarning(cb_state->commandBuffer, TransferBarrier::ErrMsgDuplicateQFOInCB(),
1212 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1213 " duplicates existing barrier recorded in this command buffer.",
1214 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1215 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1216 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001217 return skip;
1218}
1219
John Zulaufa4472282019-08-22 14:44:34 -06001220VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1221 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1222}
1223
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001224VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1225 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1226}
1227
John Zulaufa4472282019-08-22 14:44:34 -06001228const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1229 return device_state.GetImageState(barrier.image);
1230}
1231
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001232const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1233 return device_state.GetImageState(barrier.image);
1234}
1235
John Zulaufa4472282019-08-22 14:44:34 -06001236VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1237 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1238}
1239
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001240VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1241 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1242}
1243
John Zulaufa4472282019-08-22 14:44:34 -06001244const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1245 return device_state.GetBufferState(barrier.buffer);
1246}
1247
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001248const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1249 return device_state.GetBufferState(barrier.buffer);
1250}
John Zulaufa4472282019-08-22 14:44:34 -06001251
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001252template <typename Barrier, typename TransferBarrier>
1253void CoreChecks::RecordBarrierValidationInfo(const CoreErrorLocation &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
1254 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001255 auto pool = cb_state->command_pool.get();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001256 if (IsTransferOp(barrier)) {
1257 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, barrier) &&
1258 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1259 barrier_sets.release.emplace(barrier);
1260 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, barrier) &&
1261 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1262 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001263 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001264 }
John Zulaufa4472282019-08-22 14:44:34 -06001265
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001266 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1267 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1268 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1269 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1270 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1271 auto handle_state = BarrierHandleState(*this, barrier);
1272 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1273 if (!mode_concurrent) {
1274 const auto typed_handle = BarrierTypedHandle(barrier);
John Zulaufb4438f02021-02-20 20:22:16 -07001275 CoreErrorLocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001276 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001277 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1278 const QUEUE_STATE *queue_state) {
1279 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001280 src_queue_family, dst_queue_family);
1281 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001282 }
1283 }
1284}
1285
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001286// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001287template <typename ImgBarrier>
1288bool CoreChecks::ValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001289 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1290 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001291 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1292 using sync_vuid_maps::GetImageBarrierVUID;
1293 using sync_vuid_maps::ImageError;
1294
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001295 bool skip = false;
1296 const auto *fb_state = framebuffer;
1297 assert(fb_state);
1298 const auto img_bar_image = img_barrier.image;
1299 bool image_match = false;
1300 bool sub_image_found = false; // Do we find a corresponding subpass description
1301 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1302 uint32_t attach_index = 0;
1303 // Verify that a framebuffer image matches barrier image
1304 const auto attachment_count = fb_state->createInfo.attachmentCount;
1305 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
1306 auto view_state = GetActiveAttachmentImageViewState(cb_state, attachment, primary_cb_state);
1307 if (view_state && (img_bar_image == view_state->create_info.image)) {
1308 image_match = true;
1309 attach_index = attachment;
1310 break;
1311 }
1312 }
1313 if (image_match) { // Make sure subpass is referring to matching attachment
1314 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1315 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1316 sub_image_found = true;
1317 }
1318 if (!sub_image_found && device_extensions.vk_khr_depth_stencil_resolve) {
1319 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1320 if (resolve && resolve->pDepthStencilResolveAttachment &&
1321 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1322 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1323 sub_image_found = true;
1324 }
1325 }
1326 if (!sub_image_found) {
1327 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1328 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1329 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1330 sub_image_found = true;
1331 break;
1332 }
1333 if (!sub_image_found && sub_desc.pResolveAttachments &&
1334 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1335 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1336 sub_image_found = true;
1337 break;
1338 }
1339 }
1340 }
1341 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001342 auto img_loc = loc.dot(Field::image);
1343 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1344 skip |=
1345 LogError(rp_handle, vuid,
1346 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1347 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1348 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001349 }
1350 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001351 auto img_loc = loc.dot(Field::image);
1352 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1353 skip |= LogError(fb_state->framebuffer, vuid, "%s Barrier for %s does not match an image from the current %s.",
1354 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
1355 report_data->FormatHandle(fb_state->framebuffer).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001356 }
1357 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001358 auto layout_loc = loc.dot(Field::oldLayout);
1359 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1360 skip |= LogError(cb_state->commandBuffer, vuid,
1361 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001362 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001363 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001364 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1365 } else {
1366 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1367 LogObjectList objlist(rp_handle);
1368 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001369 auto layout_loc = loc.dot(Field::oldLayout);
1370 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1371 skip |= LogError(objlist, vuid,
1372 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001373 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001374 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001375 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1376 string_VkImageLayout(img_barrier.oldLayout));
1377 }
1378 }
1379 return skip;
1380}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001381// explictly instantiate so these can be used in core_validation.cpp
1382template bool CoreChecks::ValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE const *cb_state,
1383 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1384 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1385 const VkImageMemoryBarrier &img_barrier,
1386 const CMD_BUFFER_STATE *primary_cb_state) const;
1387template bool CoreChecks::ValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE const *cb_state,
1388 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1389 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1390 const VkImageMemoryBarrier2KHR &img_barrier,
1391 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001392
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001393template <typename ImgBarrier>
1394void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const CoreErrorLocation &loc, CMD_BUFFER_STATE *cb_state,
1395 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001396 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1397 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1398 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1399 const auto active_subpass = cb_state->activeSubpass;
1400 const auto rp_state = cb_state->activeRenderPass;
1401 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001402 // Secondary CB case w/o FB specified delay validation
1403 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
John Zulaufb4438f02021-02-20 20:22:16 -07001404 CoreErrorLocationCapture loc_capture(loc);
1405 const auto render_pass = rp_state->renderPass;
1406 cb_state->cmd_execute_commands_functions.emplace_back(
1407 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1408 const FRAMEBUFFER_STATE *fb) {
1409 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1410 render_pass, barrier, primary_cb);
1411 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001412 }
1413}
1414
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001415void CoreChecks::RecordBarriers(ErrFunc func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1416 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1417 const VkImageMemoryBarrier *pImageMemBarriers) {
1418 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
1419 CoreErrorLocation loc(func_name, RefPage::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
1420 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1421 }
1422 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
1423 CoreErrorLocation loc(func_name, RefPage::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
1424 const auto &img_barrier = pImageMemBarriers[i];
1425 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1426 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1427 }
1428}
1429
1430void CoreChecks::RecordBarriers(ErrFunc func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
1431 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
1432 CoreErrorLocation loc(func_name, RefPage::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
1433 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1434 }
1435 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
1436 CoreErrorLocation loc(func_name, RefPage::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
1437 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1438 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1439 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1440 }
1441}
1442
1443template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001444bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001445 const char *operation, const TransferBarrier &barrier,
1446 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001447 // Record to the scoreboard or report that we have a duplication
1448 bool skip = false;
1449 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1450 if (!inserted.second && inserted.first->second != cb_state) {
1451 // 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 -06001452 LogObjectList objlist(cb_state->commandBuffer);
1453 objlist.add(barrier.handle);
1454 objlist.add(inserted.first->second->commandBuffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001455 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001456 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1457 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001458 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001459 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1460 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001461 }
1462 return skip;
1463}
1464
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001465template <typename TransferBarrier>
1466bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1467 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1468 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001469 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001470 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TransferBarrier());
1471 const char *barrier_name = TransferBarrier::BarrierName();
1472 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001473 // No release should have an extant duplicate (WARNING)
1474 for (const auto &release : cb_barriers.release) {
1475 // Check the global pending release barriers
1476 const auto set_it = global_release_barriers.find(release.handle);
1477 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001478 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001479 const auto found = set_for_handle.find(release);
1480 if (found != set_for_handle.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001481 skip |= LogWarning(cb_state->commandBuffer, TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001482 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1483 " to dstQueueFamilyIndex %" PRIu32
1484 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1485 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1486 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001487 }
1488 }
1489 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1490 }
1491 // Each acquire must have a matching release (ERROR)
1492 for (const auto &acquire : cb_barriers.acquire) {
1493 const auto set_it = global_release_barriers.find(acquire.handle);
1494 bool matching_release_found = false;
1495 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001496 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001497 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1498 }
1499 if (!matching_release_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001500 skip |= LogError(cb_state->commandBuffer, TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001501 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1502 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1503 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1504 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001505 }
1506 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1507 }
1508 return skip;
1509}
1510
John Zulauf3b04ebd2019-07-18 14:08:11 -06001511bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001512 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1513 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001514 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001515 skip |=
1516 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1517 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1518 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001519 return skip;
1520}
1521
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001522template <typename TransferBarrier>
1523void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1524 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001525 // Add release barriers from this submit to the global map
1526 for (const auto &release : cb_barriers.release) {
1527 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1528 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1529 global_release_barriers[release.handle].insert(release);
1530 }
1531
1532 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1533 for (const auto &acquire : cb_barriers.acquire) {
1534 // NOTE: We're not using [] because we don't want to create entries for missing releases
1535 auto set_it = global_release_barriers.find(acquire.handle);
1536 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001537 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001538 set_for_handle.erase(acquire);
1539 if (set_for_handle.size() == 0) { // Clean up empty sets
1540 global_release_barriers.erase(set_it);
1541 }
1542 }
1543 }
1544}
1545
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001546void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001547 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1548 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1549 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001550}
1551
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001552template <typename ImgBarrier>
1553void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1554 // For ownership transfers, the barrier is specified twice; as a release
1555 // operation on the yielding queue family, and as an acquire operation
1556 // on the acquiring queue family. This barrier may also include a layout
1557 // transition, which occurs 'between' the two operations. For validation
1558 // purposes it doesn't seem important which side performs the layout
1559 // transition, but it must not be performed twice. We'll arbitrarily
1560 // choose to perform it as part of the acquire operation.
1561 //
1562 // However, we still need to record initial layout for the "initial layout" validation
1563 for (uint32_t i = 0; i < barrier_count; i++) {
1564 const auto &mem_barrier = barriers[i];
John Zulauf2be3fe02019-12-30 09:48:02 -07001565 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001566 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001567 if (image_state) {
1568 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1569 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001570 }
1571}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001572// explictly instantiate this template so it can be used in core_validation.cpp
1573template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1574 const VkImageMemoryBarrier *barrier);
1575template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1576 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001577
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001578VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1579
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001580template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001581void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001582 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001583 if (enabled_features.synchronization2_features.synchronization2) {
1584 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1585 return;
1586 }
1587 }
unknown86bcb3a2019-07-11 13:05:36 -06001588 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1589 const auto &image_create_info = image_state->createInfo;
1590
Mike Schuchardt2df08912020-12-15 16:28:09 -08001591 // 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 -07001592 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
unknown86bcb3a2019-07-11 13:05:36 -06001593 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001594 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001595 normalized_isr.baseArrayLayer = 0;
1596 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1597 }
1598
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001599 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1600 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001601
1602 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001603 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001604 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1605 }
1606
John Zulauf2be3fe02019-12-30 09:48:02 -07001607 if (is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001608 SetImageInitialLayout(cb_state, *image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001609 } else {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001610 SetImageLayout(cb_state, *image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001611 }
unknown86bcb3a2019-07-11 13:05:36 -06001612}
1613
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001614bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1615 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1616 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1617 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001618 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001619 assert(cb_node);
1620 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001621 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001622 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001623
John Zulauff660ad62019-03-23 07:16:05 -06001624 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1625 if (subresource_map) {
1626 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001627 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001628 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1629 // the next "constant value" range
1630 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001631 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001632 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001633 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1634 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1635 "%s layout %s.",
1636 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1637 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1638 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001639 }
John Zulauf5e617452019-11-19 14:44:16 -07001640 }
John Zulauff660ad62019-03-23 07:16:05 -06001641 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001642 }
John Zulauff660ad62019-03-23 07:16:05 -06001643
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001644 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1645 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1646 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001647 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1648 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001649 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1650 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1651 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001652 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001653 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001654 if (image_state->shared_presentable) {
1655 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001656 skip |=
1657 LogError(device, layout_invalid_msg_code,
1658 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1659 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001660 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001661 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001662 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001663 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001664 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1665 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1666 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1667 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001668 }
1669 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001670 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001671}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001672bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001673 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1674 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001675 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001676 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1677 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1678}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001679
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001680void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001681 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001682 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1683 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001684
Mike Schuchardt2df08912020-12-15 16:28:09 -08001685 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001686 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001687 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001688 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001689 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001690 VkImageLayout stencil_layout = kInvalidLayout;
1691 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001692 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001693 if (attachment_description_stencil_layout) {
1694 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1695 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001696 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001697 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001698 }
1699 }
1700}
Dave Houltone19e20d2018-02-02 16:32:41 -07001701
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001702#ifdef VK_USE_PLATFORM_ANDROID_KHR
1703// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1704// This could also move into a seperate core_validation_android.cpp file... ?
1705
1706//
1707// AHB-specific validation within non-AHB APIs
1708//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001709bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001710 bool skip = false;
1711
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001712 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001713 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001714 if (0 != ext_fmt_android->externalFormat) {
1715 if (VK_FORMAT_UNDEFINED != create_info->format) {
1716 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001717 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1718 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1719 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001720 }
1721
1722 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001723 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1724 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1725 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001726 }
1727
1728 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001729 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1730 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001731 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1732 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1733 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001734 }
1735
1736 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001737 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1738 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1739 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001740 }
1741 }
1742
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001743 if ((0 != ext_fmt_android->externalFormat) &&
1744 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001745 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001746 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1747 ") which has "
1748 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1749 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001750 }
1751 }
1752
Dave Houltond9611312018-11-19 17:03:36 -07001753 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001754 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001755 skip |=
1756 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1757 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1758 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001759 }
1760 }
1761
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001762 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001763 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1764 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001765 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001766 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1767 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1768 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1769 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001770 }
1771
1772 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001773 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1774 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1775 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1776 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1777 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001778 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001779 }
1780
1781 return skip;
1782}
1783
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001784bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001785 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001786 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001787
1788 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001789 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001790 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1791 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001792 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001793 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001794 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001795
Dave Houltond9611312018-11-19 17:03:36 -07001796 // Chain must include a compatible ycbcr conversion
1797 bool conv_found = false;
1798 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001799 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001800 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001801 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001802 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001803 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001804 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001805 }
Dave Houltond9611312018-11-19 17:03:36 -07001806 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001807 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001808 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001809 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1810 "an externalFormat (%" PRIu64
1811 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1812 "with the same external format.",
1813 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001814 }
1815
1816 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001817 if (IsIdentitySwizzle(create_info->components) == false) {
1818 skip |= LogError(
1819 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1820 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1821 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1822 "= %s.",
1823 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1824 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001825 }
1826 }
Dave Houltond9611312018-11-19 17:03:36 -07001827
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001828 return skip;
1829}
1830
John Zulaufa26d3c82019-08-14 16:09:08 -06001831bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001832 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001833
John Zulaufa26d3c82019-08-14 16:09:08 -06001834 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001835 if (image_state != nullptr) {
1836 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1837 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1838 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1839 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1840 "bound to memory.");
1841 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001842 }
1843 return skip;
1844}
1845
1846#else
1847
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001848bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001849 return false;
1850}
1851
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001852bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001853
John Zulaufa26d3c82019-08-14 16:09:08 -06001854bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001855
1856#endif // VK_USE_PLATFORM_ANDROID_KHR
1857
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001858bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1859 bool skip = false;
1860
1861 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1862 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1863 const VkImageTiling image_tiling = pCreateInfo->tiling;
1864 const VkFormat image_format = pCreateInfo->format;
1865
1866 if (image_format == VK_FORMAT_UNDEFINED) {
1867 // VU 01975 states format can't be undefined unless an android externalFormat
1868#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001869 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001870 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1871 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1872 if (it != ahb_ext_formats_map.end()) {
1873 tiling_features = it->second;
1874 }
1875 }
1876#endif
1877 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1878 uint64_t drm_format_modifier = 0;
1879 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001880 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001881 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001882 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001883
1884 if (drm_explicit != nullptr) {
1885 drm_format_modifier = drm_explicit->drmFormatModifier;
1886 } else {
1887 // VUID 02261 makes sure its only explict or implict in parameter checking
1888 assert(drm_implicit != nullptr);
1889 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1890 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1891 }
1892 }
1893
1894 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1895 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1896 nullptr};
1897 format_properties_2.pNext = (void *)&drm_properties_list;
1898 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001899 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1900 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1901 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1902 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001903
1904 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1905 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1906 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1907 }
1908 }
1909 } else {
1910 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1911 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1912 : format_properties.optimalTilingFeatures;
1913 }
1914
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001915 // Lack of disjoint format feature support while using the flag
1916 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1917 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1918 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1919 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1920 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1921 string_VkFormat(pCreateInfo->format));
1922 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001923
1924 return skip;
1925}
1926
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001927bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001928 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001929 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001930
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001931 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001932 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001933 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1934 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001935 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1936 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001937 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001938 }
1939
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001940 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1941 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001942 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1943 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1944 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001945 }
1946
1947 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001948 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1949 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1950 "height (%d) and arrayLayers (%d) must be >= 6.",
1951 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001952 }
Dave Houlton130c0212018-01-29 13:39:56 -07001953 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001954
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001955 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001956 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1957 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1958 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001959 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001960 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1961 "device maxFramebufferWidth (%u).",
1962 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001963 }
1964
1965 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001966 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001967 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1968 "device maxFramebufferHeight (%u).",
1969 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001970 }
1971
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001972 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001973 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1974 static_cast<float>(device_limits->maxFramebufferWidth) /
1975 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001976 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1977 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001978 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1979 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1980 "ceiling of device "
1981 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1982 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1983 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001984 }
1985
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001986 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1987 static_cast<float>(device_limits->maxFramebufferHeight) /
1988 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001989 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1990 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001991 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1992 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1993 "ceiling of device "
1994 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1995 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1996 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001997 }
1998 }
1999
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002000 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06002001 VkResult result = VK_SUCCESS;
2002 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
2003 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
2004 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
2005 &format_limits);
2006 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002007 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
2008 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002009 if (modifier_list) {
2010 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002011 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002012 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002013 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002014 image_format_info.type = pCreateInfo->imageType;
2015 image_format_info.format = pCreateInfo->format;
2016 image_format_info.tiling = pCreateInfo->tiling;
2017 image_format_info.usage = pCreateInfo->usage;
2018 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002019 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002020
2021 result =
2022 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
2023 format_limits = image_format_properties.imageFormatProperties;
2024
2025 /* The application gives a list of modifier and the driver
2026 * selects one. If one is wrong, stop there.
2027 */
2028 if (result != VK_SUCCESS) break;
2029 }
2030 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002031 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002032 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002033 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002034 image_format_info.type = pCreateInfo->imageType;
2035 image_format_info.format = pCreateInfo->format;
2036 image_format_info.tiling = pCreateInfo->tiling;
2037 image_format_info.usage = pCreateInfo->usage;
2038 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07002039 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03002040
2041 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
2042 format_limits = image_format_properties.imageFormatProperties;
2043 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06002044 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06002045
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002046 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
2047 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
2048 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
2049 if (result != VK_SUCCESS) {
2050 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06002051#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002052 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06002053#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002054 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07002055 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07002056 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
2057 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002058#ifdef VK_USE_PLATFORM_ANDROID_KHR
2059 }
2060#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002061 } else {
2062 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
2063 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002064 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
2065 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
2066 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002067 }
Dave Houlton130c0212018-01-29 13:39:56 -07002068
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002069 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
2070 static_cast<uint64_t>(pCreateInfo->extent.height) *
2071 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
2072 static_cast<uint64_t>(pCreateInfo->samples);
2073 uint64_t total_size =
2074 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07002075
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002076 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002077 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
2078 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002079 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002080
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002081 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002082 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
2083 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
2084 ", maximum resource size = 0x%" PRIxLEAST64 " ",
2085 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002086 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002087
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002088 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002089 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
2090 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
2091 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002092 }
2093
2094 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002095 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
2096 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
2097 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002098 }
sfricke-samsung612f3622020-06-20 20:42:46 -07002099
2100 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
2101 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
2102 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
2103 pCreateInfo->extent.width, format_limits.maxExtent.width);
2104 }
2105
2106 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
2107 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
2108 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
2109 pCreateInfo->extent.height, format_limits.maxExtent.height);
2110 }
2111
2112 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
2113 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
2114 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
2115 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
2116 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002117 }
2118
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002119 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08002120 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
2121 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
2122 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
2123 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002124 skip |= LogError(device, error_vuid,
2125 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
2126 "YCbCr Conversion format, arrayLayers must be 1",
2127 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002128 }
2129
2130 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002131 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
2132 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
2133 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002134 }
2135
2136 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002137 skip |= LogError(
2138 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08002139 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
2140 string_VkSampleCountFlagBits(pCreateInfo->samples));
2141 }
2142
2143 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002144 skip |= LogError(
2145 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08002146 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2147 string_VkImageType(pCreateInfo->imageType));
2148 }
2149 }
2150
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002151 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002152 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07002153 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06002154 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002155 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2156 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2157 "format must be block, ETC or ASTC compressed, but is %s",
2158 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002159 }
2160 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002161 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2162 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2163 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002164 }
2165 }
2166 }
2167
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002168 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002169 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
2170 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
2171 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002172 }
2173
unknown2c877272019-07-11 12:56:50 -06002174 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2175 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2176 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002177 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2178 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2179 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002180 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002181
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002182 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002183 if (swapchain_create_info != nullptr) {
2184 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2185 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2186 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2187
2188 // Validate rest of Swapchain Image create check that require swapchain state
2189 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2190 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2191 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2192 skip |= LogError(
2193 device, vuid,
2194 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2195 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2196 }
2197 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2198 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2199 skip |= LogError(device, vuid,
2200 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2201 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2202 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002203 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002204 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2205 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2206 skip |= LogError(device, vuid,
2207 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2208 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002209 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002210 }
2211 }
2212 }
2213
sfricke-samsungedce77a2020-07-03 22:35:13 -07002214 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2215 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2216 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2217 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2218 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2219 }
2220 const VkImageCreateFlags invalid_flags =
2221 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2222 if ((pCreateInfo->flags & invalid_flags) != 0) {
2223 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2224 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2225 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2226 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2227 }
2228 }
2229
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002230 skip |= ValidateImageFormatFeatures(pCreateInfo);
2231
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002232 // Check compatibility with VK_KHR_portability_subset
2233 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
2234 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2235 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2236 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2237 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2238 }
2239 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2240 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2241 skip |=
2242 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2243 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2244 }
2245 }
2246
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002247 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002248}
2249
John Zulauf7eeb6f72019-06-17 11:56:36 -06002250void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2251 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2252 if (VK_SUCCESS != result) return;
2253
2254 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002255 auto image_state = Get<IMAGE_STATE>(*pImage);
2256 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002257}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002258
Jeff Bolz5c801d12019-10-09 10:38:45 -05002259bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002260 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06002261 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002262 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002263 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002264 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002265 }
2266 return skip;
2267}
2268
John Zulauf7eeb6f72019-06-17 11:56:36 -06002269void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2270 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002271 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002272
locke-lunargcba7d5f2019-12-30 16:59:11 -07002273 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002274
2275 // Clean up generic image state
2276 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002277}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002278
sfricke-samsungcd924d92020-05-20 23:51:17 -07002279bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2280 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002281 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002282 const VkImage image = image_state->image;
2283 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002284
2285 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002286 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2287 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002288 }
2289
sfricke-samsungcd924d92020-05-20 23:51:17 -07002290 if (FormatIsDepthOrStencil(format)) {
2291 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2292 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2293 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2294 } else if (FormatIsCompressed(format)) {
2295 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2296 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2297 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002298 }
2299
2300 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002301 skip |=
2302 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2303 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2304 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002305 }
2306 return skip;
2307}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002308
John Zulauf07288512019-07-05 11:09:50 -06002309bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2310 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2311 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002312 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002313 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2314 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002315 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2316 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2317 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002318 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002319
2320 } else {
2321 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2322 if (!device_extensions.vk_khr_shared_presentable_image) {
2323 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002324 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2325 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2326 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002327 }
2328 } else {
2329 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2330 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002331 skip |= LogError(
2332 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002333 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2334 func_name, string_VkImageLayout(dest_image_layout));
2335 }
2336 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002337 }
2338
John Zulauff660ad62019-03-23 07:16:05 -06002339 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002340 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002341 if (subresource_map) {
2342 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002343 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002344 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002345 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2346 // the next "constant value" range
2347 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002348 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002349 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2350 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2351 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2352 } else {
2353 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002354 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002355 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2356 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2357 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2358 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002359 }
John Zulauf5e617452019-11-19 14:44:16 -07002360 }
John Zulauff660ad62019-03-23 07:16:05 -06002361 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002362 }
2363
2364 return skip;
2365}
2366
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002367bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2368 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002369 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002370 bool skip = false;
2371 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002372 const auto *cb_node = GetCBState(commandBuffer);
2373 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002374 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002375 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002376 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002377 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002378 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002379 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002380 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2381 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002382 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002383 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002384 skip |=
2385 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2386 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2387 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002388 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002389 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002390 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002391 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002392 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002393 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002394 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2395 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2396 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2397 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2398 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2399 string_VkFormat(image_state->createInfo.format));
2400 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002401 }
2402 return skip;
2403}
2404
John Zulaufeabb4462019-07-05 14:13:03 -06002405void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2406 const VkClearColorValue *pColor, uint32_t rangeCount,
2407 const VkImageSubresourceRange *pRanges) {
2408 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2409
2410 auto cb_node = GetCBState(commandBuffer);
2411 auto image_state = GetImageState(image);
2412 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002413 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002414 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002415 }
2416 }
2417}
2418
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002419bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2420 const char *apiName) const {
2421 bool skip = false;
2422
2423 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2424 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2425 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2426 // Also VUID-VkClearDepthStencilValue-depth-00022
2427 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2428 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2429 "(=%f) is not within the [0.0, 1.0] range.",
2430 apiName, clearValue.depth);
2431 }
2432 }
2433
2434 return skip;
2435}
2436
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002437bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2438 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002439 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002440 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002441
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002442 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002443 const auto *cb_node = GetCBState(commandBuffer);
2444 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002445 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002446 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002447 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002448 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002449 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002450 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002451 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002452 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002453 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002454 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002455 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002456 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002457 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002458 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2459 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2460 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2461 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002462
2463 bool any_include_aspect_depth_bit = false;
2464 bool any_include_aspect_stencil_bit = false;
2465
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002466 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002467 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002468 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002469 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002470 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002471 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2472 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002473 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2474 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2475 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2476 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002477 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002478 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2479 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002480 if (FormatHasDepth(image_format) == false) {
2481 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2482 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2483 "doesn't have a depth component.",
2484 i, string_VkFormat(image_format));
2485 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002486 }
2487 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2488 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002489 if (FormatHasStencil(image_format) == false) {
2490 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2491 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2492 "%s doesn't have a stencil component.",
2493 i, string_VkFormat(image_format));
2494 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002495 }
2496 }
2497 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002498 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002499 if (image_stencil_struct != nullptr) {
2500 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2501 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002502 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2503 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2504 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2505 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002506 }
2507 } else {
2508 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002509 skip |= LogError(
2510 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002511 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2512 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2513 "in VkImageCreateInfo::usage used to create image");
2514 }
2515 }
2516 }
2517 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002518 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2519 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2520 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002521 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002522 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002523 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2524 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002525 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002526 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002527 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002528 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2529 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2530 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2531 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002532 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002533 }
2534 return skip;
2535}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002536
John Zulaufeabb4462019-07-05 14:13:03 -06002537void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2538 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2539 const VkImageSubresourceRange *pRanges) {
2540 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2541 auto cb_node = GetCBState(commandBuffer);
2542 auto image_state = GetImageState(image);
2543 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002544 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002545 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002546 }
2547 }
2548}
2549
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002550// Returns true if [x, xoffset] and [y, yoffset] overlap
2551static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2552 bool result = false;
2553 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2554 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2555
2556 if (intersection_max > intersection_min) {
2557 result = true;
2558 }
2559 return result;
2560}
2561
Jeff Leger178b1e52020-10-05 12:22:23 -04002562// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002563// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002564template <typename RegionType>
2565static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002566 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002567
Dave Houltonc991cc92018-03-06 11:08:51 -07002568 // Separate planes within a multiplane image cannot intersect
2569 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002570 return result;
2571 }
2572
Dave Houltonc991cc92018-03-06 11:08:51 -07002573 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2574 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2575 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002576 result = true;
2577 switch (type) {
2578 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002579 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002580 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002581 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002582 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002583 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002584 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002585 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002586 break;
2587 default:
2588 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2589 assert(false);
2590 }
2591 }
2592 return result;
2593}
2594
Dave Houltonfc1a4052017-04-27 14:32:45 -06002595// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002596static const uint32_t kXBit = 1;
2597static const uint32_t kYBit = 2;
2598static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002599static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002600 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002601 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002602 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2603 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002604 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002605 }
2606 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2607 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002608 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002609 }
2610 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2611 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002612 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002613 }
2614 return result;
2615}
2616
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002617// Test if two VkExtent3D structs are equivalent
2618static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2619 bool result = true;
2620 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2621 (extent->depth != other_extent->depth)) {
2622 result = false;
2623 }
2624 return result;
2625}
2626
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002627// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002628static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002629 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2630}
2631
2632// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002633VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002634 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2635 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002636 auto pool = cb_node->command_pool.get();
2637 if (pool) {
2638 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002639 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002640 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002641 granularity.width *= block_size.width;
2642 granularity.height *= block_size.height;
2643 }
2644 }
2645 return granularity;
2646}
2647
2648// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2649static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2650 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002651 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2652 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002653 valid = false;
2654 }
2655 return valid;
2656}
2657
2658// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002659bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002660 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002661 bool skip = false;
2662 VkExtent3D offset_extent = {};
2663 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2664 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2665 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002666 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002667 // 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 -07002668 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002669 skip |= LogError(cb_node->commandBuffer, vuid,
2670 "%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 "
2671 "image transfer granularity is (w=0, h=0, d=0).",
2672 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002673 }
2674 } else {
2675 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2676 // integer multiples of the image transfer granularity.
2677 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002678 skip |= LogError(cb_node->commandBuffer, vuid,
2679 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2680 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2681 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2682 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002683 }
2684 }
2685 return skip;
2686}
2687
2688// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002689bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002690 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002691 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002692 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002693 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002694 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2695 // subresource extent.
2696 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002697 skip |= LogError(cb_node->commandBuffer, vuid,
2698 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2699 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2700 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2701 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002702 }
2703 } else {
2704 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2705 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2706 // subresource extent dimensions.
2707 VkExtent3D offset_extent_sum = {};
2708 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2709 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2710 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002711 bool x_ok = true;
2712 bool y_ok = true;
2713 bool z_ok = true;
2714 switch (image_type) {
2715 case VK_IMAGE_TYPE_3D:
2716 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2717 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002718 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002719 case VK_IMAGE_TYPE_2D:
2720 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2721 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002722 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002723 case VK_IMAGE_TYPE_1D:
2724 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2725 (subresource_extent->width == offset_extent_sum.width));
2726 break;
2727 default:
2728 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2729 assert(false);
2730 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002731 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002732 skip |=
2733 LogError(cb_node->commandBuffer, vuid,
2734 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2735 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2736 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2737 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2738 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2739 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002740 }
2741 }
2742 return skip;
2743}
2744
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002745bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002746 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002747 bool skip = false;
2748 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002749 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2750 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002751 }
2752 return skip;
2753}
2754
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002755bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002756 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002757 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002758 bool skip = false;
2759 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2760 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002761 skip |= LogError(cb_node->commandBuffer, vuid,
2762 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2763 "%u, but provided %s has %u array layers.",
2764 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2765 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002766 }
2767 return skip;
2768}
2769
Jeff Leger178b1e52020-10-05 12:22:23 -04002770// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2771template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002772bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002773 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002774 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002775 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002776 VkExtent3D granularity = GetScaledItg(cb_node, img);
2777 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002778 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002779 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002780 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002781 return skip;
2782}
2783
Jeff Leger178b1e52020-10-05 12:22:23 -04002784// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2785template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002786bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002787 const IMAGE_STATE *dst_img, const RegionType *region,
2788 const uint32_t i, const char *function,
2789 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002790 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002791 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2792 const char *vuid;
2793
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002794 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002795 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002796 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2797 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002798 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002799 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002800 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002801 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002802 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002803
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002804 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002805 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002806 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2807 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002808 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002809 const VkExtent3D dest_effective_extent =
2810 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002811 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002812 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002813 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002814 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002815 return skip;
2816}
2817
Jeff Leger178b1e52020-10-05 12:22:23 -04002818// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2819template <typename ImageCopyRegionType>
2820bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2821 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2822 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002823 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002824 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2825 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2826 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002827
2828 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002829 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002830
2831 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002832 const VkExtent3D src_copy_extent = region.extent;
2833 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002834 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2835
Dave Houlton6f9059e2017-05-02 17:15:13 -06002836 bool slice_override = false;
2837 uint32_t depth_slices = 0;
2838
2839 // Special case for copying between a 1D/2D array and a 3D image
2840 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2841 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002842 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002843 slice_override = (depth_slices != 1);
2844 } 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 -07002845 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002846 slice_override = (depth_slices != 1);
2847 }
2848
2849 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002850 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002851 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002852 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2853 skip |= LogError(src_state->image, vuid,
2854 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2855 "be 0 and 1, respectively.",
2856 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002857 }
2858 }
2859
Dave Houlton533be9f2018-03-26 17:08:30 -06002860 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 -04002861 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2862 skip |= LogError(src_state->image, vuid,
2863 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002864 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002865 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002866 }
2867
Dave Houlton533be9f2018-03-26 17:08:30 -06002868 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002869 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2870 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2871 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002872 }
2873
Dave Houltonc991cc92018-03-06 11:08:51 -07002874 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002875 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002876 if (FormatIsCompressed(src_state->createInfo.format) ||
2877 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002878 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002879 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002880 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2881 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2882 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002883 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002884 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002885 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002886 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002887 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002888 }
2889
Dave Houlton94a00372017-12-14 15:08:47 -07002890 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002891 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2892 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002893 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2894 skip |= LogError(src_state->image, vuid,
2895 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2896 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2897 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002898 }
2899
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002900 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002901 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2902 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002903 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2904 skip |= LogError(src_state->image, vuid,
2905 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2906 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2907 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002908 }
2909
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002910 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002911 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2912 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002913 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2914 skip |= LogError(src_state->image, vuid,
2915 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2916 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2917 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002918 }
2919 } // Compressed
2920
2921 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002922 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002923 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002924 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2925 skip |= LogError(dst_state->image, vuid,
2926 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002927 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002928 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002929 }
2930 }
2931
Dave Houlton533be9f2018-03-26 17:08:30 -06002932 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 -04002933 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2934 skip |= LogError(dst_state->image, vuid,
2935 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2936 "and 1, respectively.",
2937 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002938 }
2939
Dave Houlton533be9f2018-03-26 17:08:30 -06002940 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002941 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2942 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2943 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002944 }
2945
sfricke-samsung30b094c2020-05-30 11:42:11 -07002946 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002947 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002948 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2949 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002950 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2951 skip |= LogError(src_state->image, vuid,
2952 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2953 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2954 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002955 }
2956 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002957 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002958 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002959 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2960 skip |= LogError(dst_state->image, vuid,
2961 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2962 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2963 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002964 }
2965 }
2966 } else { // Pre maint 1
2967 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002968 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002969 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2970 skip |= LogError(src_state->image, vuid,
2971 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002972 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2973 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002974 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002975 }
Dave Houltonee281a52017-12-08 13:51:02 -07002976 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002977 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2978 skip |= LogError(dst_state->image, vuid,
2979 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002980 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2981 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002982 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002983 }
2984 }
2985 }
2986
Dave Houltonc991cc92018-03-06 11:08:51 -07002987 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2988 if (FormatIsCompressed(dst_state->createInfo.format) ||
2989 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002990 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002991
2992 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002993 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2994 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2995 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002996 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002997 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002998 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002999 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003000 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003001 }
3002
Dave Houlton94a00372017-12-14 15:08:47 -07003003 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07003004 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
3005 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003006 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
3007 skip |= LogError(dst_state->image, vuid,
3008 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3009 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
3010 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06003011 }
3012
Dave Houltonee281a52017-12-08 13:51:02 -07003013 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
3014 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
3015 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003016 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003017 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003018 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003019 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
3020 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003021 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003022 }
3023
Dave Houltonee281a52017-12-08 13:51:02 -07003024 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
3025 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
3026 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003027 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
3028 skip |= LogError(dst_state->image, vuid,
3029 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3030 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
3031 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003032 }
3033 } // Compressed
3034 }
3035 return skip;
3036}
3037
Jeff Leger178b1e52020-10-05 12:22:23 -04003038template <typename RegionType>
3039bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3040 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3041 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003042 const auto *cb_node = GetCBState(commandBuffer);
3043 const auto *src_image_state = GetImageState(srcImage);
3044 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08003045 const VkFormat src_format = src_image_state->createInfo.format;
3046 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04003047 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003048 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003049
Jeff Leger178b1e52020-10-05 12:22:23 -04003050 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
3051 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
3052 const char *vuid;
3053
3054 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003055
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003056 VkCommandBuffer command_buffer = cb_node->commandBuffer;
3057
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003058 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003059 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07003060
3061 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
3062 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08003063 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07003064
Dave Houlton6f9059e2017-05-02 17:15:13 -06003065 bool slice_override = false;
3066 uint32_t depth_slices = 0;
3067
3068 // Special case for copying between a 1D/2D array and a 3D image
3069 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
3070 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3071 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003072 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003073 slice_override = (depth_slices != 1);
3074 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3075 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003076 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003077 slice_override = (depth_slices != 1);
3078 }
3079
Jeff Leger178b1e52020-10-05 12:22:23 -04003080 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
3081 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
3082 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
3083 skip |=
3084 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3085 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
3086 skip |=
3087 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3088 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003089 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003090 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3091 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003092 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003093 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003094
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003095 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06003096 // No chance of mismatch if we're overriding depth slice count
3097 if (!slice_override) {
3098 // The number of depth slices in srcSubresource and dstSubresource must match
3099 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
3100 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003101 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
3102 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003103 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003104 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
3105 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003106 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003107 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
3108 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003109 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
3110 "do not match.",
3111 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003112 }
3113 }
3114 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003115 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07003116 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003117 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003118 skip |=
3119 LogError(command_buffer, vuid,
3120 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
3121 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003122 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003123 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003124
Dave Houltonc991cc92018-03-06 11:08:51 -07003125 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003126 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003127 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3128 // If neither image is multi-plane the aspectMask member of src and dst must match
3129 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
3130 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
3131 skip |= LogError(command_buffer, vuid,
3132 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3133 "source (0x%x) destination (0x%x).",
3134 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3135 }
3136 } else {
3137 // Source image multiplane checks
3138 uint32_t planes = FormatPlaneCount(src_format);
3139 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3140 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3141 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
3142 skip |= LogError(command_buffer, vuid,
3143 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3144 i, aspect);
3145 }
3146 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3147 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3148 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
3149 skip |= LogError(command_buffer, vuid,
3150 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3151 i, aspect);
3152 }
3153 // Single-plane to multi-plane
3154 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3155 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3156 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3157 skip |= LogError(command_buffer, vuid,
3158 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3159 func_name, i, aspect);
3160 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003161
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003162 // Dest image multiplane checks
3163 planes = FormatPlaneCount(dst_format);
3164 aspect = region.dstSubresource.aspectMask;
3165 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3166 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3167 skip |= LogError(command_buffer, vuid,
3168 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3169 i, aspect);
3170 }
3171 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3172 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3173 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3174 skip |= LogError(command_buffer, vuid,
3175 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3176 i, aspect);
3177 }
3178 // Multi-plane to single-plane
3179 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3180 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3181 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3182 skip |= LogError(command_buffer, vuid,
3183 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3184 func_name, i, aspect);
3185 }
3186 }
3187 } else {
3188 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003189 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3190 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003191 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003192 skip |= LogError(
3193 command_buffer, vuid,
3194 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3195 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003196 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003197 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003198
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003199 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003200 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003201 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003202 skip |=
3203 LogError(command_buffer, vuid,
3204 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3205 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003206 }
3207
3208 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003209 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003210 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003211 skip |= LogError(
3212 command_buffer, vuid,
3213 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3214 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003215 }
3216
Dave Houltonfc1a4052017-04-27 14:32:45 -06003217 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07003218 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
3219 if (slice_override) src_copy_extent.depth = depth_slices;
3220 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003221 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003222 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3223 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003224 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003225 "width [%1d].",
3226 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003227 }
3228
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003229 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003230 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3231 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003232 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003233 "height [%1d].",
3234 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003235 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003236 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003237 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3238 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003239 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003240 "depth [%1d].",
3241 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003242 }
3243
Dave Houltonee281a52017-12-08 13:51:02 -07003244 // Adjust dest extent if necessary
3245 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
3246 if (slice_override) dst_copy_extent.depth = depth_slices;
3247
3248 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003249 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003250 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3251 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003252 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003253 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003254 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003255 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003256 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003257 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3258 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003259 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003260 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003261 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003262 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003263 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003264 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3265 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003266 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003267 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003268 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003269 }
3270
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003271 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3272 // must not overlap in memory
3273 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003274 for (uint32_t j = 0; j < regionCount; j++) {
3275 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003276 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003277 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003278 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003279 }
3280 }
3281 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003282
3283 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3284 if (device_extensions.vk_khr_maintenance1) {
3285 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3286 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3287 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003288 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3289 skip |= LogError(command_buffer, vuid,
3290 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3291 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003292 }
3293 } else {
3294 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3295 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3296 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003297 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3298 skip |= LogError(command_buffer, vuid,
3299 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3300 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003301 }
3302 }
3303
3304 // Check if 2D with 3D and depth not equal to 2D layerCount
3305 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3306 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3307 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003308 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3309 skip |= LogError(command_buffer, vuid,
3310 "%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 -08003311 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003312 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003313 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3314 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3315 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003316 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3317 skip |= LogError(command_buffer, vuid,
3318 "%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 -08003319 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003320 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003321 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003322
3323 // Check for multi-plane format compatiblity
3324 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3325 size_t src_format_size = 0;
3326 size_t dst_format_size = 0;
3327 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003328 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3329 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003330 } else {
3331 src_format_size = FormatElementSize(src_format);
3332 }
3333 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003334 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3335 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003336 } else {
3337 dst_format_size = FormatElementSize(dst_format);
3338 }
3339 // If size is still zero, then format is invalid and will be caught in another VU
3340 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003341 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3342 skip |= LogError(command_buffer, vuid,
3343 "%s: pRegions[%u] called with non-compatible image formats. "
3344 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3345 func_name, i, string_VkFormat(src_format),
3346 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3347 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003348 }
3349 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003350 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003351
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003352 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3353 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3354 // because because both texels are 4 bytes in size.
3355 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003356 const char *compatible_vuid =
3357 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3358 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3359 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003360 // Depth/stencil formats must match exactly.
3361 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3362 if (src_format != dst_format) {
3363 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003364 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003365 string_VkFormat(src_format), string_VkFormat(dst_format));
3366 }
3367 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003368 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003369 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003370 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003371 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003372 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003373 FormatElementSize(dst_format));
3374 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003375 }
3376 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003377
Dave Houlton33c22b72017-02-28 13:16:02 -07003378 // Source and dest image sample counts must match
3379 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003380 std::stringstream ss;
3381 ss << func_name << " called on image pair with non-identical sample counts.";
3382 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003383 skip |=
3384 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3385 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3386 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003387 }
3388
Tony-LunarG5a066372021-01-21 10:31:34 -07003389 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3390 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3391 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003392 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
Tony-LunarG5a066372021-01-21 10:31:34 -07003393 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3394 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3395 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3396 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003397 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003398 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3399 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3400 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3401 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3402 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3403 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3404 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3405 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3406 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3407 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3408 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3409 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003410
3411 // Validation for VK_EXT_fragment_density_map
3412 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003413 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3414 skip |=
3415 LogError(command_buffer, vuid,
3416 "%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 +02003417 }
3418 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003419 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3420 skip |=
3421 LogError(command_buffer, vuid,
3422 "%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 +02003423 }
3424
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003425 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003426 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3427 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3428 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3429 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003430 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003431 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3432 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3433 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3434 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3435 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003436 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003437
3438 const char *invalid_src_layout_vuid =
3439 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3440 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3441 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3442 const char *invalid_dst_layout_vuid =
3443 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3444 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3445 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3446
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003447 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003448 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003449 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003450 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3451 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003452 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003453 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003454 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003455 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003456 }
3457
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003458 return skip;
3459}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003460
Jeff Leger178b1e52020-10-05 12:22:23 -04003461bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3462 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3463 const VkImageCopy *pRegions) const {
3464 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3465 COPY_COMMAND_VERSION_1);
3466}
3467
3468bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3469 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3470 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3471 COPY_COMMAND_VERSION_2);
3472}
3473
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003474void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3475 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3476 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003477 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3478 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003479 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003480 auto src_image_state = GetImageState(srcImage);
3481 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003482
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003483 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003484 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003485 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3486 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003487 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003488}
3489
Jeff Leger178b1e52020-10-05 12:22:23 -04003490void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3491 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3492 auto cb_node = GetCBState(commandBuffer);
3493 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3494 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3495
3496 // Make sure that all image slices are updated to correct layout
3497 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3498 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3499 pCopyImageInfo->srcImageLayout);
3500 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3501 pCopyImageInfo->dstImageLayout);
3502 }
3503}
3504
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003505// Returns true if sub_rect is entirely contained within rect
3506static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3507 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 -07003508 (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 -07003509 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003510 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003511 return true;
3512}
3513
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003514bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003515 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003516 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3517 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003518 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003519 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3520 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003521 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003522 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003523
3524 for (uint32_t j = 0; j < rect_count; j++) {
3525 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003526 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3527 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3528 "the current render pass instance.",
3529 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003530 }
3531
3532 if (image_view_state) {
3533 // The layers specified by a given element of pRects must be contained within every attachment that
3534 // pAttachments refers to
3535 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3536 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3537 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003538 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3539 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3540 "of pAttachment[%d].",
3541 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003542 }
3543 }
3544 }
3545 return skip;
3546}
3547
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003548bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3549 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003550 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003551 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003552 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003553 if (!cb_node) return skip;
3554
3555 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3556 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3557 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003558 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003559
3560 // Validate that attachment is in reference list of active subpass
3561 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003562 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003563 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003564 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003565 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003566 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003567
John Zulauf3a548ef2019-02-01 16:14:07 -07003568 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3569 auto clear_desc = &pAttachments[attachment_index];
3570 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003571 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003572
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003573 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3574 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3575 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3576 attachment_index);
3577 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3578 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3579 skip |=
3580 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3581 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3582 attachment_index);
3583 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003584 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3585 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3586 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3587 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003588 skip |= LogError(
3589 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3590 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3591 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3592 attachment_index, clear_desc->colorAttachment,
3593 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3594 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003595
John Zulauff2582972019-02-09 14:53:30 -07003596 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3597 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003598 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003599 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3600 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3601 " subpass %u. colorAttachmentCount=%u",
3602 attachment_index, clear_desc->colorAttachment,
3603 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3604 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003605 }
John Zulauff2582972019-02-09 14:53:30 -07003606 fb_attachment = color_attachment;
3607
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003608 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3609 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3610 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3611 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3612 "of a color attachment.",
3613 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003614 }
3615 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003616 bool subpass_depth = false;
3617 bool subpass_stencil = false;
3618 if (subpass_desc->pDepthStencilAttachment &&
3619 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3620 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3621 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3622 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3623 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003624 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003625 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3626 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003627 skip |= LogError(
3628 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3629 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003630 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003631 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003632 }
3633 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003634 skip |= LogError(
3635 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3636 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003637 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003638 attachment_index);
3639 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003640 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003641 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003642 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003643 if (subpass_depth) {
3644 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3645 "vkCmdClearAttachments()");
3646 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003647 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003648 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003649 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3650 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003651 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003652
3653 // Once the framebuffer attachment is found, can get the image view state
3654 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3655 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3656 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003657 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003658 if (image_view_state != nullptr) {
3659 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3660 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3661 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3662 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3663 }
3664 }
John Zulauf441558b2019-08-12 11:47:39 -06003665 }
3666 }
3667 return skip;
3668}
3669
3670void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3671 const VkClearAttachment *pAttachments, uint32_t rectCount,
3672 const VkClearRect *pRects) {
3673 auto *cb_node = GetCBState(commandBuffer);
3674 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003675 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3676 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003677 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3678 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3679 const auto clear_desc = &pAttachments[attachment_index];
3680 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3681 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3682 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3683 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3684 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3685 subpass_desc->pDepthStencilAttachment) {
3686 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3687 }
3688 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003689 if (!clear_rect_copy) {
3690 // We need a copy of the clear rectangles that will persist until the last lambda executes
3691 // but we want to create it as lazily as possible
3692 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003693 }
John Zulauf441558b2019-08-12 11:47:39 -06003694 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3695 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003696 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003697 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003698 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003699 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3700 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003701 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003702 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003703 return skip;
3704 };
3705 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003706 }
3707 }
3708 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003709}
3710
Jeff Leger178b1e52020-10-05 12:22:23 -04003711template <typename RegionType>
3712bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3713 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3714 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003715 const auto *cb_node = GetCBState(commandBuffer);
3716 const auto *src_image_state = GetImageState(srcImage);
3717 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003718 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3719 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3720 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3721 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003722
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003723 bool skip = false;
3724 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003725 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3726 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3727 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3728 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3729 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3730 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3731 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3732 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3733 skip |= InsideRenderPass(cb_node, func_name, vuid);
3734 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3735 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3736 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3737 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3738 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3739 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3740 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3741 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003742
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003743 // Validation for VK_EXT_fragment_density_map
3744 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003745 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3746 skip |= LogError(cb_node->commandBuffer, vuid,
3747 "%s: srcImage must not have been created with flags containing "
3748 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3749 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003750 }
3751 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003752 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3753 skip |= LogError(cb_node->commandBuffer, vuid,
3754 "%s: dstImage must not have been created with flags containing "
3755 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3756 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003757 }
3758
Cort Stratton7df30962018-05-17 19:45:57 -07003759 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003760 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003761 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3762 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003763 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003764 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3765 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3766 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003767 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003768 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3769 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3770 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3771 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3772 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3773 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003774 // For each region, the number of layers in the image subresource should not be zero
3775 // For each region, src and dest image aspect must be color only
3776 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003777 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003778 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3779 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003780 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3781 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3782 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003783 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003784 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3785 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003786 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003787 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3788 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3789 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3790 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3791 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3792 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003793 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003794 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3795 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003796 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003797 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003798
3799 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003800 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003801 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3802 skip |=
3803 LogError(cb_node->commandBuffer, vuid,
3804 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003805 }
Cort Stratton7df30962018-05-17 19:45:57 -07003806 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003807 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3808 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003809 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3810 skip |= LogError(cb_node->commandBuffer, vuid,
3811 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3812 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003813 }
3814
3815 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3816 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3817
3818 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003819 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003820 LogObjectList objlist(cb_node->commandBuffer);
3821 objlist.add(src_image_state->image);
3822 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003823 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3824 skip |= LogError(objlist, vuid,
3825 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003826 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003827 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003828 }
3829 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3830 LogObjectList objlist(cb_node->commandBuffer);
3831 objlist.add(src_image_state->image);
3832 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003833 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3834 skip |= LogError(objlist, vuid,
3835 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003836 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003837 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003838 }
3839 }
3840
3841 if (VK_IMAGE_TYPE_1D == src_image_type) {
3842 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3843 LogObjectList objlist(cb_node->commandBuffer);
3844 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003845 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3846 skip |= LogError(objlist, vuid,
3847 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003848 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003849 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3850 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003851 }
3852 }
3853 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3854 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3855 LogObjectList objlist(cb_node->commandBuffer);
3856 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003857 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3858 skip |= LogError(objlist, vuid,
3859 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003860 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003861 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3862 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003863 }
3864 }
3865
3866 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3867 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3868 LogObjectList objlist(cb_node->commandBuffer);
3869 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003870 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3871 skip |= LogError(objlist, vuid,
3872 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003873 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003874 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3875 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003876 }
3877 }
3878 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3879 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3880 LogObjectList objlist(cb_node->commandBuffer);
3881 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003882 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3883 skip |= LogError(objlist, vuid,
3884 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003885 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003886 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3887 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003888 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003889 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003890
3891 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3892 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3893 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3894 // developer
3895 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3896 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003897 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003898 LogObjectList objlist(cb_node->commandBuffer);
3899 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003900 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3901 skip |= LogError(objlist, vuid,
3902 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003903 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003904 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003905 region.extent.width, subresource_extent.width);
3906 }
3907
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003908 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003909 LogObjectList objlist(cb_node->commandBuffer);
3910 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003911 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3912 skip |= LogError(objlist, vuid,
3913 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003914 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003915 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003916 region.extent.height, subresource_extent.height);
3917 }
3918
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003919 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003920 LogObjectList objlist(cb_node->commandBuffer);
3921 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003922 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3923 skip |= LogError(objlist, vuid,
3924 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003925 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003926 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003927 region.extent.depth, subresource_extent.depth);
3928 }
3929 }
3930
3931 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3932 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3933 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3934 // developer
3935 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3936 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003937 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003938 LogObjectList objlist(cb_node->commandBuffer);
3939 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003940 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3941 skip |= LogError(objlist, vuid,
3942 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003943 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003944 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003945 region.extent.width, subresource_extent.width);
3946 }
3947
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003948 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003949 LogObjectList objlist(cb_node->commandBuffer);
3950 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003951 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3952 skip |= LogError(objlist, vuid,
3953 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003954 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003955 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003956 region.extent.height, subresource_extent.height);
3957 }
3958
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003959 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003960 LogObjectList objlist(cb_node->commandBuffer);
3961 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003962 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3963 skip |= LogError(objlist, vuid,
3964 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003965 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003966 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003967 region.extent.depth, subresource_extent.depth);
3968 }
3969 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003970 }
3971
3972 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003973 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3974 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3975 func_name, string_VkFormat(src_image_state->createInfo.format),
3976 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003977 }
3978 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003979 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003980 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003981 string_VkImageType(src_image_state->createInfo.imageType),
3982 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003983 }
3984 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003985 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3986 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 -07003987 }
3988 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003989 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3990 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3991 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003992 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003993 } else {
3994 assert(0);
3995 }
3996 return skip;
3997}
3998
Jeff Leger178b1e52020-10-05 12:22:23 -04003999bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4000 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4001 const VkImageResolve *pRegions) const {
4002 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
4003 COPY_COMMAND_VERSION_1);
4004}
4005
4006bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
4007 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
4008 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4009 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
4010 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
4011}
4012
4013template <typename RegionType>
4014bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4015 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4016 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004017 const auto *cb_node = GetCBState(commandBuffer);
4018 const auto *src_image_state = GetImageState(srcImage);
4019 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004020
Jeff Leger178b1e52020-10-05 12:22:23 -04004021 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
4022 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
4023 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
4024
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004025 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07004026 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004027 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07004028 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004029 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004030 const char *vuid;
4031 const char *location;
4032 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
4033 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
4034 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
4035 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4036 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
4037 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
4038 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
4039 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
4040 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
4041 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
4042 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
4043 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
4044 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
4045 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
4046 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
4047 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
4048 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
4049 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
4050 skip |= ValidateCmd(cb_node, cmd_type, func_name);
4051 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
4052 skip |= InsideRenderPass(cb_node, func_name, vuid);
4053 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4054 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
4055 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4056 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
4057 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
4058 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
4059 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
4060 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
4061 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
4062 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004063
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004064 // Validation for VK_EXT_fragment_density_map
4065 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004066 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
4067 skip |= LogError(cb_node->commandBuffer, vuid,
4068 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4069 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004070 }
4071 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004072 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
4073 skip |= LogError(cb_node->commandBuffer, vuid,
4074 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4075 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004076 }
4077
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004078 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004079
Dave Houlton33c2d252017-06-09 17:08:32 -06004080 VkFormat src_format = src_image_state->createInfo.format;
4081 VkFormat dst_format = dst_image_state->createInfo.format;
4082 VkImageType src_type = src_image_state->createInfo.imageType;
4083 VkImageType dst_type = dst_image_state->createInfo.imageType;
4084
Cort Stratton186b1a22018-05-01 20:18:06 -04004085 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004086 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4087 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
4088 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004089 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004090 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004091 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04004092 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004093 }
4094
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004095 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004096 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
4097 skip |= LogError(device, vuid,
4098 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004099 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004100 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004101 }
4102
4103 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004104 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
4105 skip |= LogError(device, vuid,
4106 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004107 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004108 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004109 }
4110
Dave Houlton33c2d252017-06-09 17:08:32 -06004111 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004112 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
4113 skip |= LogError(cb_node->commandBuffer, vuid,
4114 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004115 }
4116
Dave Houlton33c2d252017-06-09 17:08:32 -06004117 // Validate consistency for unsigned formats
4118 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
4119 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004120 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004121 << "the other one must also have unsigned integer format. "
4122 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004123 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
4124 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004125 }
4126
4127 // Validate consistency for signed formats
4128 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
4129 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004130 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004131 << "the other one must also have signed integer format. "
4132 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004133 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
4134 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004135 }
4136
4137 // Validate filter for Depth/Stencil formats
4138 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4139 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004140 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004141 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04004142 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
4143 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004144 }
4145
4146 // Validate aspect bits and formats for depth/stencil images
4147 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4148 if (src_format != dst_format) {
4149 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004150 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 -06004151 << "stencil, the other one must have exactly the same format. "
4152 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4153 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004154 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
4155 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004156 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004157 } // Depth or Stencil
4158
4159 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004160 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004161 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4162 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4163 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
4164 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4165 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4166 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004167 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004168 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4169 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4170 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
4171 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4172 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4173 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004174 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004175 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004176 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004177 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004178 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004179 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4180 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004181 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004182 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4183 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4184 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4185 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4186 skip |=
4187 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4188 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4189 skip |=
4190 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4191 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004192 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004193 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4194 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004195 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004196 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004197 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004198 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4199 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004200 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004201 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004202 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004203 }
Dave Houlton48989f32017-05-26 15:01:46 -06004204 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4205 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004206 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004207 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004208 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004209 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004210
4211 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004212 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004213 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4214 skip |=
4215 LogError(cb_node->commandBuffer, vuid,
4216 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004217 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004218
Dave Houlton48989f32017-05-26 15:01:46 -06004219 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004220 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4221 skip |=
4222 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004223 }
Dave Houlton48989f32017-05-26 15:01:46 -06004224
Dave Houlton33c2d252017-06-09 17:08:32 -06004225 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004226 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
4227 skip |= LogError(cb_node->commandBuffer, vuid,
4228 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004229 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004230 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004231 }
4232
4233 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004234 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
4235 skip |= LogError(cb_node->commandBuffer, vuid,
4236 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4237 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004238 }
4239
Dave Houlton48989f32017-05-26 15:01:46 -06004240 // Validate source image offsets
4241 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004242 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004243 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004244 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
4245 skip |= LogError(cb_node->commandBuffer, vuid,
4246 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4247 "of (%1d, %1d). These must be (0, 1).",
4248 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004249 }
4250 }
4251
Dave Houlton33c2d252017-06-09 17:08:32 -06004252 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004253 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004254 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
4255 skip |= LogError(cb_node->commandBuffer, vuid,
4256 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4257 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4258 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004259 }
4260 }
4261
Dave Houlton33c2d252017-06-09 17:08:32 -06004262 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004263 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4264 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004265 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004266 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
4267 skip |= LogError(cb_node->commandBuffer, vuid,
4268 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4269 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004270 }
4271 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4272 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004273 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004274 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
4275 skip |= LogError(cb_node->commandBuffer, vuid,
4276 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4277 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004278 }
4279 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4280 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004281 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004282 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
4283 skip |= LogError(cb_node->commandBuffer, vuid,
4284 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4285 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004286 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004287 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004288 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4289 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4290 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004291 }
Dave Houlton48989f32017-05-26 15:01:46 -06004292
4293 // Validate dest image offsets
4294 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004295 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004296 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004297 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4298 skip |= LogError(cb_node->commandBuffer, vuid,
4299 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4300 "(%1d, %1d). These must be (0, 1).",
4301 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004302 }
4303 }
4304
Dave Houlton33c2d252017-06-09 17:08:32 -06004305 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004306 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004307 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4308 skip |= LogError(cb_node->commandBuffer, vuid,
4309 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004310 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004311 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004312 }
4313 }
4314
Dave Houlton33c2d252017-06-09 17:08:32 -06004315 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004316 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4317 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004318 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004319 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4320 skip |= LogError(cb_node->commandBuffer, vuid,
4321 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4322 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004323 }
4324 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4325 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004326 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004327 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4328 skip |= LogError(cb_node->commandBuffer, vuid,
4329 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4330 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004331 }
4332 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4333 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004334 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004335 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4336 skip |= LogError(cb_node->commandBuffer, vuid,
4337 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4338 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004339 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004340 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004341 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4342 skip |= LogError(cb_node->commandBuffer, vuid,
4343 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004344 }
4345
Dave Houlton33c2d252017-06-09 17:08:32 -06004346 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4347 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4348 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004349 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4350 skip |= LogError(cb_node->commandBuffer, vuid,
4351 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4352 "layerCount other than 1.",
4353 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004354 }
4355 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004356 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004357 } else {
4358 assert(0);
4359 }
4360 return skip;
4361}
4362
Jeff Leger178b1e52020-10-05 12:22:23 -04004363bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4364 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4365 const VkImageBlit *pRegions, VkFilter filter) const {
4366 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4367 COPY_COMMAND_VERSION_1);
4368}
4369
4370bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4371 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4372 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4373 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4374}
4375
4376template <typename RegionType>
4377void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4378 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4379 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004380 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004381 auto src_image_state = GetImageState(srcImage);
4382 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004383
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004384 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004385 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004386 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4387 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004388 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004389}
4390
Jeff Leger178b1e52020-10-05 12:22:23 -04004391void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4392 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4393 const VkImageBlit *pRegions, VkFilter filter) {
4394 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4395 pRegions, filter);
4396 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4397}
4398
4399void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4400 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4401 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4402 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4403 pBlitImageInfo->filter);
4404}
4405
John Zulauf2076e812020-01-08 14:55:54 -07004406GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4407 assert(map);
4408 // This approach allows for a single hash lookup or/create new
John Zulauf17708d02021-02-22 11:20:58 -07004409 auto &layout_map = (*map)[image_state.image];
4410 if (!layout_map) {
4411 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004412 }
John Zulauf17708d02021-02-22 11:20:58 -07004413 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004414}
4415
4416const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4417 auto it = map.find(image);
4418 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004419 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004420 }
4421 return nullptr;
4422}
4423
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004424// 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 -07004425bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4426 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004427 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004428 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004429 GlobalImageLayoutMap &overlay_layout_map = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004430 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004431 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004432 for (const auto &layout_map_entry : pCB->image_layout_map) {
4433 const auto image = layout_map_entry.first;
4434 const auto *image_state = GetImageState(image);
4435 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004436 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004437 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004438 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004439 if (initial_layout_map.empty()) continue;
4440
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004441 auto *overlay_map = GetLayoutRangeMap(&overlay_layout_map, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004442 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4443 if (global_map == nullptr) {
4444 global_map = &empty_map;
4445 }
4446
4447 // Note: don't know if it would matter
4448 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4449
4450 auto pos = initial_layout_map.begin();
4451 const auto end = initial_layout_map.end();
4452 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4453 pos->first.begin);
4454 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004455 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004456 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004457 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 -07004458 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004459 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004460 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004461 image_layout = current_layout->pos_B->lower_bound->second;
4462 }
4463 const auto intersected_range = pos->first & current_layout->range;
4464 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4465 // TODO: Set memory invalid which is in mem_tracker currently
4466 } else if (image_layout != initial_layout) {
4467 // Need to look up the inital layout *state* to get a bit more information
4468 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4469 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4470 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4471 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004472 // We can report all the errors for the intersected range directly
4473 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004474 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004475 skip |= LogError(
4476 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004477 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004478 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004479 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004480 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004481 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004482 }
4483 }
John Zulauf2076e812020-01-08 14:55:54 -07004484 if (pos->first.includes(intersected_range.end)) {
4485 current_layout.seek(intersected_range.end);
4486 } else {
4487 ++pos;
4488 if (pos != end) {
4489 current_layout.seek(pos->first.begin);
4490 }
4491 }
John Zulauff660ad62019-03-23 07:16:05 -06004492 }
4493
locke-lunargf155ccf2020-02-18 11:34:15 -07004494 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004495 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004496 }
John Zulauff660ad62019-03-23 07:16:05 -06004497
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004498 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004499}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004500
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004501void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004502 for (const auto &layout_map_entry : pCB->image_layout_map) {
4503 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004504 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004505 const auto *image_state = GetImageState(image);
4506 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004507 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4508 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004509 }
4510}
4511
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004512// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004513// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4514// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004515bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4516 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004517 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004518 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004519 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4520
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004521 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004522 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4523 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004524 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004525 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4526 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4527 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004528 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004529 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004530 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004531 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4532 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4533 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004534 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004535 string_VkImageLayout(first_layout));
4536 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4537 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004538 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004539 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004540 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004541 }
4542 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004543
4544 // Same as above for loadOp, but for stencilLoadOp
4545 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4546 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4547 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4548 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4549 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004550 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004551 string_VkImageLayout(first_layout));
4552 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4553 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4554 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004555 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004556 string_VkImageLayout(first_layout));
4557 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4558 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4559 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004560 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004561 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004562 }
4563 }
4564
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004565 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004566}
4567
Mark Lobodzinski96210742017-02-09 10:33:46 -07004568// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4569// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004570template <typename T1>
4571bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4572 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4573 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004574 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004575 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004576 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004577 if (strict) {
4578 correct_usage = ((actual & desired) == desired);
4579 } else {
4580 correct_usage = ((actual & desired) != 0);
4581 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004582
Mark Lobodzinski96210742017-02-09 10:33:46 -07004583 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004584 // All callers should have a valid VUID
4585 assert(msgCode != kVUIDUndefined);
4586 skip =
4587 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4588 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004589 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004590 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004591}
4592
4593// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4594// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004595bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004596 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004597 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004598 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004599}
4600
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004601bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004602 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004603 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004604 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4605 if ((image_format_features & desired) != desired) {
4606 // Same error, but more details if it was an AHB external format
4607 if (image_state->has_ahb_format == true) {
4608 skip |= LogError(image_state->image, vuid,
4609 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4610 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4611 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004612 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004613 } else {
4614 skip |= LogError(image_state->image, vuid,
4615 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4616 "with tiling %s.",
4617 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4618 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4619 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004620 }
4621 }
4622 return skip;
4623}
4624
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004625bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004626 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004627 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004628 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004629 // layerCount must not be zero
4630 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004631 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4632 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004633 }
4634 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004635 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004636 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4637 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004638 }
4639 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004640 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 -07004641 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4642 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4643 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4644 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004645 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004646 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4647 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4648 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4649 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4650 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4651 member);
4652 }
Cort Strattond619a302018-05-17 19:46:32 -07004653 return skip;
4654}
4655
Mark Lobodzinski96210742017-02-09 10:33:46 -07004656// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4657// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004658bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004659 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004660 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004661 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004662}
4663
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004664bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004665 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004666 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004667
4668 const VkDeviceSize &range = pCreateInfo->range;
4669 if (range != VK_WHOLE_SIZE) {
4670 // Range must be greater than 0
4671 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004672 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004673 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004674 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4675 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004676 }
4677 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004678 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4679 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004680 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004681 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004682 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4683 "(%" PRIu32 ").",
4684 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004685 }
4686 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004687 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004688 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004689 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004690 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4691 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4692 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004693 }
4694 // The sum of range and offset must be less than or equal to the size of buffer
4695 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004696 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004697 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004698 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4699 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4700 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004701 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004702 } else {
4703 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4704
4705 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4706 // VkPhysicalDeviceLimits::maxTexelBufferElements
4707 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4708 device_limits->maxTexelBufferElements) {
4709 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4710 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4711 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4712 "), divided by the element size of the format (%" PRIu32
4713 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4714 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4715 device_limits->maxTexelBufferElements);
4716 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004717 }
4718 return skip;
4719}
4720
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004721bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004722 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004723 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004724 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4725 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004726 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004727 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004728 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4729 "be supported for uniform texel buffers",
4730 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004731 }
4732 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4733 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004734 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004735 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004736 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4737 "be supported for storage texel buffers",
4738 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004739 }
4740 return skip;
4741}
4742
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004743bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004744 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004745 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004746
Dave Houltond8ed0212018-05-16 17:18:24 -06004747 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004748
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004749 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004750 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004751 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004752 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004753 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4754 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004755 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004756 }
4757 }
4758
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004759 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004760 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004761 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004762 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004763 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004764 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4765 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004766 }
4767 }
4768
Mike Schuchardt2df08912020-12-15 16:28:09 -08004769 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004770 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4771 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004772 skip |= LogError(
4773 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004774 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004775 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004776 }
4777
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004778 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004779 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4780 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4781 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004782 }
4783
sfricke-samsungedce77a2020-07-03 22:35:13 -07004784 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4785 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4786 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4787 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4788 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4789 }
4790 const VkBufferCreateFlags invalid_flags =
4791 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4792 if ((pCreateInfo->flags & invalid_flags) != 0) {
4793 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4794 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4795 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4796 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4797 }
4798 }
4799
Mark Lobodzinski96210742017-02-09 10:33:46 -07004800 return skip;
4801}
4802
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004803bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004804 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004805 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004806 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004807 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4808 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004809 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004810 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4811 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004812 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004813 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4814 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4815 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004816
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004817 // Buffer view offset must be less than the size of buffer
4818 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004819 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004820 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004821 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4822 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004823 }
4824
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004825 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004826 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4827 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4828 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004829 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4830 : "VUID-VkBufferViewCreateInfo-offset-00926";
4831 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004832 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004833 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4834 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004835 }
4836
4837 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004838 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4839 if ((element_size % 3) == 0) {
4840 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004841 }
4842 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004843 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004844 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4845 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004846 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004847 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004848 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004849 skip |= LogError(
4850 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004851 "vkCreateBufferView(): If buffer was created with usage containing "
4852 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004853 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4854 ") must be a multiple of the lesser of "
4855 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4856 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4857 "(%" PRId32
4858 ") is VK_TRUE, the size of a texel of the requested format. "
4859 "If the size of a texel is a multiple of three bytes, then the size of a "
4860 "single component of format is used instead",
4861 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4862 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4863 }
4864 }
4865 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004866 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004867 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4868 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004869 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004870 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004871 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004872 skip |= LogError(
4873 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004874 "vkCreateBufferView(): If buffer was created with usage containing "
4875 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004876 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4877 ") must be a multiple of the lesser of "
4878 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4879 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4880 "(%" PRId32
4881 ") is VK_TRUE, the size of a texel of the requested format. "
4882 "If the size of a texel is a multiple of three bytes, then the size of a "
4883 "single component of format is used instead",
4884 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4885 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4886 }
4887 }
4888 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004889
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004890 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004891
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004892 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004893 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004894 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004895}
4896
Mark Lobodzinski602de982017-02-09 11:01:33 -07004897// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004898bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004899 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004900 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004901 const IMAGE_STATE *image_state = GetImageState(image);
4902 // checks color format and (single-plane or non-disjoint)
4903 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004904 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004905 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004906 skip |= LogError(
4907 image, vuid,
4908 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4909 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004910 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004911 skip |= LogError(image, vuid,
4912 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4913 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4914 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004915 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004916 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004917 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004918 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004919 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4920 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4921 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004922 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004923 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004924 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4925 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4926 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004927 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004928 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004929 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004930 skip |= LogError(image, vuid,
4931 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4932 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4933 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004934 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004935 skip |= LogError(image, vuid,
4936 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4937 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4938 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004939 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004940 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004941 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004942 skip |= LogError(image, vuid,
4943 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4944 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4945 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004946 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004947 skip |= LogError(image, vuid,
4948 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4949 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4950 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004951 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004952 } else if (FormatIsMultiplane(format)) {
4953 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4954 if (3 == FormatPlaneCount(format)) {
4955 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4956 }
4957 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004958 skip |= LogError(image, vuid,
4959 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4960 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4961 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004962 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004963 }
4964 return skip;
4965}
4966
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004967bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4968 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004969 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4970 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004971 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004972
4973 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004974 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004975 skip |= LogError(image, errorCodes.base_mip_err,
4976 "%s: %s.baseMipLevel (= %" PRIu32
4977 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4978 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004979 }
Petr Kraus4d718682017-05-18 03:38:41 +02004980
Petr Krausffa94af2017-08-08 21:46:02 +02004981 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4982 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004983 skip |=
4984 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004985 } else {
4986 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004987
Petr Krausffa94af2017-08-08 21:46:02 +02004988 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004989 skip |= LogError(image, errorCodes.mip_count_err,
4990 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4991 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4992 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4993 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004994 }
Petr Kraus4d718682017-05-18 03:38:41 +02004995 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004996 }
Petr Kraus4d718682017-05-18 03:38:41 +02004997
4998 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004999 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005000 skip |= LogError(image, errorCodes.base_layer_err,
5001 "%s: %s.baseArrayLayer (= %" PRIu32
5002 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5003 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005004 }
Petr Kraus4d718682017-05-18 03:38:41 +02005005
Petr Krausffa94af2017-08-08 21:46:02 +02005006 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5007 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005008 skip |=
5009 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005010 } else {
5011 const uint64_t necessary_layer_count =
5012 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005013
Petr Krausffa94af2017-08-08 21:46:02 +02005014 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005015 skip |= LogError(image, errorCodes.layer_count_err,
5016 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5017 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5018 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5019 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005020 }
Petr Kraus4d718682017-05-18 03:38:41 +02005021 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005022 }
Petr Kraus4d718682017-05-18 03:38:41 +02005023
Mark Lobodzinski602de982017-02-09 11:01:33 -07005024 return skip;
5025}
5026
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005027bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005028 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005029 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02005030 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08005031 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005032 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 +02005033
David McFarland2853f2f2020-11-30 15:50:39 -04005034 uint32_t image_layer_count;
5035
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005036 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005037 const auto layers = LayersFromRange(subresourceRange);
5038 const auto extent = GetImageSubresourceExtent(image_state, &layers);
5039 image_layer_count = extent.depth;
5040 } else {
5041 image_layer_count = image_state->createInfo.arrayLayers;
5042 }
5043
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005044 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005045
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005046 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5047 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5048 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5049 subresource_range_error_codes.base_layer_err =
5050 is_khr_maintenance1
5051 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
5052 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
5053 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
5054 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5055 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
5056 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005057
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005058 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005059 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005060 image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005061}
5062
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005063bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005064 const VkImageSubresourceRange &subresourceRange,
5065 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005066 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5067 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5068 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5069 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5070 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005071
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005072 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005073 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005074 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005075}
5076
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005077bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005078 const VkImageSubresourceRange &subresourceRange,
5079 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005080 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5081 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5082 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5083 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5084 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005085
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005086 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005087 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005088 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005089}
5090
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005091bool CoreChecks::ValidateImageBarrierSubresourceRange(const CoreErrorLocation &loc, const IMAGE_STATE *image_state,
5092 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005093 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005094 loc.StringFuncName().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image,
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005095 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005096}
5097
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005098namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005099using sync_vuid_maps::GetBarrierQueueVUID;
5100using sync_vuid_maps::kQueueErrorSummary;
5101using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005102
5103class ValidatorState {
5104 public:
John Zulaufbea70432021-02-23 07:03:12 -07005105 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const CoreErrorLocation &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005106 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5107 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005108 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005109 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005110 barrier_handle_(barrier_handle),
5111 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005112 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5113 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5114
5115 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5116 // 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 -07005117 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5118 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005119 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005120 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5121 loc_.Message().c_str(), GetTypeString(),
5122 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5123 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005124 }
5125
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005126 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5127 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005128 const char *src_annotation = GetFamilyAnnotation(src_family);
5129 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5130 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005131 objects_, val_code,
5132 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5133 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5134 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005135 }
5136
5137 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5138 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5139 // application input.
5140 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5141 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005142 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005143 uint32_t queue_family = queue_state->queueFamilyIndex;
5144 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005145 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005146 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5147 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5148 return device_data->LogError(
5149 queue_state->queue, val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005150 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005151 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005152 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005153 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005154 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005155 }
5156 return false;
5157 }
5158 // Logical helpers for semantic clarity
5159 inline bool KhrExternalMem() const { return mem_ext_; }
5160 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5161 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5162 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5163 }
5164
5165 // Helpers for LogMsg
5166 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5167
5168 // Descriptive text for the various types of queue family index
5169 const char *GetFamilyAnnotation(uint32_t family) const {
5170 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5171 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5172 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5173 const char *valid = " (VALID)";
5174 const char *invalid = " (INVALID)";
5175 switch (family) {
5176 case VK_QUEUE_FAMILY_EXTERNAL:
5177 return external;
5178 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5179 return foreign;
5180 case VK_QUEUE_FAMILY_IGNORED:
5181 return ignored;
5182 default:
5183 if (IsValid(family)) {
5184 return valid;
5185 }
5186 return invalid;
5187 };
5188 }
5189 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5190 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5191
5192 protected:
5193 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005194 const LogObjectList objects_;
5195 const CoreErrorLocation loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005196 const VulkanTypedHandle barrier_handle_;
5197 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005198 const uint32_t limit_;
5199 const bool mem_ext_;
5200};
5201
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005202bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005203 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5204 bool skip = false;
5205
5206 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5207 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5208 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5209 if (val.KhrExternalMem()) {
5210 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005211 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5212 // this requirement is removed by VK_KHR_synchronization2
5213 if (!(src_ignored || dst_ignored) && !sync2) {
5214 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005215 }
5216 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5217 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005218 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005219 }
5220 } else {
5221 // VK_SHARING_MODE_EXCLUSIVE
5222 if (src_queue_family != dst_queue_family) {
5223 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005224 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005225 }
5226 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005227 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005228 }
5229 }
5230 }
5231 } else {
5232 // No memory extension
5233 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005234 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5235 // this requirement is removed by VK_KHR_synchronization2
5236 if ((!src_ignored || !dst_ignored) && !sync2) {
5237 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005238 }
5239 } else {
5240 // VK_SHARING_MODE_EXCLUSIVE
5241 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005242 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005243 }
5244 }
5245 }
5246 return skip;
5247}
5248} // namespace barrier_queue_families
5249
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005250bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const CoreErrorLocation &loc, const ValidationStateTracker *state_data,
5251 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005252 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5253 uint32_t dst_queue_family) {
5254 using barrier_queue_families::ValidatorState;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005255 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005256 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5257}
5258
5259// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005260template <typename ImgBarrier>
5261bool CoreChecks::ValidateBarrierQueueFamilies(const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5262 const ImgBarrier &barrier, const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005263 // State data is required
5264 if (!state_data) {
5265 return false;
5266 }
5267
5268 // Create the validator state from the image state
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005269 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer), loc,
5270 VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005271 state_data->createInfo.sharingMode);
5272 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5273 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005274 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005275}
5276
5277// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005278template <typename BufBarrier>
5279bool CoreChecks::ValidateBarrierQueueFamilies(const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5280 const BufBarrier &barrier, const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005281 // State data is required
5282 if (!state_data) {
5283 return false;
5284 }
5285
5286 // Create the validator state from the buffer state
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005287 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer), loc,
5288 VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer),
5289 state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005290 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5291 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005292 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5293}
5294
5295template <typename Barrier>
5296bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5297 const Barrier &mem_barrier) const {
5298 using sync_vuid_maps::BufferError;
5299 using sync_vuid_maps::GetBufferBarrierVUID;
5300
5301 bool skip = false;
5302
5303 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5304
5305 // Validate buffer barrier queue family indices
5306 auto buffer_state = GetBufferState(mem_barrier.buffer);
5307 if (buffer_state) {
5308 auto buf_loc = loc.dot(Field::buffer);
5309 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
5310 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFuncName().c_str(), mem_vuid.c_str());
5311
5312 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5313
5314 auto buffer_size = buffer_state->createInfo.size;
5315 if (mem_barrier.offset >= buffer_size) {
5316 auto offset_loc = loc.dot(Field::offset);
5317 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5318
5319 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5320 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5321 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5322 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5323 auto size_loc = loc.dot(Field::size);
5324 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5325 skip |= LogError(objects, vuid,
5326 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5327 ".",
5328 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5329 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5330 }
5331 if (mem_barrier.size == 0) {
5332 auto size_loc = loc.dot(Field::size);
5333 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5334 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5335 report_data->FormatHandle(mem_barrier.buffer).c_str());
5336 }
5337 }
5338 return skip;
5339}
5340
5341template <typename Barrier>
5342bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, const CMD_BUFFER_STATE *cb_state,
5343 const Barrier &mem_barrier) const {
5344 bool skip = false;
5345
5346 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5347
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005348 bool is_ilt = true;
5349 if (enabled_features.synchronization2_features.synchronization2) {
5350 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5351 }
5352
5353 if (is_ilt) {
5354 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5355 auto layout_loc = loc.dot(Field::newLayout);
5356 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5357 skip |=
5358 LogError(cb_state->commandBuffer, vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005359 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005360 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005361 }
5362
5363 auto image_data = GetImageState(mem_barrier.image);
5364 if (image_data) {
5365 auto image_loc = loc.dot(Field::image);
5366
John Zulaufbea70432021-02-23 07:03:12 -07005367 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005368
5369 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5370
Jeremy Gebbenb1c48512021-02-22 17:34:28 -07005371 skip |= ValidateImageAspectMask(image_data->image, image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
5372 loc.StringFuncName().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005373
5374 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
5375 }
5376 return skip;
5377}
5378
5379bool CoreChecks::ValidateBarriers(const CoreErrorLocation &outer_loc, const CMD_BUFFER_STATE *cb_state,
5380 VkPipelineStageFlags src_stage_mask, VkPipelineStageFlags dst_stage_mask,
5381 uint32_t memBarrierCount, const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
5382 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5383 const VkImageMemoryBarrier *pImageMemBarriers) const {
5384 bool skip = false;
5385 auto queue_flags = GetQueueFlags(*cb_state);
5386 LogObjectList objects(cb_state->commandBuffer);
5387 auto op_type =
5388 ComputeBarrierOperationsType(cb_state, bufferBarrierCount, pBufferMemBarriers, imageMemBarrierCount, pImageMemBarriers);
5389
5390 // NOTE: for vkCmdPipelineBarrier() and vkCmdWaitEvents() the access mask checks use the function name for {refpage}
5391 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5392 const auto &mem_barrier = pMemBarriers[i];
5393 CoreErrorLocation loc(outer_loc.func_name, outer_loc.refpage, Field::pMemoryBarriers, i);
5394 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5395 }
5396 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5397 const auto &mem_barrier = pImageMemBarriers[i];
5398 CoreErrorLocation loc(outer_loc.func_name, outer_loc.refpage, Field::pImageMemoryBarriers, i);
5399 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5400
5401 loc.refpage = RefPage::VkImageMemoryBarrier;
5402 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5403 }
5404 {
5405 CoreErrorLocation loc(outer_loc.func_name, RefPage::VkImageMemoryBarrier);
5406 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5407 }
5408 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5409 const auto &mem_barrier = pBufferMemBarriers[i];
5410 CoreErrorLocation loc(outer_loc.func_name, outer_loc.refpage, Field::pBufferMemoryBarriers, i);
5411 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5412
5413 loc.refpage = RefPage::VkBufferMemoryBarrier;
5414 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5415 }
5416 return skip;
5417}
5418
5419bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const CoreErrorLocation &outer_loc,
5420 const CMD_BUFFER_STATE *cb_state, BarrierOperationsType op_type,
5421 const VkDependencyInfoKHR *dep_info) const {
5422 bool skip = false;
5423
5424 if (cb_state->activeRenderPass) {
5425 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5426 if (skip) return true; // Early return to avoid redundant errors from below calls
5427 }
5428 auto queue_flags = GetQueueFlags(*cb_state);
5429 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5430 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
5431 CoreErrorLocation loc = outer_loc.dot(Field::pMemoryBarriers, i);
5432 loc.refpage = RefPage::VkMemoryBarrier2KHR;
5433 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5434 }
5435 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5436 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
5437 CoreErrorLocation loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
5438 loc.refpage = RefPage::VkImageMemoryBarrier2KHR;
5439 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5440 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5441 }
5442 {
5443 CoreErrorLocation loc(outer_loc.func_name, RefPage::VkImageMemoryBarrier2KHR);
5444 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5445 }
5446
5447 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5448 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
5449 CoreErrorLocation loc = outer_loc.dot(Field::pBufferMemoryBarriers, i);
5450 loc.refpage = RefPage::VkBufferMemoryBarrier2KHR;
5451 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5452 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5453 }
5454
5455 return skip;
5456}
5457
5458template <typename Barrier>
5459bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, BarrierOperationsType op_type,
5460 VkQueueFlags queue_flags, const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
5461 VkPipelineStageFlags dst_stage_mask) const {
5462 bool skip = false;
5463 if (op_type == kAllRelease || op_type == kGeneral) {
5464 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5465 }
5466 if (op_type == kAllAcquire || op_type == kGeneral) {
5467 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5468 }
5469 return skip;
5470}
5471
5472template <typename Barrier>
5473bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, BarrierOperationsType op_type,
5474 VkQueueFlags queue_flags, const Barrier &barrier) const {
5475 bool skip = false;
5476 if (op_type == kAllRelease || op_type == kGeneral) {
5477 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
5478 skip |=
5479 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5480 }
5481 if (op_type == kAllAcquire || op_type == kGeneral) {
5482 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
5483 skip |=
5484 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5485 }
5486 return skip;
5487}
5488
5489bool CoreChecks::ValidateSubpassBarrier(const LogObjectList &objects, const CoreErrorLocation &loc, VkQueueFlags queue_flags,
5490 const VkSubpassDependency2 &barrier) const {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005491 bool skip = false;
5492 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(barrier.pNext);
5493 if (mem_barrier) {
5494 if (enabled_features.synchronization2_features.synchronization2) {
5495 if (barrier.srcAccessMask != 0) {
5496 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5497 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5498 loc.dot(Field::srcAccessMask).Message().c_str());
5499 }
5500 if (barrier.dstAccessMask != 0) {
5501 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5502 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5503 loc.dot(Field::dstAccessMask).Message().c_str());
5504 }
5505 if (barrier.srcStageMask != 0 || barrier.dstStageMask != 0) {
5506 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5507 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5508 loc.dot(Field::srcStageMask).Message().c_str());
5509 }
5510 if (barrier.dstStageMask != 0) {
5511 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5512 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5513 loc.dot(Field::dstStageMask).Message().c_str());
5514 }
5515
5516 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc.dot(Field::pNext), kGeneral, queue_flags, *mem_barrier);
5517 return skip;
5518 } else {
5519 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5520 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5521 loc.Message().c_str());
5522 }
5523 }
5524 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc, kGeneral, queue_flags, barrier);
5525 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005526}
5527
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005528bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5529 const VkImageUsageFlags image_usage) const {
5530 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5531 bool skip = false;
5532
5533 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5534 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5535
5536 if (image_state->has_ahb_format == true) {
5537 // AHB image view and image share same feature sets
5538 tiling_features = image_state->format_features;
5539 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5540 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
5541 assert(device_extensions.vk_ext_image_drm_format_modifier);
5542 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5543 nullptr};
5544 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
5545
5546 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5547 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5548 nullptr};
5549 format_properties_2.pNext = (void *)&drm_properties_list;
5550 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5551
5552 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5553 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5554 0) {
5555 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5556 }
5557 }
5558 } else {
5559 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5560 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5561 : format_properties.optimalTilingFeatures;
5562 }
5563
5564 if (tiling_features == 0) {
5565 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
5566 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5567 "physical device.",
5568 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5569 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
5570 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
5571 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5572 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5573 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5574 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
5575 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
5576 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5577 "VK_IMAGE_USAGE_STORAGE_BIT.",
5578 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5579 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
5580 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
5581 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5582 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5583 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5584 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5585 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
5586 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
5587 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5588 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5589 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5590 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5591 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
5592 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
5593 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5594 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5595 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005596 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5597 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5598 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5599 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-04550",
5600 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5601 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5602 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5603 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005604 }
5605
5606 return skip;
5607}
5608
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005609bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005610 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005611 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005612 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005613 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005614 skip |=
5615 ValidateImageUsageFlags(image_state,
5616 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5617 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005618 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5619 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5620 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005621 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005622 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005623 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005624 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005625 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005626 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005627 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005628 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005629
5630 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5631 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005632 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005633 VkFormat view_format = pCreateInfo->format;
5634 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005635 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005636 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005637
Dave Houltonbd2e2622018-04-10 16:41:14 -06005638 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005639 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005640 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005641 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005642 if (!device_extensions.vk_ext_separate_stencil_usage) {
5643 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005644 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5645 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5646 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005647 }
5648 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005649 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005650 if (image_stencil_struct == nullptr) {
5651 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005652 skip |= LogError(
5653 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005654 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5655 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5656 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5657 }
5658 } else {
5659 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5660 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5661 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005662 skip |= LogError(
5663 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005664 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5665 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5666 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5667 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5668 }
5669 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5670 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005671 skip |= LogError(
5672 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
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 bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5676 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5677 }
5678 }
5679 }
5680 }
5681
Dave Houltonbd2e2622018-04-10 16:41:14 -06005682 image_usage = chained_ivuci_struct->usage;
5683 }
5684
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005685 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5686 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005687 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005688 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005689 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005690 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005691 std::stringstream ss;
5692 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005693 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005694 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005695 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005696 }
5697 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005698 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005699 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5700 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005701 const char *error_vuid;
5702 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5703 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5704 } else if ((device_extensions.vk_khr_maintenance2) &&
5705 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5706 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5707 } else if ((!device_extensions.vk_khr_maintenance2) &&
5708 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5709 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5710 } else {
5711 // both enabled
5712 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5713 }
Dave Houltonc7988072018-04-16 11:46:56 -06005714 std::stringstream ss;
5715 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005716 << " is not in the same format compatibility class as "
5717 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005718 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5719 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005720 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005721 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005722 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005723 }
5724 } else {
5725 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005726 // Unless it is a multi-planar color bit aspect
5727 if ((image_format != view_format) &&
5728 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5729 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5730 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005731 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005732 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005733 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005734 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005735 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005736 }
5737 }
5738
5739 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005740 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005741
5742 switch (image_type) {
5743 case VK_IMAGE_TYPE_1D:
5744 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005745 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5746 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5747 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005748 }
5749 break;
5750 case VK_IMAGE_TYPE_2D:
5751 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5752 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5753 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005754 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
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 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005758 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5759 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5760 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005761 }
5762 }
5763 break;
5764 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005765 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005766 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5767 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005768 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005769 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005770 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5771 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5772 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005773 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5774 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005775 skip |= LogError(
5776 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5777 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5778 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5779 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5780 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005781 }
5782 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005783 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5784 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5785 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005786 }
5787 }
5788 } else {
5789 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005790 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5791 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5792 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005793 }
5794 }
5795 break;
5796 default:
5797 break;
5798 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005799
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005800 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005801 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005802 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005803 }
5804
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005805 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005806
Tobias Hector6663c9b2020-11-05 10:18:02 +00005807 if (enabled_features.shading_rate_image.shadingRateImage) {
5808 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5809 if (view_format != VK_FORMAT_R8_UINT) {
5810 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5811 "vkCreateImageView() If image was created with usage containing "
5812 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5813 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005814 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005815 }
5816
5817 if (enabled_features.shading_rate_image.shadingRateImage ||
5818 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5819 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5820 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5821 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5822 "vkCreateImageView() If image was created with usage containing "
5823 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5824 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5825 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005826 }
5827 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005828
Tobias Hector6663c9b2020-11-05 10:18:02 +00005829 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5830 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5831 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5832 pCreateInfo->subresourceRange.layerCount != 1) {
5833 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5834 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5835 pCreateInfo->subresourceRange.layerCount);
5836 }
5837
Jeff Bolz99e3f632020-03-24 22:59:22 -05005838 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5839 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5840 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5841 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5842 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5843 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5844 }
5845 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5846 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5847 skip |= LogError(
5848 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5849 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5850 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5851 }
5852 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005853
5854 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5855 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005856 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005857 "vkCreateImageView(): If image was created with usage containing "
5858 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5859 pCreateInfo->subresourceRange.levelCount);
5860 }
5861 }
5862 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5863 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005864 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005865 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5866 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5867 }
5868 } else {
5869 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5870 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5871 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005872 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005873 "vkCreateImageView(): If image was created with usage containing "
5874 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5875 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5876 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5877 }
5878 }
5879 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005880
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005881 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5882 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5883 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5884 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5885 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5886 }
5887 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5888 skip |=
5889 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5890 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5891 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5892 }
5893 }
5894 if (device_extensions.vk_ext_fragment_density_map_2) {
5895 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5896 (pCreateInfo->subresourceRange.layerCount >
5897 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5898 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5899 "vkCreateImageView(): If image was created with flags containing "
5900 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5901 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5902 pCreateInfo->subresourceRange.layerCount,
5903 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5904 }
5905 }
5906
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005907 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005908 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5909 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5910 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5911 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5912 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5913 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5914 }
5915 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005916
5917 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5918 // If swizzling is disabled, make sure it isn't used
5919 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5920 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5921 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5922 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5923 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5924 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5925 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5926 }
5927
5928 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5929 // disabled
5930 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5931 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5932 // spec. See Github issue #2361.
5933 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5934 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5935 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5936 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5937 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5938 "vkCreateImageView (portability error): ImageView format must have"
5939 " the same number of components and bits per component as the Image's format");
5940 }
5941 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005942 }
5943 return skip;
5944}
5945
Jeff Leger178b1e52020-10-05 12:22:23 -04005946template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005947bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005948 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005949 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005950 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5951 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5952 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005953
5954 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5955 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5956 VkDeviceSize src_min = UINT64_MAX;
5957 VkDeviceSize src_max = 0;
5958 VkDeviceSize dst_min = UINT64_MAX;
5959 VkDeviceSize dst_max = 0;
5960
5961 for (uint32_t i = 0; i < regionCount; i++) {
5962 src_min = std::min(src_min, pRegions[i].srcOffset);
5963 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5964 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5965 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5966
5967 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5968 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005969 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5970 skip |= LogError(src_buffer_state->buffer, vuid,
5971 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5972 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005973 }
5974
5975 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5976 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005977 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5978 skip |= LogError(dst_buffer_state->buffer, vuid,
5979 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5980 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005981 }
5982
5983 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5984 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005985 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5986 skip |= LogError(src_buffer_state->buffer, vuid,
5987 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005988 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005989 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
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 dstBuffer minus dstOffset
5993 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005994 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5995 skip |= LogError(dst_buffer_state->buffer, vuid,
5996 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005997 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005998 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005999 }
6000 }
6001
6002 // The union of the source regions, and the union of the destination regions, must not overlap in memory
6003 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
6004 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006005 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6006 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
6007 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006008 }
6009 }
6010
6011 return skip;
6012}
6013
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006014bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006015 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006016 const auto cb_node = GetCBState(commandBuffer);
6017 const auto src_buffer_state = GetBufferState(srcBuffer);
6018 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006019
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006020 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006021 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
6022 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006023 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06006024 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006025 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
6026 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06006027 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006028 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
6029 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07006030 skip |=
6031 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6032 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006033 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
6034 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04006035 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07006036 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
6037 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
6038 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006039 return skip;
6040}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006041
Jeff Leger178b1e52020-10-05 12:22:23 -04006042bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6043 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
6044 const auto cb_node = GetCBState(commandBuffer);
6045 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
6046 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
6047
6048 bool skip = false;
6049 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
6050 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
6051 // Validate that SRC & DST buffers have correct usage flags set
6052 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
6053 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
6054 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6055 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
6056 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
6057 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6058 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
6059 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6060 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
6061 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
6062 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
6063 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
6064 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
6065 skip |=
6066 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
6067 skip |=
6068 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
6069 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
6070 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
6071 return skip;
6072}
6073
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006074bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006075 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006076 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006077 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006078 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006079 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6080 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006081 }
6082 }
6083 return skip;
6084}
6085
Jeff Bolz5c801d12019-10-09 10:38:45 -05006086bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6087 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006088 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06006089 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006090
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006091 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006092 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006093 skip |=
6094 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006095 }
6096 return skip;
6097}
6098
Jeff Bolz5c801d12019-10-09 10:38:45 -05006099bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006100 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006101
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006102 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006103 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006104 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006105 }
6106 return skip;
6107}
6108
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006109bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006110 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006111 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06006112 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006113 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006114 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006115 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006116 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006117 }
6118 return skip;
6119}
6120
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006121bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006122 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006123 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006124 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006125 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006126 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07006127 skip |=
6128 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6129 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006130 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006131 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006132 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6133 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006134 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006135
sfricke-samsung022fa252020-07-24 03:26:16 -07006136 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6137 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6138
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006139 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006140 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6141 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6142 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6143 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006144 }
6145
6146 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006147 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6148 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6149 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6150 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006151 }
6152
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006153 return skip;
6154}
6155
Jeff Leger178b1e52020-10-05 12:22:23 -04006156template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006157bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006158 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006159 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006160 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006161 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6162 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006163
sfricke-samsung125d2b42020-05-28 06:32:43 -07006164 assert(image_state != nullptr);
6165 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006166
6167 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006168 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006169 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6170 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006171 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006172 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6173 "and 1, respectively.",
6174 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006175 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006176 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006177
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006178 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6179 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006180 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006181 "%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 -07006182 "must be 0 and 1, respectively.",
6183 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
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_3D) {
6188 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006189 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006190 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006191 "For 3D images these must be 0 and 1, respectively.",
6192 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006193 }
6194 }
6195
6196 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006197 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08006198 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
6199 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006200
sfricke-samsung8feecc12021-01-23 03:28:38 -08006201 if (FormatIsDepthOrStencil(image_format)) {
6202 if (SafeModulo(bufferOffset, 4) != 0) {
6203 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
6204 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6205 " must be a multiple 4 if using a depth/stencil format (%s).",
6206 function, i, bufferOffset, string_VkFormat(image_format));
6207 }
6208 } else {
6209 // If not depth/stencil and not multi-plane
6210 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
6211 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
6212 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6213 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
6214 skip |= LogError(image_state->image, vuid,
6215 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6216 " must be a multiple of this format's texel size (%" PRIu32 ").",
6217 function, i, bufferOffset, element_size);
6218 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006219 }
6220
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006221 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6222 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006223 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006224 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006225 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006226 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006227 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006228 }
6229
6230 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6231 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006232 vuid =
6233 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006234 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006235 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006236 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6237 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006238 }
6239
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006240 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006241 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006242 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006243 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 -06006244 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6245 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006246 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006247 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006248 "zero or <= image subresource width (%d).",
6249 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006250 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006251 }
6252
6253 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006254 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 -06006255 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6256 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006257 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006258 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006259 "zero or <= image subresource height (%d).",
6260 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006261 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006262 }
6263
6264 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006265 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 -06006266 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6267 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006268 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006269 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006270 "zero or <= image subresource depth (%d).",
6271 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006272 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006273 }
6274
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006275 // subresource aspectMask must have exactly 1 bit set
6276 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006277 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006278 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006279 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
6280 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006281 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006282 }
6283
6284 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006285 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006286 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006287 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006288 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6289 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006290 }
6291
6292 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006293 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6294 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006295
6296 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006297 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006298 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006299 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006300 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
6301 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006302 }
6303
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006304 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006305 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006306 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006307 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006308 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006309 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006310 }
6311
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006312 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006313 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6314 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6315 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006316 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006317 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006318 "width & height (%d, %d)..",
6319 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6320 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006321 }
6322
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006323 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07006324 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006325 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006326 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006327 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006328 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006329 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006330 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006331
6332 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07006333 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06006334 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006335 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006336 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006337 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006338 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
6339 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6340 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006341 }
6342
6343 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006344 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006345 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006346 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006347 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006348 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
6349 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6350 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006351 }
6352
6353 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006354 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006355 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006356 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006357 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006358 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
6359 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6360 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006361 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006362 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006363
6364 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006365 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006366 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006367 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006368 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006369 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006370 "format has three planes.",
6371 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006372 }
6373
6374 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006375 if (0 ==
6376 (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 -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 for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006379 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6380 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006381 } else {
6382 // Know aspect mask is valid
6383 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6384 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006385 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006386 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07006387 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006388 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006389 " 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 -08006390 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006391 string_VkFormat(compatible_format));
6392 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006393 }
6394 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006395
6396 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6397 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6398 assert(command_pool != nullptr);
6399 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6400 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6401 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
6402 LogObjectList objlist(cb_node->commandBuffer);
6403 objlist.add(command_pool->commandPool);
6404 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
6405 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6406 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6407 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6408 "VK_QUEUE_COMPUTE_BIT flag.",
6409 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6410 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6411 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006412 }
6413
6414 return skip;
6415}
6416
Jeff Leger178b1e52020-10-05 12:22:23 -04006417template <typename BufferImageCopyRegionType>
6418bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6419 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006420 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006421 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006422
6423 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006424 VkExtent3D extent = pRegions[i].imageExtent;
6425 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006426
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006427 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6428 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006429 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
6430 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6431 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006432 }
6433
6434 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
6435
6436 // 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 -06006437 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006438 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006439 if (image_extent.width % block_extent.width) {
6440 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6441 }
6442 if (image_extent.height % block_extent.height) {
6443 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6444 }
6445 if (image_extent.depth % block_extent.depth) {
6446 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6447 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006448 }
6449
Dave Houltonfc1a4052017-04-27 14:32:45 -06006450 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006451 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006452 }
6453 }
6454
6455 return skip;
6456}
6457
Jeff Leger178b1e52020-10-05 12:22:23 -04006458template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006459bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006460 const BufferImageCopyRegionType *pRegions, const char *func_name,
6461 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006462 bool skip = false;
6463
6464 VkDeviceSize buffer_size = buff_state->createInfo.size;
6465
6466 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07006467 VkDeviceSize max_buffer_offset =
6468 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
6469 if (buffer_size < max_buffer_offset) {
6470 skip |=
6471 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 -07006472 }
6473 }
6474
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006475 return skip;
6476}
6477
Jeff Leger178b1e52020-10-05 12:22:23 -04006478template <typename BufferImageCopyRegionType>
6479bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6480 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6481 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006482 const auto cb_node = GetCBState(commandBuffer);
6483 const auto src_image_state = GetImageState(srcImage);
6484 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006485
Jeff Leger178b1e52020-10-05 12:22:23 -04006486 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6487 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
6488 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
6489 const char *vuid;
6490
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006491 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006492
6493 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006494 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006495
6496 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006497 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006498
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006499 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006500
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006501 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006502 vuid =
6503 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6504 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6505 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6506 "or transfer capabilities.",
6507 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006508 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006509 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
6510 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6511 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6512 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006513
Jeff Leger178b1e52020-10-05 12:22:23 -04006514 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6515 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6516 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6517
6518 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6519 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6520 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6521 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006522
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006523 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006524 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6525 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006526 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006527 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6528 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006529 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006530 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6531 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6532 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6533 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6534 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6535 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006536
6537 // Validation for VK_EXT_fragment_density_map
6538 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006539 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
6540 skip |= LogError(cb_node->commandBuffer, vuid,
6541 "%s: srcImage must not have been created with flags containing "
6542 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6543 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006544 }
6545
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006546 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006547 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6548 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006549 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006550 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
6551 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06006552 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006553
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006554 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 -04006555 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6556 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6557 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6558 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
6559
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006560 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006561 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6562 vuid =
6563 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006564 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006565 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6566 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6567 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6568 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6569 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6570 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6571 "imageSubresource", vuid);
6572 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6573 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006574 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006575 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006576 }
6577 return skip;
6578}
6579
Jeff Leger178b1e52020-10-05 12:22:23 -04006580bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6581 VkBuffer dstBuffer, uint32_t regionCount,
6582 const VkBufferImageCopy *pRegions) const {
6583 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6584 COPY_COMMAND_VERSION_1);
6585}
6586
6587bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6588 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6589 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6590 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6591 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6592}
6593
John Zulauf1686f232019-07-09 16:27:11 -06006594void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6595 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6596 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6597
6598 auto cb_node = GetCBState(commandBuffer);
6599 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006600 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006601 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006602 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006603 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006604}
6605
Jeff Leger178b1e52020-10-05 12:22:23 -04006606void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6607 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6608 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6609
6610 auto cb_node = GetCBState(commandBuffer);
6611 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6612 // Make sure that all image slices record referenced layout
6613 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6614 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6615 pCopyImageToBufferInfo->srcImageLayout);
6616 }
6617}
6618
6619template <typename RegionType>
6620bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6621 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6622 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006623 const auto cb_node = GetCBState(commandBuffer);
6624 const auto src_buffer_state = GetBufferState(srcBuffer);
6625 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006626
Jeff Leger178b1e52020-10-05 12:22:23 -04006627 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6628 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
6629 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
6630 const char *vuid;
6631
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006632 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006633
6634 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006635 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006636
sfricke-samsungea4fd142020-10-17 23:51:59 -07006637 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
6638 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
6639
Jeff Leger178b1e52020-10-05 12:22:23 -04006640 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
6641 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6642 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6643 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6644
6645 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6646 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6647 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6648 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6649 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6650 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6651 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6652 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6653 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006654 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006655 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6656 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006657 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006658 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6659 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6660 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6661 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6662 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6663 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006664
6665 // Validation for VK_EXT_fragment_density_map
6666 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006667 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
6668 skip |= LogError(cb_node->commandBuffer, vuid,
6669 "%s: dstImage must not have been created with flags containing "
6670 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6671 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006672 }
6673
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006674 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006675 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6676 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006677 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006678 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
6679 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06006680 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006681
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006682 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 -04006683 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6684 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6685 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6686 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6687
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006688 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006689 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6690 vuid =
6691 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006692 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006693 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6694 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6695 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6696 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6697 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6698 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6699 "imageSubresource", vuid);
6700 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6701 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006702 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006703 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006704
6705 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6706 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6707 assert(command_pool != nullptr);
6708 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6709 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6710 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6711 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6712 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
6713 LogObjectList objlist(cb_node->commandBuffer);
6714 objlist.add(command_pool->commandPool);
6715 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6716 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
6717 skip |= LogError(dst_image_state->image, vuid,
6718 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6719 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6720 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
6721 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6722 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6723 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006724 }
6725 return skip;
6726}
6727
Jeff Leger178b1e52020-10-05 12:22:23 -04006728bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6729 VkImageLayout dstImageLayout, uint32_t regionCount,
6730 const VkBufferImageCopy *pRegions) const {
6731 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6732 COPY_COMMAND_VERSION_1);
6733}
6734
6735bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6736 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6737 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6738 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6739 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6740}
6741
John Zulauf1686f232019-07-09 16:27:11 -06006742void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6743 VkImageLayout dstImageLayout, uint32_t regionCount,
6744 const VkBufferImageCopy *pRegions) {
6745 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6746
6747 auto cb_node = GetCBState(commandBuffer);
6748 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006749 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006750 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006751 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006752 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006753}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006754
Jeff Leger178b1e52020-10-05 12:22:23 -04006755void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6756 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6757 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6758
6759 auto cb_node = GetCBState(commandBuffer);
6760 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6761 // Make sure that all image slices are record referenced layout
6762 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6763 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6764 pCopyBufferToImageInfo2KHR->dstImageLayout);
6765 }
6766}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006767bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006768 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006769 bool skip = false;
6770 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6771
Dave Houlton1d960ff2018-01-19 12:17:05 -07006772 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006773 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6774 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6775 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006776 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6777 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006778 }
6779
John Zulaufa26d3c82019-08-14 16:09:08 -06006780 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006781 if (!image_entry) {
6782 return skip;
6783 }
6784
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006785 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6786 if (device_extensions.vk_ext_image_drm_format_modifier) {
6787 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6788 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006789 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6790 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6791 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006792 }
6793 } else {
6794 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006795 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6796 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006797 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006798 }
6799
Dave Houlton1d960ff2018-01-19 12:17:05 -07006800 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006801 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006802 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6803 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6804 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006805 }
6806
Dave Houlton1d960ff2018-01-19 12:17:05 -07006807 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006808 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006809 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6810 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6811 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006812 }
6813
Dave Houlton1d960ff2018-01-19 12:17:05 -07006814 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006815 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006816 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6817 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006818 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006819 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6820 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006821 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006822 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6823 }
6824 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006825 skip |= LogError(image, vuid,
6826 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6827 ") must be a single-plane specifier flag.",
6828 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006829 }
6830 } else if (FormatIsColor(img_format)) {
6831 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006832 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6833 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6834 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006835 }
6836 } else if (FormatIsDepthOrStencil(img_format)) {
6837 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6838 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006839 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006840 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6841 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6842 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6843 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006844 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6845 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6846 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006847 }
6848 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006849
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006850 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006851 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006852 }
6853
Mike Weiblen672b58b2017-02-21 14:32:53 -07006854 return skip;
6855}
sfricke-samsung022fa252020-07-24 03:26:16 -07006856
6857// Validates the image is allowed to be protected
6858bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006859 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006860 bool skip = false;
6861 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6862 LogObjectList objlist(cb_state->commandBuffer);
6863 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006864 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 -07006865 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006866 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006867 }
6868 return skip;
6869}
6870
6871// Validates the image is allowed to be unprotected
6872bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006873 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006874 bool skip = false;
6875 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6876 LogObjectList objlist(cb_state->commandBuffer);
6877 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006878 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 -07006879 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006880 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006881 }
6882 return skip;
6883}
6884
6885// Validates the buffer is allowed to be protected
6886bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006887 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006888 bool skip = false;
6889 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6890 LogObjectList objlist(cb_state->commandBuffer);
6891 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006892 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 -07006893 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006894 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006895 }
6896 return skip;
6897}
6898
6899// Validates the buffer is allowed to be unprotected
6900bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006901 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006902 bool skip = false;
6903 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6904 LogObjectList objlist(cb_state->commandBuffer);
6905 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006906 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 -07006907 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006908 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006909 }
6910 return skip;
6911}