blob: 03435aabf365b0173603b3c20f03b93e8b8c0b43 [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>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070029
30#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020031#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070032#include "vk_layer_data.h"
33#include "vk_layer_utils.h"
34#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060035#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070036
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070037#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070038#include "core_validation.h"
39#include "shader_validation.h"
40#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070041#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070042
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070043// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070044static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070045 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070046 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
47 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070048 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
49 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
50 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00193", // copy2 & !image_to_buffer
51 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00193", // copy2 & image_to_buffer
52 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070053 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070054 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
55 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
56 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01558",
57 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01558",
58 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070059 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070060 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
61 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
62 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01559",
63 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01559",
64 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070065 {"00197", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070066 "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
67 "VUID-vkCmdCopyImageToBuffer-imageOffset-00197",
68 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00197",
69 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
70 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070071 {"00198", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070072 "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
73 "VUID-vkCmdCopyImageToBuffer-imageOffset-00198",
74 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00198",
75 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00198",
76 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070077 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070078 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
79 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
80 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00199",
81 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00199",
82 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070083 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070084 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
85 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
86 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00200",
87 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00200",
88 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070089 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070090 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
91 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
92 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00201",
93 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00201",
94 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070095 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070096 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
97 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
98 "VUID-VkCopyBufferToImageInfo2KHR-bufferRowLength-00203",
99 "VUID-VkCopyImageToBufferInfo2KHR-bufferRowLength-00203",
100 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700101 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700102 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
103 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
104 "VUID-VkCopyBufferToImageInfo2KHR-bufferImageHeight-00204",
105 "VUID-VkCopyImageToBufferInfo2KHR-bufferImageHeight-00204",
106 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700107 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700108 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
109 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
110 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00205",
111 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00205",
112 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700113 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700114 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
115 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
116 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00206",
117 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00206",
118 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700119 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700120 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
121 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
122 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00207",
123 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00207",
124 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700125 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700126 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
127 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
128 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00208",
129 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00208",
130 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700131 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700132 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
133 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
134 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00209",
135 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00209",
136 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700137 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700138 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
139 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
140 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-00211",
141 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-00211",
142 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700143 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700144 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
145 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
146 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-01560",
147 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-01560",
148 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700149 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700150 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
151 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
152 "VUID-VkCopyBufferToImageInfo2KHR-baseArrayLayer-00213",
153 "VUID-VkCopyImageToBufferInfo2KHR-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800154 }},
155 {"04052", {
156 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
157 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
158 "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04052",
159 "VUID-VkCopyImageToBufferInfo2KHR-commandBuffer-04052",
160 }},
161 {"04053", {
162 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
163 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
164 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-04053",
165 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700166 }}
167 };
168 // clang-format on
169
170 uint8_t index = 0;
171 index |= (image_to_buffer) ? 0x1 : 0;
172 index |= (copy2) ? 0x2 : 0;
173 return copy_imagebuffer_vuid.at(id).at(index);
174}
175
David McFarland2853f2f2020-11-30 15:50:39 -0400176// Transfer VkImageSubresourceRange into VkImageSubresourceLayers struct
177static VkImageSubresourceLayers LayersFromRange(const VkImageSubresourceRange &subresource_range) {
178 VkImageSubresourceLayers subresource_layers;
179 subresource_layers.aspectMask = subresource_range.aspectMask;
180 subresource_layers.baseArrayLayer = subresource_range.baseArrayLayer;
181 subresource_layers.layerCount = subresource_range.layerCount;
182 subresource_layers.mipLevel = subresource_range.baseMipLevel;
183 return subresource_layers;
184}
185
John Zulauff660ad62019-03-23 07:16:05 -0600186// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
187static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
188 VkImageSubresourceRange subresource_range;
189 subresource_range.aspectMask = subresource_layers.aspectMask;
190 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
191 subresource_range.layerCount = subresource_layers.layerCount;
192 subresource_range.baseMipLevel = subresource_layers.mipLevel;
193 subresource_range.levelCount = 1;
194 return subresource_range;
195}
196
John Zulaufb58415b2019-12-09 15:02:32 -0700197static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
198 const auto format = create_info.format;
199 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200200
201#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700202 const VkExternalFormatANDROID *external_format_android = LvlFindInChain<VkExternalFormatANDROID>(&create_info);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700203 bool is_external_format_conversion = (external_format_android != nullptr && external_format_android->externalFormat != 0);
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200204#else
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700205 bool is_external_format_conversion = false;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200206#endif
207
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700208 if (FormatIsColor(format) || FormatIsMultiplane(format) || is_external_format_conversion) {
John Zulaufb58415b2019-12-09 15:02:32 -0700209 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
210 } else {
211 init_range.aspectMask =
212 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
213 }
214 return NormalizeSubresourceRange(create_info, init_range);
215}
216
locke-lunarg296a3c92020-03-25 01:04:29 -0600217IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -0600218 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -0700219 safe_create_info(pCreateInfo),
220 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -0600221 valid(false),
222 acquired(false),
223 shared_presentable(false),
224 layout_locked(false),
225 get_sparse_reqs_called(false),
226 sparse_metadata_required(false),
227 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -0600228 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700229 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -0600230 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700231 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -0600232 create_from_swapchain(VK_NULL_HANDLE),
233 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -0600234 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700235 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -0700236 disjoint(false),
237 plane0_memory_requirements_checked(false),
238 plane1_memory_requirements_checked(false),
239 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -0600240 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -0600241 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -0600242 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
unknown08c57af2019-06-21 16:33:35 -0600243 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600244 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700245 uint32_t *queue_family_indices = new uint32_t[createInfo.queueFamilyIndexCount];
John Zulauff660ad62019-03-23 07:16:05 -0600246 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700247 queue_family_indices[i] = pCreateInfo->pQueueFamilyIndices[i];
John Zulauff660ad62019-03-23 07:16:05 -0600248 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700249 createInfo.pQueueFamilyIndices = queue_family_indices;
John Zulauff660ad62019-03-23 07:16:05 -0600250 }
251
252 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
253 sparse = true;
254 }
Locked8af3732019-05-10 09:47:56 -0600255
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700256 auto *external_memory_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700257 if (external_memory_info) {
258 external_memory_handle = external_memory_info->handleTypes;
sfricke-samsunge2441192019-11-06 14:07:57 -0800259 }
John Zulauff660ad62019-03-23 07:16:05 -0600260}
261
unknown2c877272019-07-11 12:56:50 -0600262bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
263 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
264 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
265 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
266 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
267 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
268 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600269 return is_equal &&
270 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600271}
272
Jeff Bolz82f854d2019-09-17 14:56:47 -0500273// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
274bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
275 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
276 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
277 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
278 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
279 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600280 is_compatible = is_compatible &&
281 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
282 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500283
284 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
285 createInfo.extent.height <= other_createInfo.extent.height &&
286 createInfo.extent.depth <= other_createInfo.extent.depth &&
287 createInfo.arrayLayers <= other_createInfo.arrayLayers;
288 return is_compatible;
289}
290
unknown2c877272019-07-11 12:56:50 -0600291bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700292 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700293 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700294 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700295 }
locke-lunarg5f59e782019-12-19 10:32:23 -0700296 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
297 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600298 IsCreateInfoEqual(other_image_state->createInfo)) {
299 return true;
300 }
unknowne1661522019-07-11 13:04:18 -0600301 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
302 return true;
303 }
unknown2c877272019-07-11 12:56:50 -0600304 return false;
305}
306
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500307IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
308 : image_view(iv),
309 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700310 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600311 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500312 samplerConversion(VK_NULL_HANDLE),
313 image_state(im) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700314 auto *conversion_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700315 if (conversion_info) samplerConversion = conversion_info->conversion;
John Zulauff660ad62019-03-23 07:16:05 -0600316 if (image_state) {
317 // A light normalization of the createInfo range
318 auto &sub_res_range = create_info.subresourceRange;
319 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
320 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
321
322 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700323 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500324 samples = image_state->createInfo.samples;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200325
326 if (image_state->has_ahb_format) {
327 // When the image has a external format the views format must be VK_FORMAT_UNDEFINED and it is required to use a sampler
328 // Ycbcr conversion. Thus we can't extract any meaningful information from the format parameter. As a Sampler Ycbcr
329 // conversion must be used the shader type is always float.
330 descriptor_format_bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
331 } else {
332 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
333 }
John Zulauff660ad62019-03-23 07:16:05 -0600334 }
335}
336
locke-lunarg540b2252020-08-03 13:23:36 -0600337bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600338 if (image_view == compare_view.image_view) {
339 return true;
340 }
locke-lunargdc287022020-08-21 12:03:57 -0600341 if (image_state->image != compare_view.image_state->image) {
342 return false;
343 }
locke-lunarg540b2252020-08-03 13:23:36 -0600344 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
345 return false;
346 }
347
348 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600349 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600350 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600351 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600352 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600353 }
354
355 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600356 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600357 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600358 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600359 }
360
361 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600362 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600363 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600364 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600365 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600366 }
367
368 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600369 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600370 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600371 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600372 }
locke-lunargdc287022020-08-21 12:03:57 -0600373 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600374}
375
Dave Houltond9611312018-11-19 17:03:36 -0700376uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
377 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700378 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700379}
380
381uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
382
383uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
384
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500385bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700386 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700387 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700388
John Zulauf2076e812020-01-08 14:55:54 -0700389 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
390 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700391 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
392 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
393
John Zulauf2076e812020-01-08 14:55:54 -0700394 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
395
396 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
397 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700398 return false;
399 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700400
John Zulauf2076e812020-01-08 14:55:54 -0700401 for (auto entry : *layout_range_map) {
402 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700403 }
404 return true;
405}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700406
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600407// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600408void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600409 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
410 VkImageLayout expected_layout) {
411 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
412 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600413 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600414 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700415 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700416 for (const auto &image : image_state.aliasing_images) {
417 auto alias_state = GetImageState(image);
418 // The map state of the aliases should all be in sync, so no need to check the return value
419 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
420 assert(subresource_map);
421 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
422 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700423}
John Zulauff660ad62019-03-23 07:16:05 -0600424
425// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600426void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600427 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500428 return;
429 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500430 IMAGE_STATE *image_state = view_state.image_state.get();
431 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700432 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700433 for (const auto &image : image_state->aliasing_images) {
434 image_state = GetImageState(image);
435 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
436 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
437 }
John Zulauff660ad62019-03-23 07:16:05 -0600438}
439
440// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600441void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600442 const VkImageSubresourceRange &range, VkImageLayout layout) {
443 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
444 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600445 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700446 for (const auto &image : image_state.aliasing_images) {
447 auto alias_state = GetImageState(image);
448 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
449 assert(subresource_map);
450 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
451 }
John Zulauff660ad62019-03-23 07:16:05 -0600452}
453
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600454void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600455 VkImageLayout layout) {
456 const IMAGE_STATE *image_state = GetImageState(image);
457 if (!image_state) return;
458 SetImageInitialLayout(cb_node, *image_state, range, layout);
459};
460
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600461void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600462 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
463 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600464}
Dave Houltonddd65c52018-05-08 14:58:01 -0600465
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600466// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700467void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
468 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500469 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600470
John Zulauff660ad62019-03-23 07:16:05 -0600471 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600472 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
473 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600474 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 -0600475 sub_range.baseArrayLayer = 0;
476 sub_range.layerCount = image_state->createInfo.extent.depth;
477 }
478
Piers Daniell4fde9b72019-11-27 16:19:46 -0700479 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
480 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
481 SetImageLayout(cb_node, *image_state, sub_range, layout);
482 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
483 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
484 } else {
485 SetImageLayout(cb_node, *image_state, sub_range, layout);
486 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600487}
488
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700489bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
490 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700491 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600492 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100493 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700494 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100495 const char *vuid;
496 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700497 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100498
499 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600500 LogObjectList objlist(image);
501 objlist.add(renderpass);
502 objlist.add(framebuffer);
503 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700504 skip |=
505 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
506 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
507 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
508 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100509 return skip;
510 }
511
512 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700513 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200514 if (stencil_usage_info) {
515 image_usage |= stencil_usage_info->stencilUsage;
516 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100517
518 // Check for layouts that mismatch image usages in the framebuffer
519 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800520 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600521 LogObjectList objlist(image);
522 objlist.add(renderpass);
523 objlist.add(framebuffer);
524 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700525 skip |= LogError(objlist, vuid,
526 "%s: Layout/usage mismatch for attachment %u in %s"
527 " - the %s is %s but the image attached to %s via %s"
528 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
529 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
530 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
531 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100532 }
533
534 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
535 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800536 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600537 LogObjectList objlist(image);
538 objlist.add(renderpass);
539 objlist.add(framebuffer);
540 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700541 skip |= LogError(objlist, vuid,
542 "%s: Layout/usage mismatch for attachment %u in %s"
543 " - the %s is %s but the image attached to %s via %s"
544 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
545 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
546 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
547 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100548 }
549
550 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800551 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600552 LogObjectList objlist(image);
553 objlist.add(renderpass);
554 objlist.add(framebuffer);
555 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700556 skip |= LogError(objlist, vuid,
557 "%s: Layout/usage mismatch for attachment %u in %s"
558 " - the %s is %s but the image attached to %s via %s"
559 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
560 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
561 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
562 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100563 }
564
565 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800566 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600567 LogObjectList objlist(image);
568 objlist.add(renderpass);
569 objlist.add(framebuffer);
570 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700571 skip |= LogError(objlist, vuid,
572 "%s: Layout/usage mismatch for attachment %u in %s"
573 " - the %s is %s but the image attached to %s via %s"
574 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
575 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
576 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
577 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100578 }
579
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600580 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100581 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
582 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
583 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
584 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
585 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800586 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600587 LogObjectList objlist(image);
588 objlist.add(renderpass);
589 objlist.add(framebuffer);
590 objlist.add(image_view);
591 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700592 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700593 " - the %s is %s but the image attached to %s via %s"
594 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700595 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700596 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
597 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100598 }
599 } else {
600 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
601 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
602 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
603 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600604 LogObjectList objlist(image);
605 objlist.add(renderpass);
606 objlist.add(framebuffer);
607 objlist.add(image_view);
608 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700609 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700610 " - the %s is %s but the image attached to %s via %s"
611 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700612 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700613 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
614 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100615 }
616 }
617 return skip;
618}
619
John Zulauf17a01bb2019-08-09 16:41:19 -0600620bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700621 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600622 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600623 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700624 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
625 auto const &framebuffer_info = framebuffer_state->createInfo;
626 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100627
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700628 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100629 auto framebuffer = framebuffer_state->framebuffer;
630
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700631 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700632 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
633 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700634 }
John Zulauf8e308292018-09-21 11:34:37 -0600635
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700636 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800637 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700638 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100639 }
640
Tobias Hectorc9057422019-07-23 12:15:52 +0100641 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700642 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
643 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100644 auto image_view = attachments[i];
645 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100646
Tobias Hectorc9057422019-07-23 12:15:52 +0100647 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600648 LogObjectList objlist(pRenderPassBegin->renderPass);
649 objlist.add(framebuffer_state->framebuffer);
650 objlist.add(image_view);
651 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700652 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
653 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
654 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100655 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100656 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100657
658 const VkImage image = view_state->create_info.image;
659 const IMAGE_STATE *image_state = GetImageState(image);
660
661 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600662 LogObjectList objlist(pRenderPassBegin->renderPass);
663 objlist.add(framebuffer_state->framebuffer);
664 objlist.add(image_view);
665 objlist.add(image);
666 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700667 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
668 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
669 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100670 continue;
671 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700672 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
673 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100674
Piers Daniell7f894f62020-01-09 16:33:48 -0700675 // Default to expecting stencil in the same layout.
676 auto attachment_stencil_initial_layout = attachment_initial_layout;
677
678 // If a separate layout is specified, look for that.
679 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700680 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700681 if (attachment_description_stencil_layout) {
682 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
683 }
684
Tobias Hectorc9057422019-07-23 12:15:52 +0100685 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
686 // in common with the non-const version.)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700687 const ImageSubresourceLayoutMap *subresource_map = (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED)
688 ? GetImageSubresourceLayoutMap(const_p_cb, image)
689 : nullptr;
Tobias Hectorc9057422019-07-23 12:15:52 +0100690
691 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
692 LayoutUseCheckAndMessage layout_check(subresource_map);
693 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700694 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700695 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
696 // the next "constant value" range
697 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700698 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700699
John Zulauf5e617452019-11-19 14:44:16 -0700700 // Allow for differing depth and stencil layouts
701 VkImageLayout check_layout = attachment_initial_layout;
702 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
703
704 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700705 subres_skip |= LogError(
706 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700707 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
708 "and the %s layout of the attachment is %s. The layouts must match, or the render "
709 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700710 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100711 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700712 }
John Zulauf5e617452019-11-19 14:44:16 -0700713
Tobias Hectorc9057422019-07-23 12:15:52 +0100714 skip |= subres_skip;
715 }
716
717 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
718 framebuffer, render_pass, i, "initial layout");
719
720 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
721 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100722 }
723
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700724 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
725 auto &subpass = render_pass_info->pSubpasses[j];
726 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100727 auto &attachment_ref = subpass.pInputAttachments[k];
728 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
729 auto image_view = attachments[attachment_ref.attachment];
730 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100731
Tobias Hectorc9057422019-07-23 12:15:52 +0100732 if (view_state) {
733 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700734 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
735 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100736 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100737 }
738 }
739 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100740
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700741 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100742 auto &attachment_ref = subpass.pColorAttachments[k];
743 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
744 auto image_view = attachments[attachment_ref.attachment];
745 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100746
Tobias Hectorc9057422019-07-23 12:15:52 +0100747 if (view_state) {
748 auto image = view_state->create_info.image;
749 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
750 framebuffer, render_pass, attachment_ref.attachment,
751 "color attachment layout");
752 if (subpass.pResolveAttachments) {
753 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
754 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
755 attachment_ref.attachment, "resolve attachment layout");
756 }
757 }
758 }
759 }
760
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700761 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100762 auto &attachment_ref = *subpass.pDepthStencilAttachment;
763 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
764 auto image_view = attachments[attachment_ref.attachment];
765 auto view_state = GetImageViewState(image_view);
766
767 if (view_state) {
768 auto image = view_state->create_info.image;
769 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
770 framebuffer, render_pass, attachment_ref.attachment,
771 "input attachment layout");
772 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100773 }
774 }
775 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700776 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600777 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700778}
779
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600780void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700781 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700782 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinski8d46f802020-12-07 16:33:54 -0700783 IMAGE_VIEW_STATE *image_view = GetActiveAttachmentImageViewState(pCB, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600784 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700785 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700786 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700787 if (attachment_reference_stencil_layout) {
788 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
789 }
790
791 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600792 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700793 }
794}
795
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600796void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
797 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700798 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700799
800 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700801 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700802 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700803 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700804 }
805 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700806 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700807 }
808 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700809 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700810 }
811 }
812}
813
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700814// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
815// 1. Transition into initialLayout state
816// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600817void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700818 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700819 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700820 auto const rpci = render_pass_state->createInfo.ptr();
821 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -0700822 auto *view_state = GetActiveAttachmentImageViewState(cb_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600823 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700824 IMAGE_STATE *image_state = view_state->image_state.get();
825 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700826 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700827 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700828 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700829 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
830 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
831 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
832 SetImageInitialLayout(cb_state, *image_state, sub_range, initial_layout);
833 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
834 SetImageInitialLayout(cb_state, *image_state, sub_range, stencil_initial_layout);
835 } else {
836 SetImageInitialLayout(cb_state, *image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700837 }
John Zulauf8e308292018-09-21 11:34:37 -0600838 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700839 }
840 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700841 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700842}
843
Dave Houlton10b39482017-03-16 13:18:15 -0600844bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600845 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600846 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600847 }
848 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600849 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600850 }
851 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600852 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600853 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800854 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 -0700855 if (FormatPlaneCount(format) == 1) return false;
856 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600857 return true;
858}
859
Mike Weiblen62d08a32017-03-07 22:18:27 -0700860// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200861bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
862 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600863 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700864 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200865 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600866 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700867
868 switch (layout) {
869 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
870 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600871 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700872 }
873 break;
874 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
875 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600876 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700877 }
878 break;
879 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
880 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600881 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700882 }
883 break;
884 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
885 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600886 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700887 }
888 break;
889 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
890 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600891 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700892 }
893 break;
894 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
895 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600896 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700897 }
898 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600899 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500900 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
901 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
902 }
903 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700904 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
905 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
906 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
907 }
908 break;
909 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
910 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
911 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
912 }
913 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700914 default:
915 // Other VkImageLayout values do not have VUs defined in this context.
916 break;
917 }
918
Dave Houlton8e9f6542018-05-18 12:18:22 -0600919 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700920 skip |= LogError(img_barrier.image, msg_code,
921 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
922 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
923 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700924 }
925 return skip;
926}
927
928// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600929bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
930 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700931 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700932
Petr Krausad0096a2019-08-09 18:35:04 +0200933 // Scoreboard for checking for duplicate and inconsistent barriers to images
934 struct ImageBarrierScoreboardEntry {
935 uint32_t index;
936 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
937 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
938 const VkImageMemoryBarrier *barrier;
939 };
940 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
941 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
942
John Zulauf463c51e2018-05-31 13:29:20 -0600943 // Scoreboard for duplicate layout transition barriers within the list
944 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
945 ImageBarrierScoreboardImageMap layout_transitions;
946
Mike Weiblen62d08a32017-03-07 22:18:27 -0700947 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200948 const auto &img_barrier = pImageMemoryBarriers[i];
949 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700950
John Zulauf463c51e2018-05-31 13:29:20 -0600951 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
952 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
953 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200954 if (img_barrier.oldLayout != img_barrier.newLayout) {
955 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
956 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600957 if (image_it != layout_transitions.end()) {
958 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200959 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600960 if (subres_it != subres_map.end()) {
961 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200962 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
963 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
964 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700965 skip = LogError(
966 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200967 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600968 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
969 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200970 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
971 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
972 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600973 }
974 entry = new_entry;
975 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200976 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600977 }
978 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200979 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600980 }
981 }
982
Petr Krausad0096a2019-08-09 18:35:04 +0200983 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600984 if (image_state) {
985 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200986 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
987 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600988
989 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
990 if (image_state->layout_locked) {
991 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700992 skip |= LogError(
993 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700994 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600995 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700996 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200997 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600998 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600999
John Zulaufa4472282019-08-22 14:44:34 -06001000 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -07001001 const VkFormat image_format = image_create_info.format;
1002 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -06001003 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -07001004 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001005 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06001006 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1007 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001008 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
1009 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
1010 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1011 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001012 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001013 }
1014 } else {
1015 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1016 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -07001017 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
1018 ? "VUID-VkImageMemoryBarrier-image-03320"
1019 : "VUID-VkImageMemoryBarrier-image-01207";
1020 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001021 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
1022 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1023 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001024 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001025 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001026 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001027 }
John Zulauff660ad62019-03-23 07:16:05 -06001028
Petr Krausad0096a2019-08-09 18:35:04 +02001029 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1030 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001031 // TODO: Set memory invalid which is in mem_tracker currently
1032 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1033 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001034 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001035 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001036 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001037 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001038 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1039 // the next "constant value" range
1040 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001041 const auto &value = *pos;
1042 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001043 subres_skip = LogError(
1044 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001045 "%s: For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
John Zulauf5e617452019-11-19 14:44:16 -07001046 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001047 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -07001048 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1049 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001050 }
John Zulauf5e617452019-11-19 14:44:16 -07001051 }
John Zulauff660ad62019-03-23 07:16:05 -06001052 skip |= subres_skip;
1053 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001054
1055 // checks color format and (single-plane or non-disjoint)
1056 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1057 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001058 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001059 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1060 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
1061 ? "VUID-VkImageMemoryBarrier-image-01671"
1062 : "VUID-VkImageMemoryBarrier-image-02902";
1063 skip |= LogError(img_barrier.image, vuid,
1064 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1065 "but its aspectMask is 0x%" PRIx32 ".",
1066 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1067 string_VkFormat(image_format), aspect_mask);
1068 }
1069 }
1070
1071 VkImageAspectFlags valid_disjoint_mask =
1072 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 -07001073 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001074 ((aspect_mask & valid_disjoint_mask) == 0)) {
1075 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1076 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1077 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1078 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1079 string_VkFormat(image_format), aspect_mask);
1080 }
1081
1082 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1083 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1084 "%s: Image barrier %s references %s of format %s has only two planes but included "
1085 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1086 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1087 string_VkFormat(image_format), aspect_mask);
1088 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001089 }
1090 }
1091 return skip;
1092}
1093
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001094bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001095 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001096
Jeff Bolz6835fda2019-10-06 00:15:34 -05001097 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001098 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001099}
1100
John Zulauf6b4aae82018-05-09 13:03:36 -06001101template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001102bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1103 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001104 using BarrierRecord = QFOTransferBarrier<Barrier>;
1105 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001106 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001107 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1108 const char *barrier_name = BarrierRecord::BarrierName();
1109 const char *handle_name = BarrierRecord::HandleName();
1110 const char *transfer_type = nullptr;
1111 for (uint32_t b = 0; b < barrier_count; b++) {
1112 if (!IsTransferOp(&barriers[b])) continue;
1113 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001114 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001115 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001116 const auto found = barrier_sets.release.find(barriers[b]);
1117 if (found != barrier_sets.release.cend()) {
1118 barrier_record = &(*found);
1119 transfer_type = "releasing";
1120 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001121 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001122 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001123 const auto found = barrier_sets.acquire.find(barriers[b]);
1124 if (found != barrier_sets.acquire.cend()) {
1125 barrier_record = &(*found);
1126 transfer_type = "acquiring";
1127 }
1128 }
1129 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001130 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1131 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1132 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1133 func_name, barrier_name, b, transfer_type, handle_name,
1134 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1135 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001136 }
1137 }
1138 return skip;
1139}
1140
John Zulaufa4472282019-08-22 14:44:34 -06001141VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1142 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1143}
1144
1145const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1146 return device_state.GetImageState(barrier.image);
1147}
1148
1149VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1150 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1151}
1152
1153const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1154 return device_state.GetBufferState(barrier.buffer);
1155}
1156
1157VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1158
John Zulauf6b4aae82018-05-09 13:03:36 -06001159template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001160void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1161 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001162 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001163 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1164 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001165 auto &barrier = barriers[b];
1166 if (IsTransferOp(&barrier)) {
1167 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001168 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001169 barrier_sets.release.emplace(barrier);
1170 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001171 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001172 barrier_sets.acquire.emplace(barrier);
1173 }
1174 }
1175
1176 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1177 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1178 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1179 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1180 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1181 auto handle_state = BarrierHandleState(*this, barrier);
1182 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1183 if (!mode_concurrent) {
1184 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001185 cb_state->queue_submit_functions.emplace_back(
1186 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1187 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1188 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1189 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001190 });
1191 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001192 }
1193 }
1194}
1195
John Zulaufa4472282019-08-22 14:44:34 -06001196bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001197 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001198 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001199 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001200 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001201 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1202 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001203 return skip;
1204}
1205
John Zulaufa4472282019-08-22 14:44:34 -06001206void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1207 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1208 const VkImageMemoryBarrier *pImageMemBarriers) {
1209 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1210 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001211}
1212
1213template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001214bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001215 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001216 // Record to the scoreboard or report that we have a duplication
1217 bool skip = false;
1218 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1219 if (!inserted.second && inserted.first->second != cb_state) {
1220 // 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 -06001221 LogObjectList objlist(cb_state->commandBuffer);
1222 objlist.add(barrier.handle);
1223 objlist.add(inserted.first->second->commandBuffer);
1224 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001225 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1226 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1227 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1228 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1229 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001230 }
1231 return skip;
1232}
1233
1234template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001235bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1236 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001237 using BarrierRecord = QFOTransferBarrier<Barrier>;
1238 using TypeTag = typename BarrierRecord::Tag;
1239 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001240 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001241 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001242 const char *barrier_name = BarrierRecord::BarrierName();
1243 const char *handle_name = BarrierRecord::HandleName();
1244 // No release should have an extant duplicate (WARNING)
1245 for (const auto &release : cb_barriers.release) {
1246 // Check the global pending release barriers
1247 const auto set_it = global_release_barriers.find(release.handle);
1248 if (set_it != global_release_barriers.cend()) {
1249 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1250 const auto found = set_for_handle.find(release);
1251 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001252 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1253 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1254 " to dstQueueFamilyIndex %" PRIu32
1255 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1256 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1257 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001258 }
1259 }
1260 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1261 }
1262 // Each acquire must have a matching release (ERROR)
1263 for (const auto &acquire : cb_barriers.acquire) {
1264 const auto set_it = global_release_barriers.find(acquire.handle);
1265 bool matching_release_found = false;
1266 if (set_it != global_release_barriers.cend()) {
1267 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1268 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1269 }
1270 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001271 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1272 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1273 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1274 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1275 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001276 }
1277 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1278 }
1279 return skip;
1280}
1281
John Zulauf3b04ebd2019-07-18 14:08:11 -06001282bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001283 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001284 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001285 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001286 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1287 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001288 return skip;
1289}
1290
1291template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001292void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001293 using BarrierRecord = QFOTransferBarrier<Barrier>;
1294 using TypeTag = typename BarrierRecord::Tag;
1295 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001296 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001297
1298 // Add release barriers from this submit to the global map
1299 for (const auto &release : cb_barriers.release) {
1300 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1301 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1302 global_release_barriers[release.handle].insert(release);
1303 }
1304
1305 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1306 for (const auto &acquire : cb_barriers.acquire) {
1307 // NOTE: We're not using [] because we don't want to create entries for missing releases
1308 auto set_it = global_release_barriers.find(acquire.handle);
1309 if (set_it != global_release_barriers.end()) {
1310 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1311 set_for_handle.erase(acquire);
1312 if (set_for_handle.size() == 0) { // Clean up empty sets
1313 global_release_barriers.erase(set_it);
1314 }
1315 }
1316 }
1317}
1318
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001319void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001320 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1321 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001322}
1323
John Zulauf6b4aae82018-05-09 13:03:36 -06001324// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001325void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001326
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001327void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001328 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001329 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001330 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001331
Chris Forbes4de4b132017-08-21 11:27:08 -07001332 // For ownership transfers, the barrier is specified twice; as a release
1333 // operation on the yielding queue family, and as an acquire operation
1334 // on the acquiring queue family. This barrier may also include a layout
1335 // transition, which occurs 'between' the two operations. For validation
1336 // purposes it doesn't seem important which side performs the layout
1337 // transition, but it must not be performed twice. We'll arbitrarily
1338 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001339 //
1340 // However, we still need to record initial layout for the "initial layout" validation
1341 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001342
Petr Krausad0096a2019-08-09 18:35:04 +02001343 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001344 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001345 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001346 }
1347}
1348
unknown86bcb3a2019-07-11 13:05:36 -06001349void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001350 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001351 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1352 const auto &image_create_info = image_state->createInfo;
1353
Mike Schuchardt2df08912020-12-15 16:28:09 -08001354 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag bit, where <extent.depth> and
unknown86bcb3a2019-07-11 13:05:36 -06001355 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1356 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001357 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001358 normalized_isr.baseArrayLayer = 0;
1359 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1360 }
1361
Michael Spang8af7c102020-05-03 20:50:09 -04001362 VkImageLayout initial_layout = mem_barrier.oldLayout;
1363
1364 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001365 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001366 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1367 }
1368
John Zulauf2be3fe02019-12-30 09:48:02 -07001369 if (is_release_op) {
1370 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1371 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001372 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001373 }
unknown86bcb3a2019-07-11 13:05:36 -06001374}
1375
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001376bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1377 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1378 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1379 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001380 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001381 assert(cb_node);
1382 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001383 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001384 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001385
John Zulauff660ad62019-03-23 07:16:05 -06001386 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1387 if (subresource_map) {
1388 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001389 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001390 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1391 // the next "constant value" range
1392 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001393 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001394 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001395 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1396 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1397 "%s layout %s.",
1398 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1399 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1400 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001401 }
John Zulauf5e617452019-11-19 14:44:16 -07001402 }
John Zulauff660ad62019-03-23 07:16:05 -06001403 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001404 }
John Zulauff660ad62019-03-23 07:16:05 -06001405
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001406 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1407 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1408 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001409 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1410 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001411 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1412 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1413 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001414 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001415 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001416 if (image_state->shared_presentable) {
1417 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001418 skip |=
1419 LogError(device, layout_invalid_msg_code,
1420 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1421 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001422 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001423 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001424 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001425 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001426 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1427 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1428 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1429 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001430 }
1431 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001432 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001433}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001434bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001435 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1436 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001437 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001438 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1439 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1440}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001441
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001442void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001443 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001444 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1445 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001446
Mike Schuchardt2df08912020-12-15 16:28:09 -08001447 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001448 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001449 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001450 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001451 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001452 VkImageLayout stencil_layout = kInvalidLayout;
1453 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001454 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001455 if (attachment_description_stencil_layout) {
1456 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1457 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001458 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001459 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001460 }
1461 }
1462}
Dave Houltone19e20d2018-02-02 16:32:41 -07001463
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001464#ifdef VK_USE_PLATFORM_ANDROID_KHR
1465// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1466// This could also move into a seperate core_validation_android.cpp file... ?
1467
1468//
1469// AHB-specific validation within non-AHB APIs
1470//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001471bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001472 bool skip = false;
1473
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001474 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001475 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001476 if (0 != ext_fmt_android->externalFormat) {
1477 if (VK_FORMAT_UNDEFINED != create_info->format) {
1478 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001479 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1480 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1481 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001482 }
1483
1484 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001485 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1486 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1487 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001488 }
1489
1490 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001491 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1492 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001493 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1494 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1495 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001496 }
1497
1498 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001499 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1500 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1501 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001502 }
1503 }
1504
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001505 if ((0 != ext_fmt_android->externalFormat) &&
1506 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001507 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001508 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1509 ") which has "
1510 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1511 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001512 }
1513 }
1514
Dave Houltond9611312018-11-19 17:03:36 -07001515 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001516 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001517 skip |=
1518 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1519 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1520 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001521 }
1522 }
1523
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001524 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001525 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1526 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001527 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001528 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1529 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1530 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1531 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001532 }
1533
1534 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001535 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1536 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1537 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1538 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1539 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001540 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001541 }
1542
1543 return skip;
1544}
1545
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001546bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001547 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001548 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001549
1550 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001551 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001552 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1553 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001554 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001555 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001556 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001557
Dave Houltond9611312018-11-19 17:03:36 -07001558 // Chain must include a compatible ycbcr conversion
1559 bool conv_found = false;
1560 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001561 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001562 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001563 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001564 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001565 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001566 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001567 }
Dave Houltond9611312018-11-19 17:03:36 -07001568 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001569 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001570 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001571 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1572 "an externalFormat (%" PRIu64
1573 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1574 "with the same external format.",
1575 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001576 }
1577
1578 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001579 if (IsIdentitySwizzle(create_info->components) == false) {
1580 skip |= LogError(
1581 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1582 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1583 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1584 "= %s.",
1585 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1586 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001587 }
1588 }
Dave Houltond9611312018-11-19 17:03:36 -07001589
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001590 return skip;
1591}
1592
John Zulaufa26d3c82019-08-14 16:09:08 -06001593bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001594 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001595
John Zulaufa26d3c82019-08-14 16:09:08 -06001596 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001597 if (image_state != nullptr) {
1598 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1599 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1600 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1601 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1602 "bound to memory.");
1603 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001604 }
1605 return skip;
1606}
1607
1608#else
1609
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001610bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001611 return false;
1612}
1613
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001614bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001615
John Zulaufa26d3c82019-08-14 16:09:08 -06001616bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001617
1618#endif // VK_USE_PLATFORM_ANDROID_KHR
1619
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001620bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1621 bool skip = false;
1622
1623 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1624 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1625 const VkImageTiling image_tiling = pCreateInfo->tiling;
1626 const VkFormat image_format = pCreateInfo->format;
1627
1628 if (image_format == VK_FORMAT_UNDEFINED) {
1629 // VU 01975 states format can't be undefined unless an android externalFormat
1630#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001631 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001632 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1633 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1634 if (it != ahb_ext_formats_map.end()) {
1635 tiling_features = it->second;
1636 }
1637 }
1638#endif
1639 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1640 uint64_t drm_format_modifier = 0;
1641 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001642 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001643 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001644 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001645
1646 if (drm_explicit != nullptr) {
1647 drm_format_modifier = drm_explicit->drmFormatModifier;
1648 } else {
1649 // VUID 02261 makes sure its only explict or implict in parameter checking
1650 assert(drm_implicit != nullptr);
1651 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1652 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1653 }
1654 }
1655
1656 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1657 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1658 nullptr};
1659 format_properties_2.pNext = (void *)&drm_properties_list;
1660 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001661 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1662 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1663 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1664 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001665
1666 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1667 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1668 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1669 }
1670 }
1671 } else {
1672 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1673 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1674 : format_properties.optimalTilingFeatures;
1675 }
1676
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001677 // Lack of disjoint format feature support while using the flag
1678 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1679 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1680 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1681 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1682 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1683 string_VkFormat(pCreateInfo->format));
1684 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001685
1686 return skip;
1687}
1688
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001689bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001690 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001691 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001692
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001693 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001694 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001695 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1696 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001697 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1698 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001699 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001700 }
1701
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001702 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1703 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001704 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1705 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1706 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001707 }
1708
1709 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001710 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1711 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1712 "height (%d) and arrayLayers (%d) must be >= 6.",
1713 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001714 }
Dave Houlton130c0212018-01-29 13:39:56 -07001715 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001716
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001717 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001718 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1719 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1720 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001721 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001722 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1723 "device maxFramebufferWidth (%u).",
1724 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001725 }
1726
1727 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001728 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001729 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1730 "device maxFramebufferHeight (%u).",
1731 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001732 }
1733
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001734 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001735 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1736 static_cast<float>(device_limits->maxFramebufferWidth) /
1737 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001738 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1739 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001740 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1741 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1742 "ceiling of device "
1743 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1744 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1745 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001746 }
1747
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001748 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1749 static_cast<float>(device_limits->maxFramebufferHeight) /
1750 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001751 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1752 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001753 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1754 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1755 "ceiling of device "
1756 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1757 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1758 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001759 }
1760 }
1761
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001762 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001763 VkResult result = VK_SUCCESS;
1764 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1765 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1766 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1767 &format_limits);
1768 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001769 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1770 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001771 if (modifier_list) {
1772 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001773 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001774 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001775 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001776 image_format_info.type = pCreateInfo->imageType;
1777 image_format_info.format = pCreateInfo->format;
1778 image_format_info.tiling = pCreateInfo->tiling;
1779 image_format_info.usage = pCreateInfo->usage;
1780 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001781 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001782
1783 result =
1784 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1785 format_limits = image_format_properties.imageFormatProperties;
1786
1787 /* The application gives a list of modifier and the driver
1788 * selects one. If one is wrong, stop there.
1789 */
1790 if (result != VK_SUCCESS) break;
1791 }
1792 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001793 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001794 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001795 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001796 image_format_info.type = pCreateInfo->imageType;
1797 image_format_info.format = pCreateInfo->format;
1798 image_format_info.tiling = pCreateInfo->tiling;
1799 image_format_info.usage = pCreateInfo->usage;
1800 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001801 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001802
1803 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1804 format_limits = image_format_properties.imageFormatProperties;
1805 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001806 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001807
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001808 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1809 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1810 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1811 if (result != VK_SUCCESS) {
1812 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001813#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001814 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001815#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001816 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001817 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001818 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1819 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001820#ifdef VK_USE_PLATFORM_ANDROID_KHR
1821 }
1822#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001823 } else {
1824 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1825 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001826 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1827 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1828 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001829 }
Dave Houlton130c0212018-01-29 13:39:56 -07001830
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001831 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1832 static_cast<uint64_t>(pCreateInfo->extent.height) *
1833 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1834 static_cast<uint64_t>(pCreateInfo->samples);
1835 uint64_t total_size =
1836 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07001837
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001838 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001839 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1840 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001841 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001842
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001843 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001844 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1845 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1846 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1847 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001848 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001849
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001850 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001851 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1852 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1853 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001854 }
1855
1856 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001857 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1858 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1859 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001860 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001861
1862 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1863 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1864 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1865 pCreateInfo->extent.width, format_limits.maxExtent.width);
1866 }
1867
1868 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1869 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1870 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1871 pCreateInfo->extent.height, format_limits.maxExtent.height);
1872 }
1873
1874 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1875 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1876 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1877 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1878 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001879 }
1880
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001881 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001882 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1883 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1884 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1885 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001886 skip |= LogError(device, error_vuid,
1887 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1888 "YCbCr Conversion format, arrayLayers must be 1",
1889 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001890 }
1891
1892 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001893 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1894 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1895 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001896 }
1897
1898 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001899 skip |= LogError(
1900 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001901 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1902 string_VkSampleCountFlagBits(pCreateInfo->samples));
1903 }
1904
1905 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001906 skip |= LogError(
1907 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001908 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1909 string_VkImageType(pCreateInfo->imageType));
1910 }
1911 }
1912
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001913 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001914 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001915 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001916 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001917 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1918 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1919 "format must be block, ETC or ASTC compressed, but is %s",
1920 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001921 }
1922 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001923 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1924 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1925 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001926 }
1927 }
1928 }
1929
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001930 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001931 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1932 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1933 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001934 }
1935
unknown2c877272019-07-11 12:56:50 -06001936 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1937 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1938 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001939 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1940 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1941 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001942 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001943
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001944 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001945 if (swapchain_create_info != nullptr) {
1946 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1947 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1948 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1949
1950 // Validate rest of Swapchain Image create check that require swapchain state
1951 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1952 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1953 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1954 skip |= LogError(
1955 device, vuid,
1956 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1957 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1958 }
1959 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1960 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1961 skip |= LogError(device, vuid,
1962 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1963 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1964 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08001965 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001966 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1967 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1968 skip |= LogError(device, vuid,
1969 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1970 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08001971 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001972 }
1973 }
1974 }
1975
sfricke-samsungedce77a2020-07-03 22:35:13 -07001976 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1977 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1978 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1979 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1980 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1981 }
1982 const VkImageCreateFlags invalid_flags =
1983 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1984 if ((pCreateInfo->flags & invalid_flags) != 0) {
1985 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1986 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1987 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1988 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1989 }
1990 }
1991
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001992 skip |= ValidateImageFormatFeatures(pCreateInfo);
1993
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07001994 // Check compatibility with VK_KHR_portability_subset
1995 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
1996 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
1997 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
1998 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
1999 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2000 }
2001 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2002 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2003 skip |=
2004 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2005 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2006 }
2007 }
2008
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002009 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002010}
2011
John Zulauf7eeb6f72019-06-17 11:56:36 -06002012void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2013 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2014 if (VK_SUCCESS != result) return;
2015
2016 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002017 auto image_state = Get<IMAGE_STATE>(*pImage);
2018 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002019}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002020
Jeff Bolz5c801d12019-10-09 10:38:45 -05002021bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002022 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06002023 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002024 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002025 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002026 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002027 }
2028 return skip;
2029}
2030
John Zulauf7eeb6f72019-06-17 11:56:36 -06002031void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2032 // Clean up validation specific data
2033 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002034
locke-lunargcba7d5f2019-12-30 16:59:11 -07002035 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002036
2037 // Clean up generic image state
2038 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002039}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002040
sfricke-samsungcd924d92020-05-20 23:51:17 -07002041bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2042 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002043 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002044 const VkImage image = image_state->image;
2045 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002046
2047 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002048 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2049 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002050 }
2051
sfricke-samsungcd924d92020-05-20 23:51:17 -07002052 if (FormatIsDepthOrStencil(format)) {
2053 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2054 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2055 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2056 } else if (FormatIsCompressed(format)) {
2057 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2058 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2059 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002060 }
2061
2062 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002063 skip |=
2064 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2065 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2066 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002067 }
2068 return skip;
2069}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002070
John Zulauf07288512019-07-05 11:09:50 -06002071bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2072 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2073 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002074 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002075 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2076 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002077 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2078 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2079 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002080 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002081
2082 } else {
2083 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2084 if (!device_extensions.vk_khr_shared_presentable_image) {
2085 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002086 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2087 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2088 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002089 }
2090 } else {
2091 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2092 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002093 skip |= LogError(
2094 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002095 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2096 func_name, string_VkImageLayout(dest_image_layout));
2097 }
2098 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002099 }
2100
John Zulauff660ad62019-03-23 07:16:05 -06002101 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002102 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002103 if (subresource_map) {
2104 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002105 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002106 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002107 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2108 // the next "constant value" range
2109 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002110 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002111 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2112 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2113 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2114 } else {
2115 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002116 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002117 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2118 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2119 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2120 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002121 }
John Zulauf5e617452019-11-19 14:44:16 -07002122 }
John Zulauff660ad62019-03-23 07:16:05 -06002123 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002124 }
2125
2126 return skip;
2127}
2128
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002129bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2130 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002131 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002132 bool skip = false;
2133 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002134 const auto *cb_node = GetCBState(commandBuffer);
2135 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002136 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002137 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002138 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002139 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002140 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002141 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002142 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2143 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002144 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002145 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002146 skip |=
2147 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2148 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2149 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002150 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002151 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002152 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002153 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002154 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002155 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002156 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2157 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2158 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2159 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2160 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2161 string_VkFormat(image_state->createInfo.format));
2162 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002163 }
2164 return skip;
2165}
2166
John Zulaufeabb4462019-07-05 14:13:03 -06002167void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2168 const VkClearColorValue *pColor, uint32_t rangeCount,
2169 const VkImageSubresourceRange *pRanges) {
2170 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2171
2172 auto cb_node = GetCBState(commandBuffer);
2173 auto image_state = GetImageState(image);
2174 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002175 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002176 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002177 }
2178 }
2179}
2180
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002181bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2182 const char *apiName) const {
2183 bool skip = false;
2184
2185 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2186 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2187 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2188 // Also VUID-VkClearDepthStencilValue-depth-00022
2189 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2190 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2191 "(=%f) is not within the [0.0, 1.0] range.",
2192 apiName, clearValue.depth);
2193 }
2194 }
2195
2196 return skip;
2197}
2198
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002199bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2200 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002201 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002202 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002203
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002204 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002205 const auto *cb_node = GetCBState(commandBuffer);
2206 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002207 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002208 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002209 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002210 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002211 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002212 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002213 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002214 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002215 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002216 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002217 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002218 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002219 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002220 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2221 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2222 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2223 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002224
2225 bool any_include_aspect_depth_bit = false;
2226 bool any_include_aspect_stencil_bit = false;
2227
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002228 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002229 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002230 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002231 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002232 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002233 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2234 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002235 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2236 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2237 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2238 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002239 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002240 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2241 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002242 if (FormatHasDepth(image_format) == false) {
2243 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2244 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2245 "doesn't have a depth component.",
2246 i, string_VkFormat(image_format));
2247 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002248 }
2249 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2250 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002251 if (FormatHasStencil(image_format) == false) {
2252 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2253 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2254 "%s doesn't have a stencil component.",
2255 i, string_VkFormat(image_format));
2256 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002257 }
2258 }
2259 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002260 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002261 if (image_stencil_struct != nullptr) {
2262 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2263 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002264 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2265 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2266 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2267 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002268 }
2269 } else {
2270 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002271 skip |= LogError(
2272 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002273 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2274 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2275 "in VkImageCreateInfo::usage used to create image");
2276 }
2277 }
2278 }
2279 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002280 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2281 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2282 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002283 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002284 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002285 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2286 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002287 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002288 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002289 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002290 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2291 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2292 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2293 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002294 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002295 }
2296 return skip;
2297}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002298
John Zulaufeabb4462019-07-05 14:13:03 -06002299void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2300 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2301 const VkImageSubresourceRange *pRanges) {
2302 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2303 auto cb_node = GetCBState(commandBuffer);
2304 auto image_state = GetImageState(image);
2305 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002306 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002307 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002308 }
2309 }
2310}
2311
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002312// Returns true if [x, xoffset] and [y, yoffset] overlap
2313static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2314 bool result = false;
2315 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2316 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2317
2318 if (intersection_max > intersection_min) {
2319 result = true;
2320 }
2321 return result;
2322}
2323
Jeff Leger178b1e52020-10-05 12:22:23 -04002324// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002325// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002326template <typename RegionType>
2327static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002328 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002329
Dave Houltonc991cc92018-03-06 11:08:51 -07002330 // Separate planes within a multiplane image cannot intersect
2331 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002332 return result;
2333 }
2334
Dave Houltonc991cc92018-03-06 11:08:51 -07002335 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2336 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2337 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002338 result = true;
2339 switch (type) {
2340 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002341 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002342 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002343 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002344 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002345 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002346 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002347 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002348 break;
2349 default:
2350 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2351 assert(false);
2352 }
2353 }
2354 return result;
2355}
2356
Dave Houltonfc1a4052017-04-27 14:32:45 -06002357// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002358static const uint32_t kXBit = 1;
2359static const uint32_t kYBit = 2;
2360static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002361static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002362 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002363 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002364 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2365 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002366 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002367 }
2368 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2369 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002370 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002371 }
2372 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2373 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002374 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002375 }
2376 return result;
2377}
2378
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002379// Test if two VkExtent3D structs are equivalent
2380static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2381 bool result = true;
2382 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2383 (extent->depth != other_extent->depth)) {
2384 result = false;
2385 }
2386 return result;
2387}
2388
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002389// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002390static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002391 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2392}
2393
2394// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002395VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002396 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2397 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002398 auto pool = cb_node->command_pool.get();
2399 if (pool) {
2400 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002401 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002402 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002403 granularity.width *= block_size.width;
2404 granularity.height *= block_size.height;
2405 }
2406 }
2407 return granularity;
2408}
2409
2410// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2411static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2412 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002413 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2414 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002415 valid = false;
2416 }
2417 return valid;
2418}
2419
2420// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002421bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002422 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002423 bool skip = false;
2424 VkExtent3D offset_extent = {};
2425 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2426 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2427 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002428 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002429 // 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 -07002430 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002431 skip |= LogError(cb_node->commandBuffer, vuid,
2432 "%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 "
2433 "image transfer granularity is (w=0, h=0, d=0).",
2434 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002435 }
2436 } else {
2437 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2438 // integer multiples of the image transfer granularity.
2439 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002440 skip |= LogError(cb_node->commandBuffer, vuid,
2441 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2442 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2443 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2444 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002445 }
2446 }
2447 return skip;
2448}
2449
2450// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002451bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002452 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002453 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002454 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002455 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002456 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2457 // subresource extent.
2458 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002459 skip |= LogError(cb_node->commandBuffer, vuid,
2460 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2461 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2462 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2463 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002464 }
2465 } else {
2466 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2467 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2468 // subresource extent dimensions.
2469 VkExtent3D offset_extent_sum = {};
2470 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2471 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2472 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002473 bool x_ok = true;
2474 bool y_ok = true;
2475 bool z_ok = true;
2476 switch (image_type) {
2477 case VK_IMAGE_TYPE_3D:
2478 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2479 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002480 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002481 case VK_IMAGE_TYPE_2D:
2482 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2483 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002484 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002485 case VK_IMAGE_TYPE_1D:
2486 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2487 (subresource_extent->width == offset_extent_sum.width));
2488 break;
2489 default:
2490 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2491 assert(false);
2492 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002493 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002494 skip |=
2495 LogError(cb_node->commandBuffer, vuid,
2496 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2497 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2498 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2499 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2500 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2501 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002502 }
2503 }
2504 return skip;
2505}
2506
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002507bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002508 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002509 bool skip = false;
2510 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002511 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2512 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002513 }
2514 return skip;
2515}
2516
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002517bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002518 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002519 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002520 bool skip = false;
2521 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2522 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002523 skip |= LogError(cb_node->commandBuffer, vuid,
2524 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2525 "%u, but provided %s has %u array layers.",
2526 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2527 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002528 }
2529 return skip;
2530}
2531
Jeff Leger178b1e52020-10-05 12:22:23 -04002532// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2533template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002534bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002535 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002536 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002537 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002538 VkExtent3D granularity = GetScaledItg(cb_node, img);
2539 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002540 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002541 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002542 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002543 return skip;
2544}
2545
Jeff Leger178b1e52020-10-05 12:22:23 -04002546// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2547template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002548bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002549 const IMAGE_STATE *dst_img, const RegionType *region,
2550 const uint32_t i, const char *function,
2551 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002552 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002553 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2554 const char *vuid;
2555
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002556 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002557 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002558 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2559 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002560 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002561 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002562 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002563 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002564 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002565
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002566 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002567 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002568 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2569 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002570 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002571 const VkExtent3D dest_effective_extent =
2572 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002573 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002574 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002575 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002576 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002577 return skip;
2578}
2579
Jeff Leger178b1e52020-10-05 12:22:23 -04002580// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2581template <typename ImageCopyRegionType>
2582bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2583 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2584 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002585 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002586 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2587 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2588 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002589
2590 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002591 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002592
2593 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002594 const VkExtent3D src_copy_extent = region.extent;
2595 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002596 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2597
Dave Houlton6f9059e2017-05-02 17:15:13 -06002598 bool slice_override = false;
2599 uint32_t depth_slices = 0;
2600
2601 // Special case for copying between a 1D/2D array and a 3D image
2602 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2603 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002604 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002605 slice_override = (depth_slices != 1);
2606 } 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 -07002607 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002608 slice_override = (depth_slices != 1);
2609 }
2610
2611 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002612 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002613 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002614 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2615 skip |= LogError(src_state->image, vuid,
2616 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2617 "be 0 and 1, respectively.",
2618 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002619 }
2620 }
2621
Dave Houlton533be9f2018-03-26 17:08:30 -06002622 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 -04002623 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2624 skip |= LogError(src_state->image, vuid,
2625 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002626 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002627 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002628 }
2629
Dave Houlton533be9f2018-03-26 17:08:30 -06002630 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002631 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2632 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2633 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002634 }
2635
Dave Houltonc991cc92018-03-06 11:08:51 -07002636 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002637 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002638 if (FormatIsCompressed(src_state->createInfo.format) ||
2639 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002640 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002641 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002642 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2643 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2644 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002645 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002646 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002647 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002648 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002649 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002650 }
2651
Dave Houlton94a00372017-12-14 15:08:47 -07002652 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002653 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2654 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002655 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2656 skip |= LogError(src_state->image, vuid,
2657 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2658 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2659 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002660 }
2661
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002662 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002663 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2664 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002665 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2666 skip |= LogError(src_state->image, vuid,
2667 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2668 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2669 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002670 }
2671
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002672 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002673 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2674 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002675 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2676 skip |= LogError(src_state->image, vuid,
2677 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2678 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2679 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002680 }
2681 } // Compressed
2682
2683 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002684 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002685 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002686 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2687 skip |= LogError(dst_state->image, vuid,
2688 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002689 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002690 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002691 }
2692 }
2693
Dave Houlton533be9f2018-03-26 17:08:30 -06002694 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 -04002695 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2696 skip |= LogError(dst_state->image, vuid,
2697 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2698 "and 1, respectively.",
2699 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002700 }
2701
Dave Houlton533be9f2018-03-26 17:08:30 -06002702 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002703 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2704 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2705 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002706 }
2707
sfricke-samsung30b094c2020-05-30 11:42:11 -07002708 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002709 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002710 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2711 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002712 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2713 skip |= LogError(src_state->image, vuid,
2714 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2715 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2716 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002717 }
2718 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002719 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002720 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002721 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2722 skip |= LogError(dst_state->image, vuid,
2723 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2724 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2725 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002726 }
2727 }
2728 } else { // Pre maint 1
2729 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002730 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002731 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2732 skip |= LogError(src_state->image, vuid,
2733 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002734 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2735 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002736 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002737 }
Dave Houltonee281a52017-12-08 13:51:02 -07002738 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002739 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2740 skip |= LogError(dst_state->image, vuid,
2741 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002742 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2743 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002744 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002745 }
2746 }
2747 }
2748
Dave Houltonc991cc92018-03-06 11:08:51 -07002749 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2750 if (FormatIsCompressed(dst_state->createInfo.format) ||
2751 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002752 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002753
2754 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002755 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2756 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2757 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002758 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002759 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002760 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002761 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002762 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002763 }
2764
Dave Houlton94a00372017-12-14 15:08:47 -07002765 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002766 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2767 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002768 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2769 skip |= LogError(dst_state->image, vuid,
2770 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2771 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2772 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002773 }
2774
Dave Houltonee281a52017-12-08 13:51:02 -07002775 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2776 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2777 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002778 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002779 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002780 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002781 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2782 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002783 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002784 }
2785
Dave Houltonee281a52017-12-08 13:51:02 -07002786 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2787 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2788 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002789 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2790 skip |= LogError(dst_state->image, vuid,
2791 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2792 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2793 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002794 }
2795 } // Compressed
2796 }
2797 return skip;
2798}
2799
Jeff Leger178b1e52020-10-05 12:22:23 -04002800template <typename RegionType>
2801bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2802 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2803 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002804 const auto *cb_node = GetCBState(commandBuffer);
2805 const auto *src_image_state = GetImageState(srcImage);
2806 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002807 const VkFormat src_format = src_image_state->createInfo.format;
2808 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002809 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002810 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002811
Jeff Leger178b1e52020-10-05 12:22:23 -04002812 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2813 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2814 const char *vuid;
2815
2816 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002817
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002818 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2819
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002820 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002821 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002822
2823 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2824 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002825 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002826
Dave Houlton6f9059e2017-05-02 17:15:13 -06002827 bool slice_override = false;
2828 uint32_t depth_slices = 0;
2829
2830 // Special case for copying between a 1D/2D array and a 3D image
2831 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2832 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2833 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002834 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002835 slice_override = (depth_slices != 1);
2836 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2837 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002838 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002839 slice_override = (depth_slices != 1);
2840 }
2841
Jeff Leger178b1e52020-10-05 12:22:23 -04002842 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2843 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2844 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2845 skip |=
2846 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2847 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2848 skip |=
2849 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2850 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002851 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002852 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2853 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002854 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002855 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002856
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002857 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002858 // No chance of mismatch if we're overriding depth slice count
2859 if (!slice_override) {
2860 // The number of depth slices in srcSubresource and dstSubresource must match
2861 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2862 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002863 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2864 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002865 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002866 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2867 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002868 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002869 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2870 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002871 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2872 "do not match.",
2873 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002874 }
2875 }
2876 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002877 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002878 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002879 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002880 skip |=
2881 LogError(command_buffer, vuid,
2882 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2883 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002884 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002885 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002886
Dave Houltonc991cc92018-03-06 11:08:51 -07002887 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002888 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002889 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2890 // If neither image is multi-plane the aspectMask member of src and dst must match
2891 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2892 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2893 skip |= LogError(command_buffer, vuid,
2894 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2895 "source (0x%x) destination (0x%x).",
2896 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2897 }
2898 } else {
2899 // Source image multiplane checks
2900 uint32_t planes = FormatPlaneCount(src_format);
2901 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2902 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2903 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2904 skip |= LogError(command_buffer, vuid,
2905 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2906 i, aspect);
2907 }
2908 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2909 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2910 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2911 skip |= LogError(command_buffer, vuid,
2912 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2913 i, aspect);
2914 }
2915 // Single-plane to multi-plane
2916 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
2917 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2918 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2919 skip |= LogError(command_buffer, vuid,
2920 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2921 func_name, i, aspect);
2922 }
Dave Houltonc991cc92018-03-06 11:08:51 -07002923
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002924 // Dest image multiplane checks
2925 planes = FormatPlaneCount(dst_format);
2926 aspect = region.dstSubresource.aspectMask;
2927 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2928 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2929 skip |= LogError(command_buffer, vuid,
2930 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2931 i, aspect);
2932 }
2933 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2934 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2935 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2936 skip |= LogError(command_buffer, vuid,
2937 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2938 i, aspect);
2939 }
2940 // Multi-plane to single-plane
2941 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
2942 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2943 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2944 skip |= LogError(command_buffer, vuid,
2945 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2946 func_name, i, aspect);
2947 }
2948 }
2949 } else {
2950 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07002951 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2952 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002953 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002954 skip |= LogError(
2955 command_buffer, vuid,
2956 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
2957 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07002958 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002959 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002960
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002961 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002962 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002963 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002964 skip |=
2965 LogError(command_buffer, vuid,
2966 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
2967 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002968 }
2969
2970 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002971 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002972 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002973 skip |= LogError(
2974 command_buffer, vuid,
2975 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
2976 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002977 }
2978
Dave Houltonfc1a4052017-04-27 14:32:45 -06002979 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002980 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2981 if (slice_override) src_copy_extent.depth = depth_slices;
2982 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002983 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002984 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
2985 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002986 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04002987 "width [%1d].",
2988 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002989 }
2990
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002991 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002992 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
2993 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002994 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04002995 "height [%1d].",
2996 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002997 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002998 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002999 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3000 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003001 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003002 "depth [%1d].",
3003 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003004 }
3005
Dave Houltonee281a52017-12-08 13:51:02 -07003006 // Adjust dest extent if necessary
3007 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
3008 if (slice_override) dst_copy_extent.depth = depth_slices;
3009
3010 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003011 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003012 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3013 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003014 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003015 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003016 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003017 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003018 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003019 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3020 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003021 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003022 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003023 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003024 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003025 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003026 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3027 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003028 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003029 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003030 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003031 }
3032
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003033 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3034 // must not overlap in memory
3035 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003036 for (uint32_t j = 0; j < regionCount; j++) {
3037 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003038 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003039 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003040 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003041 }
3042 }
3043 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003044
3045 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3046 if (device_extensions.vk_khr_maintenance1) {
3047 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3048 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3049 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003050 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3051 skip |= LogError(command_buffer, vuid,
3052 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3053 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003054 }
3055 } else {
3056 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3057 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3058 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003059 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3060 skip |= LogError(command_buffer, vuid,
3061 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3062 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003063 }
3064 }
3065
3066 // Check if 2D with 3D and depth not equal to 2D layerCount
3067 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3068 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3069 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003070 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3071 skip |= LogError(command_buffer, vuid,
3072 "%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 -08003073 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003074 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003075 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3076 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3077 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003078 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3079 skip |= LogError(command_buffer, vuid,
3080 "%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 -08003081 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003082 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003083 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003084
3085 // Check for multi-plane format compatiblity
3086 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3087 size_t src_format_size = 0;
3088 size_t dst_format_size = 0;
3089 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003090 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3091 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003092 } else {
3093 src_format_size = FormatElementSize(src_format);
3094 }
3095 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003096 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3097 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003098 } else {
3099 dst_format_size = FormatElementSize(dst_format);
3100 }
3101 // If size is still zero, then format is invalid and will be caught in another VU
3102 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003103 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3104 skip |= LogError(command_buffer, vuid,
3105 "%s: pRegions[%u] called with non-compatible image formats. "
3106 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3107 func_name, i, string_VkFormat(src_format),
3108 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3109 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003110 }
3111 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003112 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003113
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003114 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3115 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3116 // because because both texels are 4 bytes in size.
3117 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003118 const char *compatible_vuid =
3119 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3120 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3121 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003122 // Depth/stencil formats must match exactly.
3123 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3124 if (src_format != dst_format) {
3125 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003126 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003127 string_VkFormat(src_format), string_VkFormat(dst_format));
3128 }
3129 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003130 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003131 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003132 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003133 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003134 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003135 FormatElementSize(dst_format));
3136 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003137 }
3138 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003139
Dave Houlton33c22b72017-02-28 13:16:02 -07003140 // Source and dest image sample counts must match
3141 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003142 std::stringstream ss;
3143 ss << func_name << " called on image pair with non-identical sample counts.";
3144 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003145 skip |=
3146 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3147 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3148 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003149 }
3150
Tony-LunarG5a066372021-01-21 10:31:34 -07003151 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3152 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3153 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003154 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
Tony-LunarG5a066372021-01-21 10:31:34 -07003155 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3156 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3157 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3158 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003159 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003160 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3161 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3162 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3163 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3164 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3165 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3166 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3167 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3168 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3169 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3170 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3171 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003172
3173 // Validation for VK_EXT_fragment_density_map
3174 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003175 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3176 skip |=
3177 LogError(command_buffer, vuid,
3178 "%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 +02003179 }
3180 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003181 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3182 skip |=
3183 LogError(command_buffer, vuid,
3184 "%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 +02003185 }
3186
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003187 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003188 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3189 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3190 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3191 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003192 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003193 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3194 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3195 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3196 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3197 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003198 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003199
3200 const char *invalid_src_layout_vuid =
3201 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3202 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3203 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3204 const char *invalid_dst_layout_vuid =
3205 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3206 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3207 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3208
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003209 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003210 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003211 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003212 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3213 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003214 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003215 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003216 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003217 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003218 }
3219
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003220 return skip;
3221}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003222
Jeff Leger178b1e52020-10-05 12:22:23 -04003223bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3224 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3225 const VkImageCopy *pRegions) const {
3226 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3227 COPY_COMMAND_VERSION_1);
3228}
3229
3230bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3231 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3232 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3233 COPY_COMMAND_VERSION_2);
3234}
3235
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003236void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3237 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3238 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003239 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3240 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003241 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003242 auto src_image_state = GetImageState(srcImage);
3243 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003244
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003245 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003246 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003247 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3248 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003249 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003250}
3251
Jeff Leger178b1e52020-10-05 12:22:23 -04003252void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3253 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3254 auto cb_node = GetCBState(commandBuffer);
3255 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3256 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3257
3258 // Make sure that all image slices are updated to correct layout
3259 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3260 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3261 pCopyImageInfo->srcImageLayout);
3262 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3263 pCopyImageInfo->dstImageLayout);
3264 }
3265}
3266
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003267// Returns true if sub_rect is entirely contained within rect
3268static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3269 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 -07003270 (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 -07003271 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003272 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003273 return true;
3274}
3275
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003276bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003277 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003278 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3279 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003280 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003281 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3282 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003283 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003284 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003285
3286 for (uint32_t j = 0; j < rect_count; j++) {
3287 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003288 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3289 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3290 "the current render pass instance.",
3291 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003292 }
3293
3294 if (image_view_state) {
3295 // The layers specified by a given element of pRects must be contained within every attachment that
3296 // pAttachments refers to
3297 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3298 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3299 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003300 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3301 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3302 "of pAttachment[%d].",
3303 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003304 }
3305 }
3306 }
3307 return skip;
3308}
3309
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003310bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3311 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003312 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003313 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003314 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003315 if (!cb_node) return skip;
3316
3317 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3318 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3319 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003320 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003321
3322 // Validate that attachment is in reference list of active subpass
3323 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003324 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003325 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003326 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003327 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003328 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003329
John Zulauf3a548ef2019-02-01 16:14:07 -07003330 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3331 auto clear_desc = &pAttachments[attachment_index];
3332 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003333 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003334
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003335 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3336 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3337 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3338 attachment_index);
3339 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3340 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3341 skip |=
3342 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3343 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3344 attachment_index);
3345 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003346 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3347 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3348 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3349 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003350 skip |= LogError(
3351 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3352 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3353 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3354 attachment_index, clear_desc->colorAttachment,
3355 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3356 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003357
John Zulauff2582972019-02-09 14:53:30 -07003358 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3359 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003360 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003361 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3362 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3363 " subpass %u. colorAttachmentCount=%u",
3364 attachment_index, clear_desc->colorAttachment,
3365 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3366 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003367 }
John Zulauff2582972019-02-09 14:53:30 -07003368 fb_attachment = color_attachment;
3369
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003370 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3371 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3372 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3373 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3374 "of a color attachment.",
3375 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003376 }
3377 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003378 bool subpass_depth = false;
3379 bool subpass_stencil = false;
3380 if (subpass_desc->pDepthStencilAttachment &&
3381 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3382 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3383 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3384 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3385 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003386 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003387 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3388 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003389 skip |= LogError(
3390 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3391 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003392 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003393 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003394 }
3395 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003396 skip |= LogError(
3397 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3398 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003399 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003400 attachment_index);
3401 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003402 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003403 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003404 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003405 if (subpass_depth) {
3406 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3407 "vkCmdClearAttachments()");
3408 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003409 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003410 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003411 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3412 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003413 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003414
3415 // Once the framebuffer attachment is found, can get the image view state
3416 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3417 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3418 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003419 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003420 if (image_view_state != nullptr) {
3421 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3422 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3423 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3424 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3425 }
3426 }
John Zulauf441558b2019-08-12 11:47:39 -06003427 }
3428 }
3429 return skip;
3430}
3431
3432void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3433 const VkClearAttachment *pAttachments, uint32_t rectCount,
3434 const VkClearRect *pRects) {
3435 auto *cb_node = GetCBState(commandBuffer);
3436 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003437 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3438 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003439 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3440 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3441 const auto clear_desc = &pAttachments[attachment_index];
3442 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3443 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3444 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3445 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3446 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3447 subpass_desc->pDepthStencilAttachment) {
3448 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3449 }
3450 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003451 if (!clear_rect_copy) {
3452 // We need a copy of the clear rectangles that will persist until the last lambda executes
3453 // but we want to create it as lazily as possible
3454 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003455 }
John Zulauf441558b2019-08-12 11:47:39 -06003456 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3457 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003458 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003459 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003460 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003461 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3462 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003463 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003464 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003465 return skip;
3466 };
3467 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003468 }
3469 }
3470 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003471}
3472
Jeff Leger178b1e52020-10-05 12:22:23 -04003473template <typename RegionType>
3474bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3475 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3476 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003477 const auto *cb_node = GetCBState(commandBuffer);
3478 const auto *src_image_state = GetImageState(srcImage);
3479 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003480 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3481 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3482 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3483 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003484
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003485 bool skip = false;
3486 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003487 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3488 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3489 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3490 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3491 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3492 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3493 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3494 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3495 skip |= InsideRenderPass(cb_node, func_name, vuid);
3496 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3497 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3498 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3499 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3500 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3501 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3502 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3503 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003504
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003505 // Validation for VK_EXT_fragment_density_map
3506 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003507 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3508 skip |= LogError(cb_node->commandBuffer, vuid,
3509 "%s: srcImage must not have been created with flags containing "
3510 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3511 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003512 }
3513 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003514 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3515 skip |= LogError(cb_node->commandBuffer, vuid,
3516 "%s: dstImage must not have been created with flags containing "
3517 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3518 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003519 }
3520
Cort Stratton7df30962018-05-17 19:45:57 -07003521 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003522 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003523 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3524 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003525 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003526 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3527 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3528 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003529 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003530 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3531 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3532 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3533 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3534 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3535 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003536 // For each region, the number of layers in the image subresource should not be zero
3537 // For each region, src and dest image aspect must be color only
3538 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003539 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003540 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3541 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003542 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3543 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3544 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003545 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003546 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3547 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003548 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003549 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3550 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3551 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3552 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3553 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3554 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003555 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003556 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3557 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003558 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003559 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003560
3561 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003562 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003563 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3564 skip |=
3565 LogError(cb_node->commandBuffer, vuid,
3566 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003567 }
Cort Stratton7df30962018-05-17 19:45:57 -07003568 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003569 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3570 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003571 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3572 skip |= LogError(cb_node->commandBuffer, vuid,
3573 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3574 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003575 }
3576
3577 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3578 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3579
3580 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003581 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003582 LogObjectList objlist(cb_node->commandBuffer);
3583 objlist.add(src_image_state->image);
3584 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003585 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3586 skip |= LogError(objlist, vuid,
3587 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003588 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003589 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003590 }
3591 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3592 LogObjectList objlist(cb_node->commandBuffer);
3593 objlist.add(src_image_state->image);
3594 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003595 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3596 skip |= LogError(objlist, vuid,
3597 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003598 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003599 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003600 }
3601 }
3602
3603 if (VK_IMAGE_TYPE_1D == src_image_type) {
3604 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3605 LogObjectList objlist(cb_node->commandBuffer);
3606 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003607 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3608 skip |= LogError(objlist, vuid,
3609 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003610 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003611 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3612 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003613 }
3614 }
3615 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3616 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3617 LogObjectList objlist(cb_node->commandBuffer);
3618 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003619 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3620 skip |= LogError(objlist, vuid,
3621 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003622 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003623 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3624 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003625 }
3626 }
3627
3628 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3629 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3630 LogObjectList objlist(cb_node->commandBuffer);
3631 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003632 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3633 skip |= LogError(objlist, vuid,
3634 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003635 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003636 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3637 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003638 }
3639 }
3640 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3641 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3642 LogObjectList objlist(cb_node->commandBuffer);
3643 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003644 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3645 skip |= LogError(objlist, vuid,
3646 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003647 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003648 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3649 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003650 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003651 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003652
3653 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3654 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3655 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3656 // developer
3657 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3658 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003659 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003660 LogObjectList objlist(cb_node->commandBuffer);
3661 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003662 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3663 skip |= LogError(objlist, vuid,
3664 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003665 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003666 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003667 region.extent.width, subresource_extent.width);
3668 }
3669
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003670 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003671 LogObjectList objlist(cb_node->commandBuffer);
3672 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003673 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3674 skip |= LogError(objlist, vuid,
3675 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003676 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003677 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003678 region.extent.height, subresource_extent.height);
3679 }
3680
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003681 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003682 LogObjectList objlist(cb_node->commandBuffer);
3683 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003684 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3685 skip |= LogError(objlist, vuid,
3686 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003687 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003688 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003689 region.extent.depth, subresource_extent.depth);
3690 }
3691 }
3692
3693 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3694 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3695 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3696 // developer
3697 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3698 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003699 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003700 LogObjectList objlist(cb_node->commandBuffer);
3701 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003702 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3703 skip |= LogError(objlist, vuid,
3704 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003705 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003706 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003707 region.extent.width, subresource_extent.width);
3708 }
3709
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003710 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003711 LogObjectList objlist(cb_node->commandBuffer);
3712 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003713 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3714 skip |= LogError(objlist, vuid,
3715 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003716 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003717 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003718 region.extent.height, subresource_extent.height);
3719 }
3720
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003721 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003722 LogObjectList objlist(cb_node->commandBuffer);
3723 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003724 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3725 skip |= LogError(objlist, vuid,
3726 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003727 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003728 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003729 region.extent.depth, subresource_extent.depth);
3730 }
3731 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003732 }
3733
3734 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003735 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3736 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3737 func_name, string_VkFormat(src_image_state->createInfo.format),
3738 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003739 }
3740 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003741 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003742 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003743 string_VkImageType(src_image_state->createInfo.imageType),
3744 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003745 }
3746 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003747 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3748 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 -07003749 }
3750 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003751 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3752 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3753 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003754 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003755 } else {
3756 assert(0);
3757 }
3758 return skip;
3759}
3760
Jeff Leger178b1e52020-10-05 12:22:23 -04003761bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3762 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3763 const VkImageResolve *pRegions) const {
3764 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3765 COPY_COMMAND_VERSION_1);
3766}
3767
3768bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3769 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3770 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3771 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3772 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3773}
3774
3775template <typename RegionType>
3776bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3777 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3778 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003779 const auto *cb_node = GetCBState(commandBuffer);
3780 const auto *src_image_state = GetImageState(srcImage);
3781 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003782
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3784 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3785 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3786
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003787 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003788 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003789 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003790 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003791 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003792 const char *vuid;
3793 const char *location;
3794 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3795 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3796 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3797 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3798 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3799 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3800 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3801 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3802 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3803 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3804 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3805 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3806 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3807 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3808 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3809 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3810 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3811 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3812 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3813 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3814 skip |= InsideRenderPass(cb_node, func_name, vuid);
3815 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3816 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3817 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3818 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3819 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3820 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3821 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3822 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3823 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3824 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003825
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003826 // Validation for VK_EXT_fragment_density_map
3827 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003828 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3829 skip |= LogError(cb_node->commandBuffer, vuid,
3830 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3831 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003832 }
3833 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003834 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3835 skip |= LogError(cb_node->commandBuffer, vuid,
3836 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3837 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003838 }
3839
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003840 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003841
Dave Houlton33c2d252017-06-09 17:08:32 -06003842 VkFormat src_format = src_image_state->createInfo.format;
3843 VkFormat dst_format = dst_image_state->createInfo.format;
3844 VkImageType src_type = src_image_state->createInfo.imageType;
3845 VkImageType dst_type = dst_image_state->createInfo.imageType;
3846
Cort Stratton186b1a22018-05-01 20:18:06 -04003847 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003848 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3849 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3850 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003851 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003852 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003853 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003854 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003855 }
3856
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003857 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003858 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3859 skip |= LogError(device, vuid,
3860 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003861 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003862 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003863 }
3864
3865 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003866 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3867 skip |= LogError(device, vuid,
3868 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003869 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003870 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003871 }
3872
Dave Houlton33c2d252017-06-09 17:08:32 -06003873 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003874 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3875 skip |= LogError(cb_node->commandBuffer, vuid,
3876 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003877 }
3878
Dave Houlton33c2d252017-06-09 17:08:32 -06003879 // Validate consistency for unsigned formats
3880 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3881 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003882 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003883 << "the other one must also have unsigned integer format. "
3884 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003885 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3886 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003887 }
3888
3889 // Validate consistency for signed formats
3890 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3891 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003892 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003893 << "the other one must also have signed integer format. "
3894 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003895 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3896 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003897 }
3898
3899 // Validate filter for Depth/Stencil formats
3900 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3901 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003902 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003903 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003904 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3905 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003906 }
3907
3908 // Validate aspect bits and formats for depth/stencil images
3909 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3910 if (src_format != dst_format) {
3911 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003912 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 -06003913 << "stencil, the other one must have exactly the same format. "
3914 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3915 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003916 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3917 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003918 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003919 } // Depth or Stencil
3920
3921 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003922 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003923 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3924 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3925 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3926 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3927 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3928 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003929 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003930 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3931 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3932 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3933 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3934 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3935 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003936 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003937 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003938 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003939 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003940 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003941 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3942 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003943 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003944 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3945 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3946 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3947 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3948 skip |=
3949 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3950 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3951 skip |=
3952 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3953 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003954 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003955 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3956 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003957 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003958 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003959 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003960 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3961 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003962 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003963 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003964 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003965 }
Dave Houlton48989f32017-05-26 15:01:46 -06003966 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3967 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003968 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003969 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003970 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003971 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003972
3973 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003974 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003975 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
3976 skip |=
3977 LogError(cb_node->commandBuffer, vuid,
3978 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003979 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003980
Dave Houlton48989f32017-05-26 15:01:46 -06003981 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003982 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
3983 skip |=
3984 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003985 }
Dave Houlton48989f32017-05-26 15:01:46 -06003986
Dave Houlton33c2d252017-06-09 17:08:32 -06003987 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003988 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
3989 skip |= LogError(cb_node->commandBuffer, vuid,
3990 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003991 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003992 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003993 }
3994
3995 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003996 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
3997 skip |= LogError(cb_node->commandBuffer, vuid,
3998 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3999 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004000 }
4001
Dave Houlton48989f32017-05-26 15:01:46 -06004002 // Validate source image offsets
4003 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004004 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004005 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004006 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
4007 skip |= LogError(cb_node->commandBuffer, vuid,
4008 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4009 "of (%1d, %1d). These must be (0, 1).",
4010 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004011 }
4012 }
4013
Dave Houlton33c2d252017-06-09 17:08:32 -06004014 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004015 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004016 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
4017 skip |= LogError(cb_node->commandBuffer, vuid,
4018 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4019 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4020 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004021 }
4022 }
4023
Dave Houlton33c2d252017-06-09 17:08:32 -06004024 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004025 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4026 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004027 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004028 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
4029 skip |= LogError(cb_node->commandBuffer, vuid,
4030 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4031 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004032 }
4033 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4034 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004035 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004036 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
4037 skip |= LogError(cb_node->commandBuffer, vuid,
4038 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4039 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004040 }
4041 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4042 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004043 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004044 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
4045 skip |= LogError(cb_node->commandBuffer, vuid,
4046 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4047 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004048 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004049 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004050 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4051 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4052 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004053 }
Dave Houlton48989f32017-05-26 15:01:46 -06004054
4055 // Validate dest image offsets
4056 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004057 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004058 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004059 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4060 skip |= LogError(cb_node->commandBuffer, vuid,
4061 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4062 "(%1d, %1d). These must be (0, 1).",
4063 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004064 }
4065 }
4066
Dave Houlton33c2d252017-06-09 17:08:32 -06004067 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004068 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004069 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4070 skip |= LogError(cb_node->commandBuffer, vuid,
4071 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004072 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004073 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004074 }
4075 }
4076
Dave Houlton33c2d252017-06-09 17:08:32 -06004077 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004078 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4079 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004080 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004081 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4082 skip |= LogError(cb_node->commandBuffer, vuid,
4083 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4084 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004085 }
4086 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4087 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004088 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004089 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4090 skip |= LogError(cb_node->commandBuffer, vuid,
4091 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4092 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004093 }
4094 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4095 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004096 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004097 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4098 skip |= LogError(cb_node->commandBuffer, vuid,
4099 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4100 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004101 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004102 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004103 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4104 skip |= LogError(cb_node->commandBuffer, vuid,
4105 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004106 }
4107
Dave Houlton33c2d252017-06-09 17:08:32 -06004108 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4109 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4110 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004111 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4112 skip |= LogError(cb_node->commandBuffer, vuid,
4113 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4114 "layerCount other than 1.",
4115 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004116 }
4117 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004118 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004119 } else {
4120 assert(0);
4121 }
4122 return skip;
4123}
4124
Jeff Leger178b1e52020-10-05 12:22:23 -04004125bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4126 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4127 const VkImageBlit *pRegions, VkFilter filter) const {
4128 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4129 COPY_COMMAND_VERSION_1);
4130}
4131
4132bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4133 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4134 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4135 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4136}
4137
4138template <typename RegionType>
4139void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4140 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4141 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004142 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004143 auto src_image_state = GetImageState(srcImage);
4144 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004145
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004146 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004147 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004148 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4149 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004150 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004151}
4152
Jeff Leger178b1e52020-10-05 12:22:23 -04004153void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4154 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4155 const VkImageBlit *pRegions, VkFilter filter) {
4156 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4157 pRegions, filter);
4158 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4159}
4160
4161void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4162 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4163 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4164 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4165 pBlitImageInfo->filter);
4166}
4167
John Zulauf2076e812020-01-08 14:55:54 -07004168GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4169 assert(map);
4170 // This approach allows for a single hash lookup or/create new
4171 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4172 if (inserted.second) {
4173 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004174 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004175 inserted.first->second.reset(layout_map);
4176 return layout_map;
4177 } else {
4178 assert(nullptr != inserted.first->second.get());
4179 return inserted.first->second.get();
4180 }
4181 return nullptr;
4182}
4183
4184const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4185 auto it = map.find(image);
4186 if (it != map.end()) {
4187 return it->second.get();
4188 }
4189 return nullptr;
4190}
4191
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004192// 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 -07004193bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4194 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004195 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004196 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004197 GlobalImageLayoutMap &overlay_layout_map = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004198 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004199 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004200 for (const auto &layout_map_entry : pCB->image_layout_map) {
4201 const auto image = layout_map_entry.first;
4202 const auto *image_state = GetImageState(image);
4203 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004204 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004205 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004206 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004207 if (initial_layout_map.empty()) continue;
4208
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004209 auto *overlay_map = GetLayoutRangeMap(&overlay_layout_map, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004210 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4211 if (global_map == nullptr) {
4212 global_map = &empty_map;
4213 }
4214
4215 // Note: don't know if it would matter
4216 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4217
4218 auto pos = initial_layout_map.begin();
4219 const auto end = initial_layout_map.end();
4220 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4221 pos->first.begin);
4222 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004223 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004224 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004225 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 -07004226 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004227 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004228 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004229 image_layout = current_layout->pos_B->lower_bound->second;
4230 }
4231 const auto intersected_range = pos->first & current_layout->range;
4232 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4233 // TODO: Set memory invalid which is in mem_tracker currently
4234 } else if (image_layout != initial_layout) {
4235 // Need to look up the inital layout *state* to get a bit more information
4236 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4237 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4238 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4239 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004240 // We can report all the errors for the intersected range directly
4241 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004242 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004243 skip |= LogError(
4244 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004245 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004246 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004247 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004248 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004249 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004250 }
4251 }
John Zulauf2076e812020-01-08 14:55:54 -07004252 if (pos->first.includes(intersected_range.end)) {
4253 current_layout.seek(intersected_range.end);
4254 } else {
4255 ++pos;
4256 if (pos != end) {
4257 current_layout.seek(pos->first.begin);
4258 }
4259 }
John Zulauff660ad62019-03-23 07:16:05 -06004260 }
4261
locke-lunargf155ccf2020-02-18 11:34:15 -07004262 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004263 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004264 }
John Zulauff660ad62019-03-23 07:16:05 -06004265
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004266 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004267}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004268
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004269void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004270 for (const auto &layout_map_entry : pCB->image_layout_map) {
4271 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004272 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004273 const auto *image_state = GetImageState(image);
4274 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004275 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4276 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004277 }
4278}
4279
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004280// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004281// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4282// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004283bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4284 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004285 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004286 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004287 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4288
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004289 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004290 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4291 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004292 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004293 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4294 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4295 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004296 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004297 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004298 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004299 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4300 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4301 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004302 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004303 string_VkImageLayout(first_layout));
4304 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4305 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004306 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004307 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004308 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004309 }
4310 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004311
4312 // Same as above for loadOp, but for stencilLoadOp
4313 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4314 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4315 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4316 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4317 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004318 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004319 string_VkImageLayout(first_layout));
4320 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4321 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4322 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004323 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004324 string_VkImageLayout(first_layout));
4325 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4326 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4327 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004328 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004329 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004330 }
4331 }
4332
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004333 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004334}
4335
Mark Lobodzinski96210742017-02-09 10:33:46 -07004336// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4337// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004338template <typename T1>
4339bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4340 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4341 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004342 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004343 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004344 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004345 if (strict) {
4346 correct_usage = ((actual & desired) == desired);
4347 } else {
4348 correct_usage = ((actual & desired) != 0);
4349 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004350
Mark Lobodzinski96210742017-02-09 10:33:46 -07004351 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004352 // All callers should have a valid VUID
4353 assert(msgCode != kVUIDUndefined);
4354 skip =
4355 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4356 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004357 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004358 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004359}
4360
4361// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4362// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004363bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004364 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004365 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004366 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004367}
4368
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004369bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004370 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004371 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004372 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4373 if ((image_format_features & desired) != desired) {
4374 // Same error, but more details if it was an AHB external format
4375 if (image_state->has_ahb_format == true) {
4376 skip |= LogError(image_state->image, vuid,
4377 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4378 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4379 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004380 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004381 } else {
4382 skip |= LogError(image_state->image, vuid,
4383 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4384 "with tiling %s.",
4385 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4386 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4387 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004388 }
4389 }
4390 return skip;
4391}
4392
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004393bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004394 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004395 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004396 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004397 // layerCount must not be zero
4398 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004399 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4400 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004401 }
4402 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004403 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004404 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4405 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004406 }
4407 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004408 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 -07004409 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4410 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4411 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4412 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004413 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004414 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4415 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4416 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4417 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4418 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4419 member);
4420 }
Cort Strattond619a302018-05-17 19:46:32 -07004421 return skip;
4422}
4423
Mark Lobodzinski96210742017-02-09 10:33:46 -07004424// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4425// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004426bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004427 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004428 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004429 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004430}
4431
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004432bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004433 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004434 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004435
4436 const VkDeviceSize &range = pCreateInfo->range;
4437 if (range != VK_WHOLE_SIZE) {
4438 // Range must be greater than 0
4439 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004440 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004441 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004442 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4443 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004444 }
4445 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004446 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4447 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004448 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004449 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004450 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4451 "(%" PRIu32 ").",
4452 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004453 }
4454 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004455 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004456 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004457 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004458 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4459 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4460 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004461 }
4462 // The sum of range and offset must be less than or equal to the size of buffer
4463 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004464 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004465 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004466 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4467 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4468 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004469 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004470 } else {
4471 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4472
4473 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4474 // VkPhysicalDeviceLimits::maxTexelBufferElements
4475 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4476 device_limits->maxTexelBufferElements) {
4477 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4478 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4479 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4480 "), divided by the element size of the format (%" PRIu32
4481 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4482 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4483 device_limits->maxTexelBufferElements);
4484 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004485 }
4486 return skip;
4487}
4488
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004489bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004490 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004491 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004492 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4493 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004494 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004495 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004496 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4497 "be supported for uniform texel buffers",
4498 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004499 }
4500 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4501 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004502 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004503 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004504 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4505 "be supported for storage texel buffers",
4506 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004507 }
4508 return skip;
4509}
4510
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004511bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004512 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004513 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004514
Dave Houltond8ed0212018-05-16 17:18:24 -06004515 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004516
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004517 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004518 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004519 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004520 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004521 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4522 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004523 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004524 }
4525 }
4526
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004527 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004528 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004529 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004530 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004531 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004532 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4533 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004534 }
4535 }
4536
Mike Schuchardt2df08912020-12-15 16:28:09 -08004537 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004538 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4539 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004540 skip |= LogError(
4541 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004542 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004543 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004544 }
4545
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004546 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004547 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4548 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4549 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004550 }
4551
sfricke-samsungedce77a2020-07-03 22:35:13 -07004552 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4553 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4554 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4555 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4556 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4557 }
4558 const VkBufferCreateFlags invalid_flags =
4559 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4560 if ((pCreateInfo->flags & invalid_flags) != 0) {
4561 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4562 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4563 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4564 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4565 }
4566 }
4567
Mark Lobodzinski96210742017-02-09 10:33:46 -07004568 return skip;
4569}
4570
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004571bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004572 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004573 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004574 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004575 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4576 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004577 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004578 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4579 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004580 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004581 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4582 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4583 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004584
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004585 // Buffer view offset must be less than the size of buffer
4586 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004587 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004588 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004589 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4590 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004591 }
4592
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004593 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004594 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4595 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4596 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004597 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4598 : "VUID-VkBufferViewCreateInfo-offset-00926";
4599 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004600 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004601 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4602 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004603 }
4604
4605 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004606 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4607 if ((element_size % 3) == 0) {
4608 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004609 }
4610 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004611 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004612 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4613 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004614 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004615 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004616 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004617 skip |= LogError(
4618 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004619 "vkCreateBufferView(): If buffer was created with usage containing "
4620 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004621 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4622 ") must be a multiple of the lesser of "
4623 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4624 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4625 "(%" PRId32
4626 ") is VK_TRUE, the size of a texel of the requested format. "
4627 "If the size of a texel is a multiple of three bytes, then the size of a "
4628 "single component of format is used instead",
4629 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4630 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4631 }
4632 }
4633 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004634 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004635 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4636 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004637 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004638 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004639 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004640 skip |= LogError(
4641 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004642 "vkCreateBufferView(): If buffer was created with usage containing "
4643 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004644 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4645 ") must be a multiple of the lesser of "
4646 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4647 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4648 "(%" PRId32
4649 ") is VK_TRUE, the size of a texel of the requested format. "
4650 "If the size of a texel is a multiple of three bytes, then the size of a "
4651 "single component of format is used instead",
4652 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4653 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4654 }
4655 }
4656 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004657
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004658 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004659
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004660 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004661 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004662 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004663}
4664
Mark Lobodzinski602de982017-02-09 11:01:33 -07004665// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004666bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004667 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004668 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004669 const IMAGE_STATE *image_state = GetImageState(image);
4670 // checks color format and (single-plane or non-disjoint)
4671 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004672 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004673 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004674 skip |= LogError(image, vuid, "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004675 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004676 skip |= LogError(image, vuid, "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004677 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004678 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004679 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004680 skip |= LogError(image, vuid,
4681 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4682 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4683 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004684 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004685 skip |= LogError(image, vuid,
4686 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4687 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4688 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004689 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004690 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004691 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004692 skip |= LogError(image, vuid, "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004693 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004694 skip |=
4695 LogError(image, vuid, "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004696 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004697 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004698 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004699 skip |=
4700 LogError(image, vuid, "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004701 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004702 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4703 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004704 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004705 } else if (FormatIsMultiplane(format)) {
4706 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4707 if (3 == FormatPlaneCount(format)) {
4708 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4709 }
4710 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004711 skip |=
4712 LogError(image, vuid,
4713 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4714 "set, where n = [0, 1, 2].",
4715 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004716 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004717 }
4718 return skip;
4719}
4720
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004721bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4722 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004723 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4724 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004725 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004726
4727 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004728 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004729 skip |= LogError(image, errorCodes.base_mip_err,
4730 "%s: %s.baseMipLevel (= %" PRIu32
4731 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4732 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004733 }
Petr Kraus4d718682017-05-18 03:38:41 +02004734
Petr Krausffa94af2017-08-08 21:46:02 +02004735 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4736 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004737 skip |=
4738 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004739 } else {
4740 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004741
Petr Krausffa94af2017-08-08 21:46:02 +02004742 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004743 skip |= LogError(image, errorCodes.mip_count_err,
4744 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4745 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4746 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4747 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004748 }
Petr Kraus4d718682017-05-18 03:38:41 +02004749 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004750 }
Petr Kraus4d718682017-05-18 03:38:41 +02004751
4752 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004753 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004754 skip |= LogError(image, errorCodes.base_layer_err,
4755 "%s: %s.baseArrayLayer (= %" PRIu32
4756 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4757 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004758 }
Petr Kraus4d718682017-05-18 03:38:41 +02004759
Petr Krausffa94af2017-08-08 21:46:02 +02004760 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4761 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004762 skip |=
4763 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004764 } else {
4765 const uint64_t necessary_layer_count =
4766 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004767
Petr Krausffa94af2017-08-08 21:46:02 +02004768 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004769 skip |= LogError(image, errorCodes.layer_count_err,
4770 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4771 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4772 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4773 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004774 }
Petr Kraus4d718682017-05-18 03:38:41 +02004775 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004776 }
Petr Kraus4d718682017-05-18 03:38:41 +02004777
Mark Lobodzinski602de982017-02-09 11:01:33 -07004778 return skip;
4779}
4780
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004781bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004782 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004783 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004784 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004785 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004786 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 +02004787
David McFarland2853f2f2020-11-30 15:50:39 -04004788 uint32_t image_layer_count;
4789
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004790 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004791 const auto layers = LayersFromRange(subresourceRange);
4792 const auto extent = GetImageSubresourceExtent(image_state, &layers);
4793 image_layer_count = extent.depth;
4794 } else {
4795 image_layer_count = image_state->createInfo.arrayLayers;
4796 }
4797
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004798 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004799
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004800 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4801 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4802 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4803 subresource_range_error_codes.base_layer_err =
4804 is_khr_maintenance1
4805 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4806 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4807 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4808 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4809 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4810 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004811
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004812 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004813 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004814 image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004815}
4816
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004817bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004818 const VkImageSubresourceRange &subresourceRange,
4819 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004820 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4821 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4822 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4823 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4824 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004825
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004826 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004827 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004828 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004829}
4830
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004831bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004832 const VkImageSubresourceRange &subresourceRange,
4833 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004834 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4835 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4836 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4837 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4838 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004839
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004840 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004841 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004842 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004843}
4844
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004845bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004846 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004847 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004848 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4849 subresource_range_error_codes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4850 subresource_range_error_codes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4851 subresource_range_error_codes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4852 subresource_range_error_codes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004853
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004854 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004855 cmd_name, param_name, "arrayLayers", image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004856}
4857
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004858bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4859 const VkImageUsageFlags image_usage) const {
4860 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4861 bool skip = false;
4862
4863 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4864 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4865
4866 if (image_state->has_ahb_format == true) {
4867 // AHB image view and image share same feature sets
4868 tiling_features = image_state->format_features;
4869 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4870 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4871 assert(device_extensions.vk_ext_image_drm_format_modifier);
4872 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4873 nullptr};
4874 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4875
4876 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4877 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4878 nullptr};
4879 format_properties_2.pNext = (void *)&drm_properties_list;
4880 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4881
4882 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4883 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4884 0) {
4885 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4886 }
4887 }
4888 } else {
4889 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4890 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4891 : format_properties.optimalTilingFeatures;
4892 }
4893
4894 if (tiling_features == 0) {
4895 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4896 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4897 "physical device.",
4898 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4899 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4900 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4901 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4902 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4903 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4904 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4905 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4906 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4907 "VK_IMAGE_USAGE_STORAGE_BIT.",
4908 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4909 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4910 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4911 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4912 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4913 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4914 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4915 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4916 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4917 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4918 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4919 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4920 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4921 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4922 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4923 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4924 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4925 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00004926 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
4927 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
4928 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
4929 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-04550",
4930 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4931 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
4932 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4933 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004934 }
4935
4936 return skip;
4937}
4938
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004939bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004940 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004941 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004942 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004943 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004944 skip |=
4945 ValidateImageUsageFlags(image_state,
4946 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4947 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004948 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4949 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4950 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004951 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004952 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004953 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004954 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004955 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004956 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004957 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004958 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004959
4960 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4961 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004962 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004963 VkFormat view_format = pCreateInfo->format;
4964 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004965 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004966 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004967
Dave Houltonbd2e2622018-04-10 16:41:14 -06004968 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004969 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004970 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004971 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004972 if (!device_extensions.vk_ext_separate_stencil_usage) {
4973 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004974 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4975 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4976 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004977 }
4978 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004979 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05004980 if (image_stencil_struct == nullptr) {
4981 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004982 skip |= LogError(
4983 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004984 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4985 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4986 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4987 }
4988 } else {
4989 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4990 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4991 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004992 skip |= LogError(
4993 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004994 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4995 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4996 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4997 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4998 }
4999 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5000 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005001 skip |= LogError(
5002 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005003 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5004 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5005 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5006 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5007 }
5008 }
5009 }
5010 }
5011
Dave Houltonbd2e2622018-04-10 16:41:14 -06005012 image_usage = chained_ivuci_struct->usage;
5013 }
5014
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005015 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5016 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005017 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005018 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005019 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005020 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005021 std::stringstream ss;
5022 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005023 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005024 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005025 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005026 }
5027 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005028 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005029 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5030 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005031 const char *error_vuid;
5032 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5033 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5034 } else if ((device_extensions.vk_khr_maintenance2) &&
5035 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5036 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5037 } else if ((!device_extensions.vk_khr_maintenance2) &&
5038 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5039 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5040 } else {
5041 // both enabled
5042 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5043 }
Dave Houltonc7988072018-04-16 11:46:56 -06005044 std::stringstream ss;
5045 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005046 << " is not in the same format compatibility class as "
5047 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005048 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5049 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005050 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005051 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005052 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005053 }
5054 } else {
5055 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005056 // Unless it is a multi-planar color bit aspect
5057 if ((image_format != view_format) &&
5058 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5059 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5060 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005061 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005062 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005063 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005064 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005065 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005066 }
5067 }
5068
5069 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005070 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005071
5072 switch (image_type) {
5073 case VK_IMAGE_TYPE_1D:
5074 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005075 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5076 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5077 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005078 }
5079 break;
5080 case VK_IMAGE_TYPE_2D:
5081 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5082 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5083 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005084 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5085 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5086 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005087 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005088 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5089 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5090 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005091 }
5092 }
5093 break;
5094 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005095 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005096 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5097 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005098 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005099 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005100 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5101 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5102 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005103 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5104 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005105 skip |= LogError(
5106 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5107 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5108 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5109 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5110 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005111 }
5112 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005113 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5114 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5115 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005116 }
5117 }
5118 } else {
5119 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005120 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5121 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5122 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005123 }
5124 }
5125 break;
5126 default:
5127 break;
5128 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005129
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005130 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005131 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005132 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005133 }
5134
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005135 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005136
Tobias Hector6663c9b2020-11-05 10:18:02 +00005137 if (enabled_features.shading_rate_image.shadingRateImage) {
5138 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5139 if (view_format != VK_FORMAT_R8_UINT) {
5140 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5141 "vkCreateImageView() If image was created with usage containing "
5142 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5143 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005144 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005145 }
5146
5147 if (enabled_features.shading_rate_image.shadingRateImage ||
5148 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5149 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5150 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5151 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5152 "vkCreateImageView() If image was created with usage containing "
5153 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5154 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5155 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005156 }
5157 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005158
Tobias Hector6663c9b2020-11-05 10:18:02 +00005159 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5160 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5161 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5162 pCreateInfo->subresourceRange.layerCount != 1) {
5163 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5164 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5165 pCreateInfo->subresourceRange.layerCount);
5166 }
5167
Jeff Bolz99e3f632020-03-24 22:59:22 -05005168 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5169 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5170 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5171 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5172 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5173 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5174 }
5175 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5176 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5177 skip |= LogError(
5178 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5179 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5180 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5181 }
5182 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005183
5184 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5185 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005186 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005187 "vkCreateImageView(): If image was created with usage containing "
5188 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5189 pCreateInfo->subresourceRange.levelCount);
5190 }
5191 }
5192 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5193 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005194 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005195 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5196 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5197 }
5198 } else {
5199 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5200 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5201 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005202 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005203 "vkCreateImageView(): If image was created with usage containing "
5204 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5205 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5206 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5207 }
5208 }
5209 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005210
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005211 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5212 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5213 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5214 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5215 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5216 }
5217 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5218 skip |=
5219 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5220 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5221 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5222 }
5223 }
5224 if (device_extensions.vk_ext_fragment_density_map_2) {
5225 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5226 (pCreateInfo->subresourceRange.layerCount >
5227 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5228 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5229 "vkCreateImageView(): If image was created with flags containing "
5230 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5231 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5232 pCreateInfo->subresourceRange.layerCount,
5233 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5234 }
5235 }
5236
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005237 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005238 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5239 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5240 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5241 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5242 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5243 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5244 }
5245 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005246
5247 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5248 // If swizzling is disabled, make sure it isn't used
5249 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5250 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5251 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5252 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5253 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5254 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5255 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5256 }
5257
5258 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5259 // disabled
5260 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5261 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5262 // spec. See Github issue #2361.
5263 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5264 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5265 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5266 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5267 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5268 "vkCreateImageView (portability error): ImageView format must have"
5269 " the same number of components and bits per component as the Image's format");
5270 }
5271 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005272 }
5273 return skip;
5274}
5275
Jeff Leger178b1e52020-10-05 12:22:23 -04005276template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005277bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005278 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005279 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005280 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5281 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5282 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005283
5284 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5285 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5286 VkDeviceSize src_min = UINT64_MAX;
5287 VkDeviceSize src_max = 0;
5288 VkDeviceSize dst_min = UINT64_MAX;
5289 VkDeviceSize dst_max = 0;
5290
5291 for (uint32_t i = 0; i < regionCount; i++) {
5292 src_min = std::min(src_min, pRegions[i].srcOffset);
5293 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5294 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5295 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5296
5297 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5298 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005299 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5300 skip |= LogError(src_buffer_state->buffer, vuid,
5301 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5302 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005303 }
5304
5305 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5306 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005307 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5308 skip |= LogError(dst_buffer_state->buffer, vuid,
5309 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5310 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005311 }
5312
5313 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5314 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005315 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5316 skip |= LogError(src_buffer_state->buffer, vuid,
5317 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005318 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005319 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005320 }
5321
5322 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5323 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005324 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5325 skip |= LogError(dst_buffer_state->buffer, vuid,
5326 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005327 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005328 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005329 }
5330 }
5331
5332 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5333 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5334 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005335 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5336 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5337 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005338 }
5339 }
5340
5341 return skip;
5342}
5343
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005344bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005345 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005346 const auto cb_node = GetCBState(commandBuffer);
5347 const auto src_buffer_state = GetBufferState(srcBuffer);
5348 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005349
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005350 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005351 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5352 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005353 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005354 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005355 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5356 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005357 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005358 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5359 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005360 skip |=
5361 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5362 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005363 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5364 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005365 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005366 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5367 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5368 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005369 return skip;
5370}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005371
Jeff Leger178b1e52020-10-05 12:22:23 -04005372bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5373 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5374 const auto cb_node = GetCBState(commandBuffer);
5375 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5376 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5377
5378 bool skip = false;
5379 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5380 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5381 // Validate that SRC & DST buffers have correct usage flags set
5382 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5383 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5384 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5385 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5386 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5387 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5388 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5389 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5390 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5391 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5392 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5393 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5394 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5395 skip |=
5396 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5397 skip |=
5398 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5399 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5400 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5401 return skip;
5402}
5403
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005404bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005405 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005406 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005407 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005408 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005409 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5410 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005411 }
5412 }
5413 return skip;
5414}
5415
Jeff Bolz5c801d12019-10-09 10:38:45 -05005416bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5417 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005418 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005419 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005420
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005421 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005422 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005423 skip |=
5424 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005425 }
5426 return skip;
5427}
5428
Jeff Bolz5c801d12019-10-09 10:38:45 -05005429bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005430 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005431
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005432 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005433 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005434 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005435 }
5436 return skip;
5437}
5438
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005439bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005440 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005441 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005442 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005443 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005444 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005445 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005446 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005447 }
5448 return skip;
5449}
5450
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005451bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005452 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005453 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005454 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005455 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005456 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005457 skip |=
5458 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5459 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005460 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005461 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005462 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5463 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005464 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005465
sfricke-samsung022fa252020-07-24 03:26:16 -07005466 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5467 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5468
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005469 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005470 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5471 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5472 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5473 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005474 }
5475
5476 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005477 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5478 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5479 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5480 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005481 }
5482
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005483 return skip;
5484}
5485
Jeff Leger178b1e52020-10-05 12:22:23 -04005486template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005487bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005488 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005489 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005490 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005491 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5492 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005493
sfricke-samsung125d2b42020-05-28 06:32:43 -07005494 assert(image_state != nullptr);
5495 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005496
5497 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005498 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005499 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5500 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005501 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005502 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5503 "and 1, respectively.",
5504 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005505 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005506 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005507
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005508 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5509 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005510 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005511 "%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 -07005512 "must be 0 and 1, respectively.",
5513 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005514 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005515 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005516
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005517 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5518 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005519 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005520 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005521 "For 3D images these must be 0 and 1, respectively.",
5522 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005523 }
5524 }
5525
5526 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005527 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08005528 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
5529 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07005530
sfricke-samsung8feecc12021-01-23 03:28:38 -08005531 if (FormatIsDepthOrStencil(image_format)) {
5532 if (SafeModulo(bufferOffset, 4) != 0) {
5533 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
5534 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5535 " must be a multiple 4 if using a depth/stencil format (%s).",
5536 function, i, bufferOffset, string_VkFormat(image_format));
5537 }
5538 } else {
5539 // If not depth/stencil and not multi-plane
5540 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
5541 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5542 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
5543 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
5544 skip |= LogError(image_state->image, vuid,
5545 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5546 " must be a multiple of this format's texel size (%" PRIu32 ").",
5547 function, i, bufferOffset, element_size);
5548 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005549 }
5550
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005551 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5552 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005553 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005554 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005555 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005556 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005557 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005558 }
5559
5560 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5561 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005562 vuid =
5563 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04005564 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005565 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005566 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5567 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005568 }
5569
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005570 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005571 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005572 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005573 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 -06005574 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5575 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005576 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005577 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005578 "zero or <= image subresource width (%d).",
5579 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005580 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005581 }
5582
5583 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005584 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 -06005585 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5586 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005587 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005588 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005589 "zero or <= image subresource height (%d).",
5590 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005591 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005592 }
5593
5594 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005595 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 -06005596 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5597 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005598 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005599 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005600 "zero or <= image subresource depth (%d).",
5601 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005602 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005603 }
5604
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005605 // subresource aspectMask must have exactly 1 bit set
5606 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005607 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005608 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005609 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5610 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005611 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005612 }
5613
5614 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005615 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005616 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005617 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005618 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5619 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005620 }
5621
5622 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005623 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5624 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005625
5626 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005627 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005628 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005629 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005630 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5631 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005632 }
5633
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005634 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005635 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005636 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005637 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005638 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005639 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005640 }
5641
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005642 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005643 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5644 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5645 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005646 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005647 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005648 "width & height (%d, %d)..",
5649 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5650 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005651 }
5652
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005653 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005654 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08005655 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005656 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005657 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005658 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
sfricke-samsung8feecc12021-01-23 03:28:38 -08005659 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005660 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005661
5662 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005663 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005664 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005665 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005666 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005667 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005668 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5669 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5670 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005671 }
5672
5673 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005674 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005675 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005676 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005677 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005678 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5679 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5680 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005681 }
5682
5683 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005684 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005685 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005686 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005687 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005688 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5689 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5690 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005691 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005692 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005693
5694 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005695 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005696 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005697 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005698 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005699 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005700 "format has three planes.",
5701 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005702 }
5703
5704 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005705 if (0 ==
5706 (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 -07005707 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005708 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005709 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5710 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005711 } else {
5712 // Know aspect mask is valid
5713 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5714 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08005715 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005716 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005717 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005718 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005719 " 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 -08005720 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07005721 string_VkFormat(compatible_format));
5722 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005723 }
5724 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08005725
5726 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5727 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5728 assert(command_pool != nullptr);
5729 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5730 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5731 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
5732 LogObjectList objlist(cb_node->commandBuffer);
5733 objlist.add(command_pool->commandPool);
5734 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
5735 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5736 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
5737 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
5738 "VK_QUEUE_COMPUTE_BIT flag.",
5739 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5740 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
5741 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005742 }
5743
5744 return skip;
5745}
5746
Jeff Leger178b1e52020-10-05 12:22:23 -04005747template <typename BufferImageCopyRegionType>
5748bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5749 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005750 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005751 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005752
5753 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005754 VkExtent3D extent = pRegions[i].imageExtent;
5755 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005756
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005757 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5758 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005759 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5760 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5761 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005762 }
5763
5764 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5765
5766 // 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 -06005767 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005768 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005769 if (image_extent.width % block_extent.width) {
5770 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5771 }
5772 if (image_extent.height % block_extent.height) {
5773 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5774 }
5775 if (image_extent.depth % block_extent.depth) {
5776 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5777 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005778 }
5779
Dave Houltonfc1a4052017-04-27 14:32:45 -06005780 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005781 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005782 }
5783 }
5784
5785 return skip;
5786}
5787
Jeff Leger178b1e52020-10-05 12:22:23 -04005788template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005789bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005790 const BufferImageCopyRegionType *pRegions, const char *func_name,
5791 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005792 bool skip = false;
5793
5794 VkDeviceSize buffer_size = buff_state->createInfo.size;
5795
5796 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005797 VkDeviceSize max_buffer_offset =
5798 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5799 if (buffer_size < max_buffer_offset) {
5800 skip |=
5801 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 -07005802 }
5803 }
5804
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005805 return skip;
5806}
5807
Jeff Leger178b1e52020-10-05 12:22:23 -04005808template <typename BufferImageCopyRegionType>
5809bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5810 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5811 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005812 const auto cb_node = GetCBState(commandBuffer);
5813 const auto src_image_state = GetImageState(srcImage);
5814 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005815
Jeff Leger178b1e52020-10-05 12:22:23 -04005816 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5817 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5818 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5819 const char *vuid;
5820
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005821 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005822
5823 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005824 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005825
5826 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005827 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005828
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005829 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005830
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005831 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005832 vuid =
5833 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5834 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5835 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5836 "or transfer capabilities.",
5837 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005838 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005839 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5840 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5841 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5842 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005843
Jeff Leger178b1e52020-10-05 12:22:23 -04005844 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5845 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5846 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5847
5848 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5849 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5850 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5851 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005852
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005853 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005854 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5855 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005856 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005857 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5858 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005859 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005860 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5861 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5862 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5863 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5864 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5865 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005866
5867 // Validation for VK_EXT_fragment_density_map
5868 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005869 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5870 skip |= LogError(cb_node->commandBuffer, vuid,
5871 "%s: srcImage must not have been created with flags containing "
5872 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5873 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005874 }
5875
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005876 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005877 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5878 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005879 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005880 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5881 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005882 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005883
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005884 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 -04005885 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5886 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5887 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5888 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5889
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005890 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005891 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5892 vuid =
5893 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005894 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005895 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5896 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5897 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5898 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5899 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5900 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5901 "imageSubresource", vuid);
5902 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5903 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005904 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005905 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005906 }
5907 return skip;
5908}
5909
Jeff Leger178b1e52020-10-05 12:22:23 -04005910bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5911 VkBuffer dstBuffer, uint32_t regionCount,
5912 const VkBufferImageCopy *pRegions) const {
5913 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5914 COPY_COMMAND_VERSION_1);
5915}
5916
5917bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5918 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5919 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5920 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5921 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5922}
5923
John Zulauf1686f232019-07-09 16:27:11 -06005924void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5925 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5926 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5927
5928 auto cb_node = GetCBState(commandBuffer);
5929 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005930 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005931 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005932 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005933 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005934}
5935
Jeff Leger178b1e52020-10-05 12:22:23 -04005936void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5937 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5938 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5939
5940 auto cb_node = GetCBState(commandBuffer);
5941 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5942 // Make sure that all image slices record referenced layout
5943 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5944 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5945 pCopyImageToBufferInfo->srcImageLayout);
5946 }
5947}
5948
5949template <typename RegionType>
5950bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5951 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5952 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005953 const auto cb_node = GetCBState(commandBuffer);
5954 const auto src_buffer_state = GetBufferState(srcBuffer);
5955 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005956
Jeff Leger178b1e52020-10-05 12:22:23 -04005957 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5958 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5959 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5960 const char *vuid;
5961
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005962 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005963
5964 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005965 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005966
sfricke-samsungea4fd142020-10-17 23:51:59 -07005967 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5968 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5969
Jeff Leger178b1e52020-10-05 12:22:23 -04005970 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5971 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5972 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5973 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5974
5975 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5976 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5977 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5978 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5979 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5980 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5981 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5982 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5983 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005984 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005985 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5986 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005987 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005988 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5989 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5990 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5991 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5992 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5993 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005994
5995 // Validation for VK_EXT_fragment_density_map
5996 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005997 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5998 skip |= LogError(cb_node->commandBuffer, vuid,
5999 "%s: dstImage must not have been created with flags containing "
6000 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6001 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006002 }
6003
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006004 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006005 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6006 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006007 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006008 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
6009 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06006010 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006011
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006012 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 -04006013 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6014 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6015 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6016 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6017
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006018 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006019 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6020 vuid =
6021 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006022 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006023 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6024 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6025 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6026 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6027 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6028 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6029 "imageSubresource", vuid);
6030 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6031 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006032 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006033 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006034
6035 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6036 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6037 assert(command_pool != nullptr);
6038 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6039 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6040 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6041 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6042 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
6043 LogObjectList objlist(cb_node->commandBuffer);
6044 objlist.add(command_pool->commandPool);
6045 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6046 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
6047 skip |= LogError(dst_image_state->image, vuid,
6048 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6049 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6050 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
6051 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6052 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6053 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006054 }
6055 return skip;
6056}
6057
Jeff Leger178b1e52020-10-05 12:22:23 -04006058bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6059 VkImageLayout dstImageLayout, uint32_t regionCount,
6060 const VkBufferImageCopy *pRegions) const {
6061 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6062 COPY_COMMAND_VERSION_1);
6063}
6064
6065bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6066 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6067 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6068 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6069 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6070}
6071
John Zulauf1686f232019-07-09 16:27:11 -06006072void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6073 VkImageLayout dstImageLayout, uint32_t regionCount,
6074 const VkBufferImageCopy *pRegions) {
6075 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6076
6077 auto cb_node = GetCBState(commandBuffer);
6078 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006079 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006080 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006081 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006082 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006083}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006084
Jeff Leger178b1e52020-10-05 12:22:23 -04006085void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6086 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6087 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6088
6089 auto cb_node = GetCBState(commandBuffer);
6090 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6091 // Make sure that all image slices are record referenced layout
6092 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6093 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6094 pCopyBufferToImageInfo2KHR->dstImageLayout);
6095 }
6096}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006097bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006098 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006099 bool skip = false;
6100 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6101
Dave Houlton1d960ff2018-01-19 12:17:05 -07006102 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006103 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6104 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6105 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006106 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6107 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006108 }
6109
John Zulaufa26d3c82019-08-14 16:09:08 -06006110 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006111 if (!image_entry) {
6112 return skip;
6113 }
6114
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006115 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6116 if (device_extensions.vk_ext_image_drm_format_modifier) {
6117 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6118 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006119 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6120 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6121 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006122 }
6123 } else {
6124 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006125 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6126 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006127 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006128 }
6129
Dave Houlton1d960ff2018-01-19 12:17:05 -07006130 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006131 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006132 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6133 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6134 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006135 }
6136
Dave Houlton1d960ff2018-01-19 12:17:05 -07006137 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006138 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006139 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6140 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6141 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006142 }
6143
Dave Houlton1d960ff2018-01-19 12:17:05 -07006144 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006145 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006146 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6147 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006148 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006149 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6150 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006151 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006152 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6153 }
6154 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006155 skip |= LogError(image, vuid,
6156 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6157 ") must be a single-plane specifier flag.",
6158 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006159 }
6160 } else if (FormatIsColor(img_format)) {
6161 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006162 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6163 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6164 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006165 }
6166 } else if (FormatIsDepthOrStencil(img_format)) {
6167 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6168 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006169 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006170 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6171 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6172 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6173 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006174 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6175 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6176 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006177 }
6178 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006179
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006180 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006181 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006182 }
6183
Mike Weiblen672b58b2017-02-21 14:32:53 -07006184 return skip;
6185}
sfricke-samsung022fa252020-07-24 03:26:16 -07006186
6187// Validates the image is allowed to be protected
6188bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006189 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006190 bool skip = false;
6191 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6192 LogObjectList objlist(cb_state->commandBuffer);
6193 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006194 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 -07006195 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006196 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006197 }
6198 return skip;
6199}
6200
6201// Validates the image is allowed to be unprotected
6202bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006203 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006204 bool skip = false;
6205 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6206 LogObjectList objlist(cb_state->commandBuffer);
6207 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006208 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 -07006209 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006210 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006211 }
6212 return skip;
6213}
6214
6215// Validates the buffer is allowed to be protected
6216bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006217 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006218 bool skip = false;
6219 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6220 LogObjectList objlist(cb_state->commandBuffer);
6221 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006222 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 -07006223 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006224 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006225 }
6226 return skip;
6227}
6228
6229// Validates the buffer is allowed to be unprotected
6230bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006231 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006232 bool skip = false;
6233 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6234 LogObjectList objlist(cb_state->commandBuffer);
6235 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006236 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 -07006237 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006238 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006239 }
6240 return skip;
6241}