blob: c34911be671bd5a6b02988d81050df66356794c2 [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.
Tobias Hector6663c9b2020-11-05 10:18:02 +00005 * Modifications Copyright (C) 2020 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) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700819 // First transition into initialLayout
820 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) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700824 VkImageLayout stencil_layout = kInvalidLayout;
825 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700826 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700827 if (attachment_description_stencil_layout) {
828 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
829 }
830
831 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600832 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700833 }
834 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700835 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700836}
837
Dave Houlton10b39482017-03-16 13:18:15 -0600838bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600839 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600840 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600841 }
842 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600843 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600844 }
845 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600846 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600847 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800848 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 -0700849 if (FormatPlaneCount(format) == 1) return false;
850 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600851 return true;
852}
853
Mike Weiblen62d08a32017-03-07 22:18:27 -0700854// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200855bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
856 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600857 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700858 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200859 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600860 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700861
862 switch (layout) {
863 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
864 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600865 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700866 }
867 break;
868 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
869 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600870 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700871 }
872 break;
873 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
874 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600875 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700876 }
877 break;
878 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
879 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600880 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700881 }
882 break;
883 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
884 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600885 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700886 }
887 break;
888 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
889 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600890 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700891 }
892 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600893 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500894 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
895 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
896 }
897 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700898 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
899 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
900 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
901 }
902 break;
903 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
904 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
905 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
906 }
907 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700908 default:
909 // Other VkImageLayout values do not have VUs defined in this context.
910 break;
911 }
912
Dave Houlton8e9f6542018-05-18 12:18:22 -0600913 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700914 skip |= LogError(img_barrier.image, msg_code,
915 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
916 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
917 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700918 }
919 return skip;
920}
921
922// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600923bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
924 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700925 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700926
Petr Krausad0096a2019-08-09 18:35:04 +0200927 // Scoreboard for checking for duplicate and inconsistent barriers to images
928 struct ImageBarrierScoreboardEntry {
929 uint32_t index;
930 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
931 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
932 const VkImageMemoryBarrier *barrier;
933 };
934 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
935 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
936
John Zulauf463c51e2018-05-31 13:29:20 -0600937 // Scoreboard for duplicate layout transition barriers within the list
938 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
939 ImageBarrierScoreboardImageMap layout_transitions;
940
Mike Weiblen62d08a32017-03-07 22:18:27 -0700941 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200942 const auto &img_barrier = pImageMemoryBarriers[i];
943 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700944
John Zulauf463c51e2018-05-31 13:29:20 -0600945 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
946 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
947 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200948 if (img_barrier.oldLayout != img_barrier.newLayout) {
949 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
950 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600951 if (image_it != layout_transitions.end()) {
952 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200953 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600954 if (subres_it != subres_map.end()) {
955 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200956 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
957 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
958 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700959 skip = LogError(
960 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200961 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600962 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
963 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200964 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
965 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
966 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600967 }
968 entry = new_entry;
969 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200970 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600971 }
972 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200973 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600974 }
975 }
976
Petr Krausad0096a2019-08-09 18:35:04 +0200977 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600978 if (image_state) {
979 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200980 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
981 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600982
983 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
984 if (image_state->layout_locked) {
985 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700986 skip |= LogError(
987 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700988 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600989 " 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 -0700990 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200991 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600992 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600993
John Zulaufa4472282019-08-22 14:44:34 -0600994 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700995 const VkFormat image_format = image_create_info.format;
996 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600997 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700998 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700999 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06001000 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1001 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001002 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
1003 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
1004 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1005 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001006 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001007 }
1008 } else {
1009 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1010 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -07001011 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
1012 ? "VUID-VkImageMemoryBarrier-image-03320"
1013 : "VUID-VkImageMemoryBarrier-image-01207";
1014 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001015 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
1016 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1017 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001018 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001019 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001020 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001021 }
John Zulauff660ad62019-03-23 07:16:05 -06001022
Petr Krausad0096a2019-08-09 18:35:04 +02001023 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1024 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001025 // TODO: Set memory invalid which is in mem_tracker currently
1026 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1027 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001028 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001029 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001030 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001031 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001032 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1033 // the next "constant value" range
1034 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001035 const auto &value = *pos;
1036 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001037 subres_skip = LogError(
1038 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001039 "%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 -07001040 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001041 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -07001042 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1043 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001044 }
John Zulauf5e617452019-11-19 14:44:16 -07001045 }
John Zulauff660ad62019-03-23 07:16:05 -06001046 skip |= subres_skip;
1047 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001048
1049 // checks color format and (single-plane or non-disjoint)
1050 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1051 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001052 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001053 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1054 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
1055 ? "VUID-VkImageMemoryBarrier-image-01671"
1056 : "VUID-VkImageMemoryBarrier-image-02902";
1057 skip |= LogError(img_barrier.image, vuid,
1058 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1059 "but its aspectMask is 0x%" PRIx32 ".",
1060 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1061 string_VkFormat(image_format), aspect_mask);
1062 }
1063 }
1064
1065 VkImageAspectFlags valid_disjoint_mask =
1066 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 -07001067 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001068 ((aspect_mask & valid_disjoint_mask) == 0)) {
1069 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1070 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1071 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1072 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1073 string_VkFormat(image_format), aspect_mask);
1074 }
1075
1076 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1077 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1078 "%s: Image barrier %s references %s of format %s has only two planes but included "
1079 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1080 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1081 string_VkFormat(image_format), aspect_mask);
1082 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001083 }
1084 }
1085 return skip;
1086}
1087
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001088bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001089 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001090
Jeff Bolz6835fda2019-10-06 00:15:34 -05001091 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001092 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001093}
1094
John Zulauf6b4aae82018-05-09 13:03:36 -06001095template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001096bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1097 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001098 using BarrierRecord = QFOTransferBarrier<Barrier>;
1099 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001100 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001101 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1102 const char *barrier_name = BarrierRecord::BarrierName();
1103 const char *handle_name = BarrierRecord::HandleName();
1104 const char *transfer_type = nullptr;
1105 for (uint32_t b = 0; b < barrier_count; b++) {
1106 if (!IsTransferOp(&barriers[b])) continue;
1107 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001108 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001109 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001110 const auto found = barrier_sets.release.find(barriers[b]);
1111 if (found != barrier_sets.release.cend()) {
1112 barrier_record = &(*found);
1113 transfer_type = "releasing";
1114 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001115 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001116 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001117 const auto found = barrier_sets.acquire.find(barriers[b]);
1118 if (found != barrier_sets.acquire.cend()) {
1119 barrier_record = &(*found);
1120 transfer_type = "acquiring";
1121 }
1122 }
1123 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001124 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1125 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1126 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1127 func_name, barrier_name, b, transfer_type, handle_name,
1128 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1129 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001130 }
1131 }
1132 return skip;
1133}
1134
John Zulaufa4472282019-08-22 14:44:34 -06001135VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1136 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1137}
1138
1139const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1140 return device_state.GetImageState(barrier.image);
1141}
1142
1143VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1144 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1145}
1146
1147const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1148 return device_state.GetBufferState(barrier.buffer);
1149}
1150
1151VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1152
John Zulauf6b4aae82018-05-09 13:03:36 -06001153template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001154void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1155 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001156 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001157 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1158 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001159 auto &barrier = barriers[b];
1160 if (IsTransferOp(&barrier)) {
1161 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001162 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001163 barrier_sets.release.emplace(barrier);
1164 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001165 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001166 barrier_sets.acquire.emplace(barrier);
1167 }
1168 }
1169
1170 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1171 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1172 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1173 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1174 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1175 auto handle_state = BarrierHandleState(*this, barrier);
1176 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1177 if (!mode_concurrent) {
1178 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001179 cb_state->queue_submit_functions.emplace_back(
1180 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1181 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1182 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1183 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001184 });
1185 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001186 }
1187 }
1188}
1189
John Zulaufa4472282019-08-22 14:44:34 -06001190bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001191 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001192 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001193 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001194 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001195 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1196 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001197 return skip;
1198}
1199
John Zulaufa4472282019-08-22 14:44:34 -06001200void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1201 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1202 const VkImageMemoryBarrier *pImageMemBarriers) {
1203 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1204 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001205}
1206
1207template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001208bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001209 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001210 // Record to the scoreboard or report that we have a duplication
1211 bool skip = false;
1212 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1213 if (!inserted.second && inserted.first->second != cb_state) {
1214 // 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 -06001215 LogObjectList objlist(cb_state->commandBuffer);
1216 objlist.add(barrier.handle);
1217 objlist.add(inserted.first->second->commandBuffer);
1218 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001219 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1220 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1221 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1222 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1223 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001224 }
1225 return skip;
1226}
1227
1228template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001229bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1230 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001231 using BarrierRecord = QFOTransferBarrier<Barrier>;
1232 using TypeTag = typename BarrierRecord::Tag;
1233 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001234 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001235 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001236 const char *barrier_name = BarrierRecord::BarrierName();
1237 const char *handle_name = BarrierRecord::HandleName();
1238 // No release should have an extant duplicate (WARNING)
1239 for (const auto &release : cb_barriers.release) {
1240 // Check the global pending release barriers
1241 const auto set_it = global_release_barriers.find(release.handle);
1242 if (set_it != global_release_barriers.cend()) {
1243 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1244 const auto found = set_for_handle.find(release);
1245 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001246 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1247 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1248 " to dstQueueFamilyIndex %" PRIu32
1249 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1250 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1251 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001252 }
1253 }
1254 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1255 }
1256 // Each acquire must have a matching release (ERROR)
1257 for (const auto &acquire : cb_barriers.acquire) {
1258 const auto set_it = global_release_barriers.find(acquire.handle);
1259 bool matching_release_found = false;
1260 if (set_it != global_release_barriers.cend()) {
1261 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1262 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1263 }
1264 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001265 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1266 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1267 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1268 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1269 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001270 }
1271 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1272 }
1273 return skip;
1274}
1275
John Zulauf3b04ebd2019-07-18 14:08:11 -06001276bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001277 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001278 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001279 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001280 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1281 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001282 return skip;
1283}
1284
1285template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001286void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001287 using BarrierRecord = QFOTransferBarrier<Barrier>;
1288 using TypeTag = typename BarrierRecord::Tag;
1289 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001290 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001291
1292 // Add release barriers from this submit to the global map
1293 for (const auto &release : cb_barriers.release) {
1294 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1295 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1296 global_release_barriers[release.handle].insert(release);
1297 }
1298
1299 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1300 for (const auto &acquire : cb_barriers.acquire) {
1301 // NOTE: We're not using [] because we don't want to create entries for missing releases
1302 auto set_it = global_release_barriers.find(acquire.handle);
1303 if (set_it != global_release_barriers.end()) {
1304 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1305 set_for_handle.erase(acquire);
1306 if (set_for_handle.size() == 0) { // Clean up empty sets
1307 global_release_barriers.erase(set_it);
1308 }
1309 }
1310 }
1311}
1312
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001313void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001314 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1315 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001316}
1317
John Zulauf6b4aae82018-05-09 13:03:36 -06001318// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001319void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001320
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001321void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001322 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001323 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001324 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001325
Chris Forbes4de4b132017-08-21 11:27:08 -07001326 // For ownership transfers, the barrier is specified twice; as a release
1327 // operation on the yielding queue family, and as an acquire operation
1328 // on the acquiring queue family. This barrier may also include a layout
1329 // transition, which occurs 'between' the two operations. For validation
1330 // purposes it doesn't seem important which side performs the layout
1331 // transition, but it must not be performed twice. We'll arbitrarily
1332 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001333 //
1334 // However, we still need to record initial layout for the "initial layout" validation
1335 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001336
Petr Krausad0096a2019-08-09 18:35:04 +02001337 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001338 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001339 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001340 }
1341}
1342
unknown86bcb3a2019-07-11 13:05:36 -06001343void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001344 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001345 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1346 const auto &image_create_info = image_state->createInfo;
1347
Mike Schuchardt2df08912020-12-15 16:28:09 -08001348 // 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 -06001349 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1350 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001351 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001352 normalized_isr.baseArrayLayer = 0;
1353 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1354 }
1355
Michael Spang8af7c102020-05-03 20:50:09 -04001356 VkImageLayout initial_layout = mem_barrier.oldLayout;
1357
1358 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001359 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001360 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1361 }
1362
John Zulauf2be3fe02019-12-30 09:48:02 -07001363 if (is_release_op) {
1364 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1365 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001366 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001367 }
unknown86bcb3a2019-07-11 13:05:36 -06001368}
1369
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001370bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1371 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1372 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1373 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001374 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001375 assert(cb_node);
1376 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001377 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001378 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001379
John Zulauff660ad62019-03-23 07:16:05 -06001380 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1381 if (subresource_map) {
1382 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001383 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001384 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1385 // the next "constant value" range
1386 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001387 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001388 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001389 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1390 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1391 "%s layout %s.",
1392 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1393 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1394 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001395 }
John Zulauf5e617452019-11-19 14:44:16 -07001396 }
John Zulauff660ad62019-03-23 07:16:05 -06001397 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001398 }
John Zulauff660ad62019-03-23 07:16:05 -06001399
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001400 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1401 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1402 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001403 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1404 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001405 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1406 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1407 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001408 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001409 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001410 if (image_state->shared_presentable) {
1411 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001412 skip |=
1413 LogError(device, layout_invalid_msg_code,
1414 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1415 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001416 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001417 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001418 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001419 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001420 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1421 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1422 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1423 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001424 }
1425 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001426 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001427}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001428bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001429 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1430 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001431 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001432 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1433 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1434}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001435
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001436void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001437 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001438 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1439 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001440
Mike Schuchardt2df08912020-12-15 16:28:09 -08001441 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001442 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001443 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001444 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001445 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001446 VkImageLayout stencil_layout = kInvalidLayout;
1447 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001448 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001449 if (attachment_description_stencil_layout) {
1450 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1451 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001452 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001453 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001454 }
1455 }
1456}
Dave Houltone19e20d2018-02-02 16:32:41 -07001457
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001458#ifdef VK_USE_PLATFORM_ANDROID_KHR
1459// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1460// This could also move into a seperate core_validation_android.cpp file... ?
1461
1462//
1463// AHB-specific validation within non-AHB APIs
1464//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001465bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001466 bool skip = false;
1467
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001468 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001469 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001470 if (0 != ext_fmt_android->externalFormat) {
1471 if (VK_FORMAT_UNDEFINED != create_info->format) {
1472 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001473 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1474 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1475 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001476 }
1477
1478 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001479 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1480 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1481 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001482 }
1483
1484 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001485 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1486 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001487 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1488 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1489 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001490 }
1491
1492 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001493 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1494 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1495 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001496 }
1497 }
1498
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001499 if ((0 != ext_fmt_android->externalFormat) &&
1500 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001501 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001502 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1503 ") which has "
1504 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1505 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001506 }
1507 }
1508
Dave Houltond9611312018-11-19 17:03:36 -07001509 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001510 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001511 skip |=
1512 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1513 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1514 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001515 }
1516 }
1517
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001518 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001519 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1520 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001521 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001522 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1523 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1524 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1525 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001526 }
1527
1528 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001529 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1530 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1531 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1532 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1533 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001534 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001535 }
1536
1537 return skip;
1538}
1539
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001540bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001541 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001542 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001543
1544 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001545 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001546 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1547 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001548 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001549 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001550 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001551
Dave Houltond9611312018-11-19 17:03:36 -07001552 // Chain must include a compatible ycbcr conversion
1553 bool conv_found = false;
1554 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001555 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001556 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001557 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001558 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001559 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001560 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001561 }
Dave Houltond9611312018-11-19 17:03:36 -07001562 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001563 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001564 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001565 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1566 "an externalFormat (%" PRIu64
1567 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1568 "with the same external format.",
1569 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001570 }
1571
1572 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001573 if (IsIdentitySwizzle(create_info->components) == false) {
1574 skip |= LogError(
1575 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1576 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1577 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1578 "= %s.",
1579 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1580 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001581 }
1582 }
Dave Houltond9611312018-11-19 17:03:36 -07001583
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001584 return skip;
1585}
1586
John Zulaufa26d3c82019-08-14 16:09:08 -06001587bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001588 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001589
John Zulaufa26d3c82019-08-14 16:09:08 -06001590 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001591 if (image_state != nullptr) {
1592 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1593 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1594 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1595 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1596 "bound to memory.");
1597 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001598 }
1599 return skip;
1600}
1601
1602#else
1603
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001604bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001605 return false;
1606}
1607
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001608bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001609
John Zulaufa26d3c82019-08-14 16:09:08 -06001610bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001611
1612#endif // VK_USE_PLATFORM_ANDROID_KHR
1613
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001614bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1615 bool skip = false;
1616
1617 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1618 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1619 const VkImageTiling image_tiling = pCreateInfo->tiling;
1620 const VkFormat image_format = pCreateInfo->format;
1621
1622 if (image_format == VK_FORMAT_UNDEFINED) {
1623 // VU 01975 states format can't be undefined unless an android externalFormat
1624#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001625 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001626 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1627 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1628 if (it != ahb_ext_formats_map.end()) {
1629 tiling_features = it->second;
1630 }
1631 }
1632#endif
1633 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1634 uint64_t drm_format_modifier = 0;
1635 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001636 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001637 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001638 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001639
1640 if (drm_explicit != nullptr) {
1641 drm_format_modifier = drm_explicit->drmFormatModifier;
1642 } else {
1643 // VUID 02261 makes sure its only explict or implict in parameter checking
1644 assert(drm_implicit != nullptr);
1645 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1646 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1647 }
1648 }
1649
1650 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1651 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1652 nullptr};
1653 format_properties_2.pNext = (void *)&drm_properties_list;
1654 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001655 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1656 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1657 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1658 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001659
1660 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1661 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1662 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1663 }
1664 }
1665 } else {
1666 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1667 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1668 : format_properties.optimalTilingFeatures;
1669 }
1670
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001671 // Lack of disjoint format feature support while using the flag
1672 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1673 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1674 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1675 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1676 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1677 string_VkFormat(pCreateInfo->format));
1678 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001679
1680 return skip;
1681}
1682
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001683bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001684 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001685 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001686
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001687 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001688 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001689 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1690 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001691 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1692 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001693 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001694 }
1695
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001696 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1697 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001698 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1699 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1700 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001701 }
1702
1703 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001704 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1705 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1706 "height (%d) and arrayLayers (%d) must be >= 6.",
1707 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001708 }
Dave Houlton130c0212018-01-29 13:39:56 -07001709 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001710
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001711 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001712 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1713 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1714 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001715 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001716 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1717 "device maxFramebufferWidth (%u).",
1718 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001719 }
1720
1721 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001722 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001723 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1724 "device maxFramebufferHeight (%u).",
1725 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001726 }
1727
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001728 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001729 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1730 static_cast<float>(device_limits->maxFramebufferWidth) /
1731 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001732 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1733 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001734 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1735 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1736 "ceiling of device "
1737 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1738 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1739 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001740 }
1741
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001742 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1743 static_cast<float>(device_limits->maxFramebufferHeight) /
1744 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001745 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1746 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001747 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1748 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1749 "ceiling of device "
1750 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1751 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1752 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001753 }
1754 }
1755
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001756 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001757 VkResult result = VK_SUCCESS;
1758 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1759 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1760 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1761 &format_limits);
1762 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001763 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1764 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001765 if (modifier_list) {
1766 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001767 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001768 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001769 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001770 image_format_info.type = pCreateInfo->imageType;
1771 image_format_info.format = pCreateInfo->format;
1772 image_format_info.tiling = pCreateInfo->tiling;
1773 image_format_info.usage = pCreateInfo->usage;
1774 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001775 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001776
1777 result =
1778 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1779 format_limits = image_format_properties.imageFormatProperties;
1780
1781 /* The application gives a list of modifier and the driver
1782 * selects one. If one is wrong, stop there.
1783 */
1784 if (result != VK_SUCCESS) break;
1785 }
1786 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001787 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001788 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001789 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001790 image_format_info.type = pCreateInfo->imageType;
1791 image_format_info.format = pCreateInfo->format;
1792 image_format_info.tiling = pCreateInfo->tiling;
1793 image_format_info.usage = pCreateInfo->usage;
1794 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001795 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001796
1797 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1798 format_limits = image_format_properties.imageFormatProperties;
1799 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001800 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001801
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001802 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1803 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1804 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1805 if (result != VK_SUCCESS) {
1806 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001807#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001808 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001809#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001810 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001811 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001812 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1813 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001814#ifdef VK_USE_PLATFORM_ANDROID_KHR
1815 }
1816#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001817 } else {
1818 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1819 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001820 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1821 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1822 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001823 }
Dave Houlton130c0212018-01-29 13:39:56 -07001824
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001825 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1826 static_cast<uint64_t>(pCreateInfo->extent.height) *
1827 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1828 static_cast<uint64_t>(pCreateInfo->samples);
1829 uint64_t total_size =
1830 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07001831
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001832 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001833 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1834 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001835 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001836
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001837 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001838 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1839 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1840 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1841 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001842 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001843
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001844 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001845 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1846 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1847 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001848 }
1849
1850 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001851 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1852 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1853 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001854 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001855
1856 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1857 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1858 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1859 pCreateInfo->extent.width, format_limits.maxExtent.width);
1860 }
1861
1862 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1863 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1864 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1865 pCreateInfo->extent.height, format_limits.maxExtent.height);
1866 }
1867
1868 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1869 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1870 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1871 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1872 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001873 }
1874
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001875 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001876 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1877 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1878 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1879 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001880 skip |= LogError(device, error_vuid,
1881 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1882 "YCbCr Conversion format, arrayLayers must be 1",
1883 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001884 }
1885
1886 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001887 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1888 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1889 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001890 }
1891
1892 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001893 skip |= LogError(
1894 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001895 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1896 string_VkSampleCountFlagBits(pCreateInfo->samples));
1897 }
1898
1899 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001900 skip |= LogError(
1901 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001902 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1903 string_VkImageType(pCreateInfo->imageType));
1904 }
1905 }
1906
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001907 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001908 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001909 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001910 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001911 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1912 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1913 "format must be block, ETC or ASTC compressed, but is %s",
1914 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001915 }
1916 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001917 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1918 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1919 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001920 }
1921 }
1922 }
1923
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001924 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001925 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1926 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1927 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001928 }
1929
unknown2c877272019-07-11 12:56:50 -06001930 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1931 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1932 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001933 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1934 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1935 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001936 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001937
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001938 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001939 if (swapchain_create_info != nullptr) {
1940 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1941 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1942 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1943
1944 // Validate rest of Swapchain Image create check that require swapchain state
1945 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1946 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1947 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1948 skip |= LogError(
1949 device, vuid,
1950 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1951 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1952 }
1953 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1954 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1955 skip |= LogError(device, vuid,
1956 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1957 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1958 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08001959 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001960 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1961 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1962 skip |= LogError(device, vuid,
1963 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1964 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08001965 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001966 }
1967 }
1968 }
1969
sfricke-samsungedce77a2020-07-03 22:35:13 -07001970 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1971 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1972 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1973 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1974 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1975 }
1976 const VkImageCreateFlags invalid_flags =
1977 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1978 if ((pCreateInfo->flags & invalid_flags) != 0) {
1979 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1980 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1981 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1982 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1983 }
1984 }
1985
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001986 skip |= ValidateImageFormatFeatures(pCreateInfo);
1987
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07001988 // Check compatibility with VK_KHR_portability_subset
1989 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
1990 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
1991 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
1992 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
1993 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
1994 }
1995 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
1996 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
1997 skip |=
1998 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
1999 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2000 }
2001 }
2002
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002003 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002004}
2005
John Zulauf7eeb6f72019-06-17 11:56:36 -06002006void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2007 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2008 if (VK_SUCCESS != result) return;
2009
2010 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002011 auto image_state = Get<IMAGE_STATE>(*pImage);
2012 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002013}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002014
Jeff Bolz5c801d12019-10-09 10:38:45 -05002015bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002016 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06002017 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002018 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002019 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002020 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002021 }
2022 return skip;
2023}
2024
John Zulauf7eeb6f72019-06-17 11:56:36 -06002025void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2026 // Clean up validation specific data
2027 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002028
locke-lunargcba7d5f2019-12-30 16:59:11 -07002029 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002030
2031 // Clean up generic image state
2032 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002033}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002034
sfricke-samsungcd924d92020-05-20 23:51:17 -07002035bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2036 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002037 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002038 const VkImage image = image_state->image;
2039 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002040
2041 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002042 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2043 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002044 }
2045
sfricke-samsungcd924d92020-05-20 23:51:17 -07002046 if (FormatIsDepthOrStencil(format)) {
2047 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2048 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2049 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2050 } else if (FormatIsCompressed(format)) {
2051 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2052 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2053 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002054 }
2055
2056 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002057 skip |=
2058 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2059 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2060 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002061 }
2062 return skip;
2063}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002064
John Zulauf07288512019-07-05 11:09:50 -06002065bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2066 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2067 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002068 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002069 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2070 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002071 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2072 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2073 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002074 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002075
2076 } else {
2077 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2078 if (!device_extensions.vk_khr_shared_presentable_image) {
2079 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002080 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2081 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2082 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002083 }
2084 } else {
2085 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2086 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002087 skip |= LogError(
2088 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002089 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2090 func_name, string_VkImageLayout(dest_image_layout));
2091 }
2092 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002093 }
2094
John Zulauff660ad62019-03-23 07:16:05 -06002095 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002096 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002097 if (subresource_map) {
2098 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002099 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002100 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002101 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2102 // the next "constant value" range
2103 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002104 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002105 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2106 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2107 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2108 } else {
2109 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002110 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002111 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2112 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2113 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2114 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002115 }
John Zulauf5e617452019-11-19 14:44:16 -07002116 }
John Zulauff660ad62019-03-23 07:16:05 -06002117 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002118 }
2119
2120 return skip;
2121}
2122
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002123bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2124 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002125 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002126 bool skip = false;
2127 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002128 const auto *cb_node = GetCBState(commandBuffer);
2129 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002130 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002131 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002132 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002133 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002134 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002135 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002136 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2137 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002138 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002139 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002140 skip |=
2141 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2142 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2143 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002144 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002145 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002146 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002147 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002148 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002149 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002150 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2151 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2152 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2153 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2154 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2155 string_VkFormat(image_state->createInfo.format));
2156 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002157 }
2158 return skip;
2159}
2160
John Zulaufeabb4462019-07-05 14:13:03 -06002161void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2162 const VkClearColorValue *pColor, uint32_t rangeCount,
2163 const VkImageSubresourceRange *pRanges) {
2164 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2165
2166 auto cb_node = GetCBState(commandBuffer);
2167 auto image_state = GetImageState(image);
2168 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002169 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002170 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002171 }
2172 }
2173}
2174
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002175bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2176 const char *apiName) const {
2177 bool skip = false;
2178
2179 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2180 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2181 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2182 // Also VUID-VkClearDepthStencilValue-depth-00022
2183 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2184 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2185 "(=%f) is not within the [0.0, 1.0] range.",
2186 apiName, clearValue.depth);
2187 }
2188 }
2189
2190 return skip;
2191}
2192
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002193bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2194 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002195 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002196 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002197
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002198 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002199 const auto *cb_node = GetCBState(commandBuffer);
2200 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002201 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002202 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002203 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002204 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002205 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002206 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002207 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002208 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002209 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002210 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002211 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002212 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002213 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002214 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2215 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2216 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2217 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002218
2219 bool any_include_aspect_depth_bit = false;
2220 bool any_include_aspect_stencil_bit = false;
2221
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002222 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002223 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002224 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002225 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002226 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002227 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2228 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002229 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2230 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2231 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2232 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002233 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002234 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2235 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002236 if (FormatHasDepth(image_format) == false) {
2237 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2238 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2239 "doesn't have a depth component.",
2240 i, string_VkFormat(image_format));
2241 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002242 }
2243 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2244 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002245 if (FormatHasStencil(image_format) == false) {
2246 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2247 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2248 "%s doesn't have a stencil component.",
2249 i, string_VkFormat(image_format));
2250 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002251 }
2252 }
2253 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002254 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002255 if (image_stencil_struct != nullptr) {
2256 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2257 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002258 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2259 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2260 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2261 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002262 }
2263 } else {
2264 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002265 skip |= LogError(
2266 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002267 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2268 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2269 "in VkImageCreateInfo::usage used to create image");
2270 }
2271 }
2272 }
2273 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002274 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2275 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2276 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002277 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002278 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002279 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2280 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002281 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002282 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002283 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002284 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2285 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2286 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2287 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002288 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002289 }
2290 return skip;
2291}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002292
John Zulaufeabb4462019-07-05 14:13:03 -06002293void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2294 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2295 const VkImageSubresourceRange *pRanges) {
2296 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2297 auto cb_node = GetCBState(commandBuffer);
2298 auto image_state = GetImageState(image);
2299 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002300 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002301 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002302 }
2303 }
2304}
2305
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002306// Returns true if [x, xoffset] and [y, yoffset] overlap
2307static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2308 bool result = false;
2309 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2310 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2311
2312 if (intersection_max > intersection_min) {
2313 result = true;
2314 }
2315 return result;
2316}
2317
Jeff Leger178b1e52020-10-05 12:22:23 -04002318// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002319// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002320template <typename RegionType>
2321static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002322 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002323
Dave Houltonc991cc92018-03-06 11:08:51 -07002324 // Separate planes within a multiplane image cannot intersect
2325 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002326 return result;
2327 }
2328
Dave Houltonc991cc92018-03-06 11:08:51 -07002329 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2330 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2331 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002332 result = true;
2333 switch (type) {
2334 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002335 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002336 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002337 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002338 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002339 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002340 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002341 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002342 break;
2343 default:
2344 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2345 assert(false);
2346 }
2347 }
2348 return result;
2349}
2350
Dave Houltonfc1a4052017-04-27 14:32:45 -06002351// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002352static const uint32_t kXBit = 1;
2353static const uint32_t kYBit = 2;
2354static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002355static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002356 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002357 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002358 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2359 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002360 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002361 }
2362 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2363 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002364 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002365 }
2366 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2367 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002368 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002369 }
2370 return result;
2371}
2372
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002373// Test if two VkExtent3D structs are equivalent
2374static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2375 bool result = true;
2376 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2377 (extent->depth != other_extent->depth)) {
2378 result = false;
2379 }
2380 return result;
2381}
2382
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002383// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002384static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002385 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2386}
2387
2388// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002389VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002390 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2391 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002392 auto pool = cb_node->command_pool.get();
2393 if (pool) {
2394 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002395 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002396 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002397 granularity.width *= block_size.width;
2398 granularity.height *= block_size.height;
2399 }
2400 }
2401 return granularity;
2402}
2403
2404// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2405static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2406 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002407 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2408 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002409 valid = false;
2410 }
2411 return valid;
2412}
2413
2414// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002415bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002416 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002417 bool skip = false;
2418 VkExtent3D offset_extent = {};
2419 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2420 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2421 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002422 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002423 // 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 -07002424 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002425 skip |= LogError(cb_node->commandBuffer, vuid,
2426 "%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 "
2427 "image transfer granularity is (w=0, h=0, d=0).",
2428 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002429 }
2430 } else {
2431 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2432 // integer multiples of the image transfer granularity.
2433 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002434 skip |= LogError(cb_node->commandBuffer, vuid,
2435 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2436 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2437 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2438 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002439 }
2440 }
2441 return skip;
2442}
2443
2444// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002445bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002446 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002447 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002448 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002449 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002450 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2451 // subresource extent.
2452 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002453 skip |= LogError(cb_node->commandBuffer, vuid,
2454 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2455 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2456 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2457 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002458 }
2459 } else {
2460 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2461 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2462 // subresource extent dimensions.
2463 VkExtent3D offset_extent_sum = {};
2464 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2465 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2466 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002467 bool x_ok = true;
2468 bool y_ok = true;
2469 bool z_ok = true;
2470 switch (image_type) {
2471 case VK_IMAGE_TYPE_3D:
2472 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2473 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002474 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002475 case VK_IMAGE_TYPE_2D:
2476 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2477 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002478 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002479 case VK_IMAGE_TYPE_1D:
2480 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2481 (subresource_extent->width == offset_extent_sum.width));
2482 break;
2483 default:
2484 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2485 assert(false);
2486 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002487 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002488 skip |=
2489 LogError(cb_node->commandBuffer, vuid,
2490 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2491 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2492 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2493 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2494 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2495 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002496 }
2497 }
2498 return skip;
2499}
2500
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002501bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002502 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002503 bool skip = false;
2504 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002505 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2506 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002507 }
2508 return skip;
2509}
2510
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002511bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002512 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002513 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002514 bool skip = false;
2515 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2516 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002517 skip |= LogError(cb_node->commandBuffer, vuid,
2518 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2519 "%u, but provided %s has %u array layers.",
2520 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2521 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002522 }
2523 return skip;
2524}
2525
Jeff Leger178b1e52020-10-05 12:22:23 -04002526// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2527template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002528bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002529 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002530 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002531 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002532 VkExtent3D granularity = GetScaledItg(cb_node, img);
2533 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002534 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002535 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002536 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002537 return skip;
2538}
2539
Jeff Leger178b1e52020-10-05 12:22:23 -04002540// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2541template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002542bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002543 const IMAGE_STATE *dst_img, const RegionType *region,
2544 const uint32_t i, const char *function,
2545 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002546 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002547 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2548 const char *vuid;
2549
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002550 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002551 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002552 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2553 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002554 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002555 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002556 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002557 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002558 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002559
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002560 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002561 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002562 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2563 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002564 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002565 const VkExtent3D dest_effective_extent =
2566 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002567 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002568 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002569 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002570 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002571 return skip;
2572}
2573
Jeff Leger178b1e52020-10-05 12:22:23 -04002574// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2575template <typename ImageCopyRegionType>
2576bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2577 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2578 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002579 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002580 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2581 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2582 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002583
2584 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002585 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002586
2587 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002588 const VkExtent3D src_copy_extent = region.extent;
2589 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002590 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2591
Dave Houlton6f9059e2017-05-02 17:15:13 -06002592 bool slice_override = false;
2593 uint32_t depth_slices = 0;
2594
2595 // Special case for copying between a 1D/2D array and a 3D image
2596 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2597 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002598 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002599 slice_override = (depth_slices != 1);
2600 } 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 -07002601 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002602 slice_override = (depth_slices != 1);
2603 }
2604
2605 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002606 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002607 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002608 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2609 skip |= LogError(src_state->image, vuid,
2610 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2611 "be 0 and 1, respectively.",
2612 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002613 }
2614 }
2615
Dave Houlton533be9f2018-03-26 17:08:30 -06002616 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 -04002617 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2618 skip |= LogError(src_state->image, vuid,
2619 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002620 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002621 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002622 }
2623
Dave Houlton533be9f2018-03-26 17:08:30 -06002624 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002625 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2626 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2627 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002628 }
2629
Dave Houltonc991cc92018-03-06 11:08:51 -07002630 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002631 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002632 if (FormatIsCompressed(src_state->createInfo.format) ||
2633 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002634 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002635 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002636 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2637 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2638 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002639 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002640 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002641 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002642 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002643 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002644 }
2645
Dave Houlton94a00372017-12-14 15:08:47 -07002646 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002647 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2648 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002649 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2650 skip |= LogError(src_state->image, vuid,
2651 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2652 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2653 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002654 }
2655
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002656 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002657 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2658 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002659 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2660 skip |= LogError(src_state->image, vuid,
2661 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2662 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2663 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002664 }
2665
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002666 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002667 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2668 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002669 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2670 skip |= LogError(src_state->image, vuid,
2671 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2672 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2673 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002674 }
2675 } // Compressed
2676
2677 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002678 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002679 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002680 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2681 skip |= LogError(dst_state->image, vuid,
2682 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002683 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002684 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002685 }
2686 }
2687
Dave Houlton533be9f2018-03-26 17:08:30 -06002688 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 -04002689 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2690 skip |= LogError(dst_state->image, vuid,
2691 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2692 "and 1, respectively.",
2693 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002694 }
2695
Dave Houlton533be9f2018-03-26 17:08:30 -06002696 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002697 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2698 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2699 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002700 }
2701
sfricke-samsung30b094c2020-05-30 11:42:11 -07002702 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002703 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002704 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2705 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002706 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2707 skip |= LogError(src_state->image, vuid,
2708 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2709 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2710 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002711 }
2712 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002713 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002714 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002715 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2716 skip |= LogError(dst_state->image, vuid,
2717 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2718 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2719 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002720 }
2721 }
2722 } else { // Pre maint 1
2723 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002724 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002725 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2726 skip |= LogError(src_state->image, vuid,
2727 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002728 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2729 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002730 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002731 }
Dave Houltonee281a52017-12-08 13:51:02 -07002732 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002733 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2734 skip |= LogError(dst_state->image, vuid,
2735 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002736 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2737 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002738 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002739 }
2740 }
2741 }
2742
Dave Houltonc991cc92018-03-06 11:08:51 -07002743 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2744 if (FormatIsCompressed(dst_state->createInfo.format) ||
2745 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002746 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002747
2748 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002749 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2750 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2751 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002752 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002753 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002754 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002755 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002756 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002757 }
2758
Dave Houlton94a00372017-12-14 15:08:47 -07002759 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002760 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2761 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002762 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2763 skip |= LogError(dst_state->image, vuid,
2764 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2765 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2766 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002767 }
2768
Dave Houltonee281a52017-12-08 13:51:02 -07002769 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2770 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2771 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002772 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002773 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002774 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002775 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2776 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002777 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002778 }
2779
Dave Houltonee281a52017-12-08 13:51:02 -07002780 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2781 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2782 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002783 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2784 skip |= LogError(dst_state->image, vuid,
2785 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2786 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2787 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002788 }
2789 } // Compressed
2790 }
2791 return skip;
2792}
2793
Jeff Leger178b1e52020-10-05 12:22:23 -04002794template <typename RegionType>
2795bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2796 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2797 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002798 const auto *cb_node = GetCBState(commandBuffer);
2799 const auto *src_image_state = GetImageState(srcImage);
2800 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002801 const VkFormat src_format = src_image_state->createInfo.format;
2802 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002803 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002804 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002805
Jeff Leger178b1e52020-10-05 12:22:23 -04002806 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2807 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2808 const char *vuid;
2809
2810 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002811
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002812 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2813
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002814 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002815 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002816
2817 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2818 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002819 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002820
Dave Houlton6f9059e2017-05-02 17:15:13 -06002821 bool slice_override = false;
2822 uint32_t depth_slices = 0;
2823
2824 // Special case for copying between a 1D/2D array and a 3D image
2825 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2826 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2827 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002828 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002829 slice_override = (depth_slices != 1);
2830 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2831 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002832 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002833 slice_override = (depth_slices != 1);
2834 }
2835
Jeff Leger178b1e52020-10-05 12:22:23 -04002836 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2837 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2838 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2839 skip |=
2840 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2841 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2842 skip |=
2843 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2844 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002845 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002846 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2847 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002848 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002849 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002850
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002851 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002852 // No chance of mismatch if we're overriding depth slice count
2853 if (!slice_override) {
2854 // The number of depth slices in srcSubresource and dstSubresource must match
2855 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2856 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002857 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2858 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002859 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002860 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2861 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002862 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002863 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2864 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002865 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2866 "do not match.",
2867 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002868 }
2869 }
2870 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002871 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002872 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002873 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002874 skip |=
2875 LogError(command_buffer, vuid,
2876 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2877 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002878 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002879 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002880
Dave Houltonc991cc92018-03-06 11:08:51 -07002881 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002882 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002883 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2884 // If neither image is multi-plane the aspectMask member of src and dst must match
2885 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2886 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2887 skip |= LogError(command_buffer, vuid,
2888 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2889 "source (0x%x) destination (0x%x).",
2890 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2891 }
2892 } else {
2893 // Source image multiplane checks
2894 uint32_t planes = FormatPlaneCount(src_format);
2895 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2896 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2897 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2898 skip |= LogError(command_buffer, vuid,
2899 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2900 i, aspect);
2901 }
2902 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2903 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2904 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2905 skip |= LogError(command_buffer, vuid,
2906 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2907 i, aspect);
2908 }
2909 // Single-plane to multi-plane
2910 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
2911 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2912 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2913 skip |= LogError(command_buffer, vuid,
2914 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2915 func_name, i, aspect);
2916 }
Dave Houltonc991cc92018-03-06 11:08:51 -07002917
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002918 // Dest image multiplane checks
2919 planes = FormatPlaneCount(dst_format);
2920 aspect = region.dstSubresource.aspectMask;
2921 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2922 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2923 skip |= LogError(command_buffer, vuid,
2924 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2925 i, aspect);
2926 }
2927 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2928 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2929 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2930 skip |= LogError(command_buffer, vuid,
2931 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2932 i, aspect);
2933 }
2934 // Multi-plane to single-plane
2935 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
2936 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2937 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2938 skip |= LogError(command_buffer, vuid,
2939 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2940 func_name, i, aspect);
2941 }
2942 }
2943 } else {
2944 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07002945 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2946 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002947 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002948 skip |= LogError(
2949 command_buffer, vuid,
2950 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
2951 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07002952 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002953 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002954
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002955 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002956 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002957 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002958 skip |=
2959 LogError(command_buffer, vuid,
2960 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
2961 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002962 }
2963
2964 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002965 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002966 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002967 skip |= LogError(
2968 command_buffer, vuid,
2969 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
2970 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002971 }
2972
Dave Houltonfc1a4052017-04-27 14:32:45 -06002973 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002974 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2975 if (slice_override) src_copy_extent.depth = depth_slices;
2976 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002977 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002978 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
2979 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002980 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04002981 "width [%1d].",
2982 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002983 }
2984
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002985 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002986 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
2987 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002988 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04002989 "height [%1d].",
2990 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002991 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002992 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002993 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
2994 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002995 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04002996 "depth [%1d].",
2997 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002998 }
2999
Dave Houltonee281a52017-12-08 13:51:02 -07003000 // Adjust dest extent if necessary
3001 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
3002 if (slice_override) dst_copy_extent.depth = depth_slices;
3003
3004 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003005 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003006 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3007 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003008 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003009 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003010 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003011 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003012 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003013 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3014 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003015 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003016 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003017 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003018 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003019 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003020 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3021 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003022 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003023 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003024 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003025 }
3026
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003027 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3028 // must not overlap in memory
3029 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003030 for (uint32_t j = 0; j < regionCount; j++) {
3031 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003032 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003033 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003034 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003035 }
3036 }
3037 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003038
3039 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3040 if (device_extensions.vk_khr_maintenance1) {
3041 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3042 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3043 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003044 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3045 skip |= LogError(command_buffer, vuid,
3046 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3047 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003048 }
3049 } else {
3050 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3051 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3052 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003053 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3054 skip |= LogError(command_buffer, vuid,
3055 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3056 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003057 }
3058 }
3059
3060 // Check if 2D with 3D and depth not equal to 2D layerCount
3061 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3062 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3063 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003064 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3065 skip |= LogError(command_buffer, vuid,
3066 "%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 -08003067 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003068 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003069 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3070 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3071 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003072 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3073 skip |= LogError(command_buffer, vuid,
3074 "%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 -08003075 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003076 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003077 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003078
3079 // Check for multi-plane format compatiblity
3080 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3081 size_t src_format_size = 0;
3082 size_t dst_format_size = 0;
3083 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003084 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3085 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003086 } else {
3087 src_format_size = FormatElementSize(src_format);
3088 }
3089 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003090 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3091 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003092 } else {
3093 dst_format_size = FormatElementSize(dst_format);
3094 }
3095 // If size is still zero, then format is invalid and will be caught in another VU
3096 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003097 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3098 skip |= LogError(command_buffer, vuid,
3099 "%s: pRegions[%u] called with non-compatible image formats. "
3100 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3101 func_name, i, string_VkFormat(src_format),
3102 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3103 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003104 }
3105 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003106 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003107
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003108 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3109 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3110 // because because both texels are 4 bytes in size.
3111 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003112 const char *compatible_vuid =
3113 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3114 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3115 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003116 // Depth/stencil formats must match exactly.
3117 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3118 if (src_format != dst_format) {
3119 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003120 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003121 string_VkFormat(src_format), string_VkFormat(dst_format));
3122 }
3123 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003124 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003125 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003126 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003127 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003128 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003129 FormatElementSize(dst_format));
3130 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003131 }
3132 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003133
Dave Houlton33c22b72017-02-28 13:16:02 -07003134 // Source and dest image sample counts must match
3135 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003136 std::stringstream ss;
3137 ss << func_name << " called on image pair with non-identical sample counts.";
3138 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003139 skip |=
3140 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3141 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3142 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003143 }
3144
Jeff Leger178b1e52020-10-05 12:22:23 -04003145 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127";
3146 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3147 vuid = is_2khr ? "" : "";
3148 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003149 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003150 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3151 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3152 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3153 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3154 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3155 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3156 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3157 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3158 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3159 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3160 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3161 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003162
3163 // Validation for VK_EXT_fragment_density_map
3164 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003165 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3166 skip |=
3167 LogError(command_buffer, vuid,
3168 "%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 +02003169 }
3170 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003171 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3172 skip |=
3173 LogError(command_buffer, vuid,
3174 "%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 +02003175 }
3176
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003177 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003178 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3179 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3180 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3181 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003182 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003183 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3184 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3185 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3186 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3187 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003188 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003189
3190 const char *invalid_src_layout_vuid =
3191 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3192 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3193 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3194 const char *invalid_dst_layout_vuid =
3195 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3196 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3197 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3198
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003199 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003200 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003201 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003202 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3203 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003204 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003205 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003206 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003207 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003208 }
3209
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003210 return skip;
3211}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003212
Jeff Leger178b1e52020-10-05 12:22:23 -04003213bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3214 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3215 const VkImageCopy *pRegions) const {
3216 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3217 COPY_COMMAND_VERSION_1);
3218}
3219
3220bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3221 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3222 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3223 COPY_COMMAND_VERSION_2);
3224}
3225
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003226void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3227 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3228 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003229 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3230 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003231 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003232 auto src_image_state = GetImageState(srcImage);
3233 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003234
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003235 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003236 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003237 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3238 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003239 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003240}
3241
Jeff Leger178b1e52020-10-05 12:22:23 -04003242void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3243 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3244 auto cb_node = GetCBState(commandBuffer);
3245 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3246 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3247
3248 // Make sure that all image slices are updated to correct layout
3249 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3250 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3251 pCopyImageInfo->srcImageLayout);
3252 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3253 pCopyImageInfo->dstImageLayout);
3254 }
3255}
3256
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003257// Returns true if sub_rect is entirely contained within rect
3258static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3259 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 -07003260 (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 -07003261 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003262 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003263 return true;
3264}
3265
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003266bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003267 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003268 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3269 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003270 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003271 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3272 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003273 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003274 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003275
3276 for (uint32_t j = 0; j < rect_count; j++) {
3277 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003278 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3279 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3280 "the current render pass instance.",
3281 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003282 }
3283
3284 if (image_view_state) {
3285 // The layers specified by a given element of pRects must be contained within every attachment that
3286 // pAttachments refers to
3287 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3288 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3289 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003290 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3291 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3292 "of pAttachment[%d].",
3293 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003294 }
3295 }
3296 }
3297 return skip;
3298}
3299
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003300bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3301 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003302 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003303 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003304 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003305 if (!cb_node) return skip;
3306
3307 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3308 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3309 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003310 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003311
3312 // Validate that attachment is in reference list of active subpass
3313 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003314 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003315 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003316 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003317 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003318 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003319
John Zulauf3a548ef2019-02-01 16:14:07 -07003320 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3321 auto clear_desc = &pAttachments[attachment_index];
3322 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003323 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003324
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003325 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3326 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3327 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3328 attachment_index);
3329 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3330 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3331 skip |=
3332 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3333 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3334 attachment_index);
3335 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003336 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3337 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3338 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3339 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003340 skip |= LogError(
3341 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3342 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3343 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3344 attachment_index, clear_desc->colorAttachment,
3345 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3346 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003347
John Zulauff2582972019-02-09 14:53:30 -07003348 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3349 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003350 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003351 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3352 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3353 " subpass %u. colorAttachmentCount=%u",
3354 attachment_index, clear_desc->colorAttachment,
3355 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3356 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003357 }
John Zulauff2582972019-02-09 14:53:30 -07003358 fb_attachment = color_attachment;
3359
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003360 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3361 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3362 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3363 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3364 "of a color attachment.",
3365 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003366 }
3367 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003368 bool subpass_depth = false;
3369 bool subpass_stencil = false;
3370 if (subpass_desc->pDepthStencilAttachment &&
3371 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3372 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3373 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3374 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3375 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003376 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003377 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3378 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003379 skip |= LogError(
3380 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3381 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003382 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003383 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003384 }
3385 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003386 skip |= LogError(
3387 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3388 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003389 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003390 attachment_index);
3391 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003392 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003393 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003394 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003395 if (subpass_depth) {
3396 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3397 "vkCmdClearAttachments()");
3398 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003399 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003400 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003401 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3402 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003403 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003404
3405 // Once the framebuffer attachment is found, can get the image view state
3406 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3407 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3408 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003409 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003410 if (image_view_state != nullptr) {
3411 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3412 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3413 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3414 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3415 }
3416 }
John Zulauf441558b2019-08-12 11:47:39 -06003417 }
3418 }
3419 return skip;
3420}
3421
3422void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3423 const VkClearAttachment *pAttachments, uint32_t rectCount,
3424 const VkClearRect *pRects) {
3425 auto *cb_node = GetCBState(commandBuffer);
3426 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003427 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3428 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003429 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3430 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3431 const auto clear_desc = &pAttachments[attachment_index];
3432 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3433 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3434 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3435 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3436 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3437 subpass_desc->pDepthStencilAttachment) {
3438 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3439 }
3440 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003441 if (!clear_rect_copy) {
3442 // We need a copy of the clear rectangles that will persist until the last lambda executes
3443 // but we want to create it as lazily as possible
3444 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003445 }
John Zulauf441558b2019-08-12 11:47:39 -06003446 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3447 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003448 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003449 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003450 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003451 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3452 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003453 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003454 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003455 return skip;
3456 };
3457 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003458 }
3459 }
3460 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003461}
3462
Jeff Leger178b1e52020-10-05 12:22:23 -04003463template <typename RegionType>
3464bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3465 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3466 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003467 const auto *cb_node = GetCBState(commandBuffer);
3468 const auto *src_image_state = GetImageState(srcImage);
3469 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003470 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3471 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3472 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3473 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003474
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003475 bool skip = false;
3476 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003477 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3478 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3479 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3480 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3481 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3482 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3483 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3484 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3485 skip |= InsideRenderPass(cb_node, func_name, vuid);
3486 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3487 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3488 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3489 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3490 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3491 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3492 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3493 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003494
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003495 // Validation for VK_EXT_fragment_density_map
3496 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003497 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3498 skip |= LogError(cb_node->commandBuffer, vuid,
3499 "%s: srcImage must not have been created with flags containing "
3500 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3501 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003502 }
3503 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003504 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3505 skip |= LogError(cb_node->commandBuffer, vuid,
3506 "%s: dstImage must not have been created with flags containing "
3507 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3508 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003509 }
3510
Cort Stratton7df30962018-05-17 19:45:57 -07003511 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003512 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003513 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3514 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003515 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003516 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3517 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3518 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003519 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003520 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3521 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3522 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3523 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3524 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3525 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003526 // For each region, the number of layers in the image subresource should not be zero
3527 // For each region, src and dest image aspect must be color only
3528 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003529 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003530 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3531 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003532 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3533 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3534 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003535 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003536 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3537 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003538 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003539 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3540 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3541 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3542 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3543 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3544 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003545 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003546 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3547 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003548 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003549 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003550
3551 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003552 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003553 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3554 skip |=
3555 LogError(cb_node->commandBuffer, vuid,
3556 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003557 }
Cort Stratton7df30962018-05-17 19:45:57 -07003558 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003559 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3560 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003561 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3562 skip |= LogError(cb_node->commandBuffer, vuid,
3563 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3564 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003565 }
3566
3567 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3568 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3569
3570 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003571 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003572 LogObjectList objlist(cb_node->commandBuffer);
3573 objlist.add(src_image_state->image);
3574 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003575 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3576 skip |= LogError(objlist, vuid,
3577 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003578 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003579 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003580 }
3581 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3582 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-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3586 skip |= LogError(objlist, vuid,
3587 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003588 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003589 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003590 }
3591 }
3592
3593 if (VK_IMAGE_TYPE_1D == src_image_type) {
3594 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3595 LogObjectList objlist(cb_node->commandBuffer);
3596 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003597 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3598 skip |= LogError(objlist, vuid,
3599 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003600 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003601 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3602 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003603 }
3604 }
3605 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3606 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3607 LogObjectList objlist(cb_node->commandBuffer);
3608 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003609 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3610 skip |= LogError(objlist, vuid,
3611 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003612 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003613 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3614 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003615 }
3616 }
3617
3618 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3619 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3620 LogObjectList objlist(cb_node->commandBuffer);
3621 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003622 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3623 skip |= LogError(objlist, vuid,
3624 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003625 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003626 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3627 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003628 }
3629 }
3630 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3631 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3632 LogObjectList objlist(cb_node->commandBuffer);
3633 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003634 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3635 skip |= LogError(objlist, vuid,
3636 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003637 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003638 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3639 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003640 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003641 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003642
3643 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3644 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3645 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3646 // developer
3647 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3648 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003649 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003650 LogObjectList objlist(cb_node->commandBuffer);
3651 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003652 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3653 skip |= LogError(objlist, vuid,
3654 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003655 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003656 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003657 region.extent.width, subresource_extent.width);
3658 }
3659
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003660 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003661 LogObjectList objlist(cb_node->commandBuffer);
3662 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003663 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3664 skip |= LogError(objlist, vuid,
3665 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003666 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003667 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003668 region.extent.height, subresource_extent.height);
3669 }
3670
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003671 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003672 LogObjectList objlist(cb_node->commandBuffer);
3673 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003674 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3675 skip |= LogError(objlist, vuid,
3676 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003677 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003678 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003679 region.extent.depth, subresource_extent.depth);
3680 }
3681 }
3682
3683 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3684 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3685 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3686 // developer
3687 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3688 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003689 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003690 LogObjectList objlist(cb_node->commandBuffer);
3691 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003692 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3693 skip |= LogError(objlist, vuid,
3694 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003695 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003696 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003697 region.extent.width, subresource_extent.width);
3698 }
3699
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003700 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003701 LogObjectList objlist(cb_node->commandBuffer);
3702 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003703 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3704 skip |= LogError(objlist, vuid,
3705 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003706 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003707 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003708 region.extent.height, subresource_extent.height);
3709 }
3710
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003711 if ((extent_check & kZBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003712 LogObjectList objlist(cb_node->commandBuffer);
3713 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003714 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3715 skip |= LogError(objlist, vuid,
3716 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003717 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003718 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003719 region.extent.depth, subresource_extent.depth);
3720 }
3721 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003722 }
3723
3724 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003725 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3726 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3727 func_name, string_VkFormat(src_image_state->createInfo.format),
3728 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003729 }
3730 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003731 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003732 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003733 string_VkImageType(src_image_state->createInfo.imageType),
3734 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003735 }
3736 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003737 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3738 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 -07003739 }
3740 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003741 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3742 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3743 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003744 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003745 } else {
3746 assert(0);
3747 }
3748 return skip;
3749}
3750
Jeff Leger178b1e52020-10-05 12:22:23 -04003751bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3752 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3753 const VkImageResolve *pRegions) const {
3754 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3755 COPY_COMMAND_VERSION_1);
3756}
3757
3758bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3759 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3760 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3761 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3762 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3763}
3764
3765template <typename RegionType>
3766bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3767 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3768 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003769 const auto *cb_node = GetCBState(commandBuffer);
3770 const auto *src_image_state = GetImageState(srcImage);
3771 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003772
Jeff Leger178b1e52020-10-05 12:22:23 -04003773 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3774 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3775 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3776
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003777 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003778 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003779 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003780 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003781 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003782 const char *vuid;
3783 const char *location;
3784 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3785 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3786 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3787 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3788 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3789 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3790 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3791 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3792 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3793 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3794 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3795 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3796 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3797 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3798 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3799 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3800 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3801 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3802 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3803 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3804 skip |= InsideRenderPass(cb_node, func_name, vuid);
3805 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3806 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3807 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3808 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3809 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3810 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3811 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3812 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3813 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3814 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003815
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003816 // Validation for VK_EXT_fragment_density_map
3817 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003818 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3819 skip |= LogError(cb_node->commandBuffer, vuid,
3820 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3821 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003822 }
3823 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003824 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3825 skip |= LogError(cb_node->commandBuffer, vuid,
3826 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3827 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003828 }
3829
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003830 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003831
Dave Houlton33c2d252017-06-09 17:08:32 -06003832 VkFormat src_format = src_image_state->createInfo.format;
3833 VkFormat dst_format = dst_image_state->createInfo.format;
3834 VkImageType src_type = src_image_state->createInfo.imageType;
3835 VkImageType dst_type = dst_image_state->createInfo.imageType;
3836
Cort Stratton186b1a22018-05-01 20:18:06 -04003837 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003838 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3839 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3840 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003841 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003842 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003843 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003844 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003845 }
3846
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003847 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003848 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3849 skip |= LogError(device, vuid,
3850 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003851 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003852 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003853 }
3854
3855 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003856 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3857 skip |= LogError(device, vuid,
3858 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003859 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003860 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003861 }
3862
Dave Houlton33c2d252017-06-09 17:08:32 -06003863 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003864 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3865 skip |= LogError(cb_node->commandBuffer, vuid,
3866 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003867 }
3868
Dave Houlton33c2d252017-06-09 17:08:32 -06003869 // Validate consistency for unsigned formats
3870 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3871 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003872 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003873 << "the other one must also have unsigned integer format. "
3874 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003875 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3876 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003877 }
3878
3879 // Validate consistency for signed formats
3880 if (FormatIsSInt(src_format) != FormatIsSInt(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 signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003883 << "the other one must also have signed 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-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3886 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003887 }
3888
3889 // Validate filter for Depth/Stencil formats
3890 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3891 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003892 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003893 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003894 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3895 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003896 }
3897
3898 // Validate aspect bits and formats for depth/stencil images
3899 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3900 if (src_format != dst_format) {
3901 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003902 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 -06003903 << "stencil, the other one must have exactly the same format. "
3904 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3905 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003906 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3907 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003908 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003909 } // Depth or Stencil
3910
3911 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003912 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003913 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3914 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3915 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3916 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3917 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3918 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003919 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003920 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3921 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3922 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3923 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3924 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3925 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003926 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003927 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003928 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003929 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003930 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003931 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3932 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003933 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003934 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3935 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3936 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3937 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3938 skip |=
3939 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3940 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3941 skip |=
3942 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3943 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003944 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003945 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3946 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003947 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003948 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003949 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003950 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3951 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003952 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003953 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003954 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003955 }
Dave Houlton48989f32017-05-26 15:01:46 -06003956 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3957 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003958 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003959 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003960 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003961 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003962
3963 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003964 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003965 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
3966 skip |=
3967 LogError(cb_node->commandBuffer, vuid,
3968 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003969 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003970
Dave Houlton48989f32017-05-26 15:01:46 -06003971 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003972 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
3973 skip |=
3974 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003975 }
Dave Houlton48989f32017-05-26 15:01:46 -06003976
Dave Houlton33c2d252017-06-09 17:08:32 -06003977 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003978 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
3979 skip |= LogError(cb_node->commandBuffer, vuid,
3980 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003981 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003982 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003983 }
3984
3985 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003986 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
3987 skip |= LogError(cb_node->commandBuffer, vuid,
3988 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3989 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003990 }
3991
Dave Houlton48989f32017-05-26 15:01:46 -06003992 // Validate source image offsets
3993 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003994 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003995 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003996 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
3997 skip |= LogError(cb_node->commandBuffer, vuid,
3998 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3999 "of (%1d, %1d). These must be (0, 1).",
4000 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004001 }
4002 }
4003
Dave Houlton33c2d252017-06-09 17:08:32 -06004004 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004005 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004006 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
4007 skip |= LogError(cb_node->commandBuffer, vuid,
4008 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4009 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4010 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004011 }
4012 }
4013
Dave Houlton33c2d252017-06-09 17:08:32 -06004014 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004015 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4016 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004017 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004018 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
4019 skip |= LogError(cb_node->commandBuffer, vuid,
4020 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4021 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004022 }
4023 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4024 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004025 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004026 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
4027 skip |= LogError(cb_node->commandBuffer, vuid,
4028 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4029 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004030 }
4031 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4032 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004033 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004034 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
4035 skip |= LogError(cb_node->commandBuffer, vuid,
4036 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4037 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004038 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004039 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004040 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4041 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4042 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004043 }
Dave Houlton48989f32017-05-26 15:01:46 -06004044
4045 // Validate dest image offsets
4046 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004047 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004048 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004049 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4050 skip |= LogError(cb_node->commandBuffer, vuid,
4051 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4052 "(%1d, %1d). These must be (0, 1).",
4053 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004054 }
4055 }
4056
Dave Houlton33c2d252017-06-09 17:08:32 -06004057 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004058 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004059 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4060 skip |= LogError(cb_node->commandBuffer, vuid,
4061 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004062 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004063 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004064 }
4065 }
4066
Dave Houlton33c2d252017-06-09 17:08:32 -06004067 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004068 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4069 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004070 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004071 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4072 skip |= LogError(cb_node->commandBuffer, vuid,
4073 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4074 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004075 }
4076 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4077 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004078 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004079 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4080 skip |= LogError(cb_node->commandBuffer, vuid,
4081 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4082 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004083 }
4084 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4085 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004086 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004087 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4088 skip |= LogError(cb_node->commandBuffer, vuid,
4089 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4090 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004091 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004092 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004093 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4094 skip |= LogError(cb_node->commandBuffer, vuid,
4095 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004096 }
4097
Dave Houlton33c2d252017-06-09 17:08:32 -06004098 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4099 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4100 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004101 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4102 skip |= LogError(cb_node->commandBuffer, vuid,
4103 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4104 "layerCount other than 1.",
4105 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004106 }
4107 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004108 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004109 } else {
4110 assert(0);
4111 }
4112 return skip;
4113}
4114
Jeff Leger178b1e52020-10-05 12:22:23 -04004115bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4116 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4117 const VkImageBlit *pRegions, VkFilter filter) const {
4118 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4119 COPY_COMMAND_VERSION_1);
4120}
4121
4122bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4123 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4124 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4125 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4126}
4127
4128template <typename RegionType>
4129void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4130 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4131 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004132 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004133 auto src_image_state = GetImageState(srcImage);
4134 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004135
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004136 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004137 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004138 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4139 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004140 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004141}
4142
Jeff Leger178b1e52020-10-05 12:22:23 -04004143void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4144 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4145 const VkImageBlit *pRegions, VkFilter filter) {
4146 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4147 pRegions, filter);
4148 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4149}
4150
4151void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4152 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4153 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4154 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4155 pBlitImageInfo->filter);
4156}
4157
John Zulauf2076e812020-01-08 14:55:54 -07004158GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4159 assert(map);
4160 // This approach allows for a single hash lookup or/create new
4161 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4162 if (inserted.second) {
4163 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004164 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004165 inserted.first->second.reset(layout_map);
4166 return layout_map;
4167 } else {
4168 assert(nullptr != inserted.first->second.get());
4169 return inserted.first->second.get();
4170 }
4171 return nullptr;
4172}
4173
4174const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4175 auto it = map.find(image);
4176 if (it != map.end()) {
4177 return it->second.get();
4178 }
4179 return nullptr;
4180}
4181
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004182// 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 -07004183bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4184 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004185 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004186 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004187 GlobalImageLayoutMap &overlay_layout_map = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004188 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004189 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004190 for (const auto &layout_map_entry : pCB->image_layout_map) {
4191 const auto image = layout_map_entry.first;
4192 const auto *image_state = GetImageState(image);
4193 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004194 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004195 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004196 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004197 if (initial_layout_map.empty()) continue;
4198
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004199 auto *overlay_map = GetLayoutRangeMap(&overlay_layout_map, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004200 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4201 if (global_map == nullptr) {
4202 global_map = &empty_map;
4203 }
4204
4205 // Note: don't know if it would matter
4206 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4207
4208 auto pos = initial_layout_map.begin();
4209 const auto end = initial_layout_map.end();
4210 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4211 pos->first.begin);
4212 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004213 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004214 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004215 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 -07004216 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004217 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004218 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004219 image_layout = current_layout->pos_B->lower_bound->second;
4220 }
4221 const auto intersected_range = pos->first & current_layout->range;
4222 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4223 // TODO: Set memory invalid which is in mem_tracker currently
4224 } else if (image_layout != initial_layout) {
4225 // Need to look up the inital layout *state* to get a bit more information
4226 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4227 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4228 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4229 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004230 // We can report all the errors for the intersected range directly
4231 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004232 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004233 skip |= LogError(
4234 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004235 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004236 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004237 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004238 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004239 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004240 }
4241 }
John Zulauf2076e812020-01-08 14:55:54 -07004242 if (pos->first.includes(intersected_range.end)) {
4243 current_layout.seek(intersected_range.end);
4244 } else {
4245 ++pos;
4246 if (pos != end) {
4247 current_layout.seek(pos->first.begin);
4248 }
4249 }
John Zulauff660ad62019-03-23 07:16:05 -06004250 }
4251
locke-lunargf155ccf2020-02-18 11:34:15 -07004252 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004253 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004254 }
John Zulauff660ad62019-03-23 07:16:05 -06004255
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004256 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004257}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004258
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004259void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004260 for (const auto &layout_map_entry : pCB->image_layout_map) {
4261 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004262 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004263 const auto *image_state = GetImageState(image);
4264 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004265 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4266 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004267 }
4268}
4269
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004270// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004271// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4272// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004273bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4274 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004275 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004276 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004277 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4278
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004279 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004280 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4281 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004282 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004283 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4284 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4285 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004286 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004287 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004288 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004289 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4290 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4291 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004292 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004293 string_VkImageLayout(first_layout));
4294 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4295 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004296 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004297 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004298 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004299 }
4300 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004301
4302 // Same as above for loadOp, but for stencilLoadOp
4303 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4304 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4305 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4306 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4307 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004308 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004309 string_VkImageLayout(first_layout));
4310 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4311 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4312 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004313 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004314 string_VkImageLayout(first_layout));
4315 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4316 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4317 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004318 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004319 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004320 }
4321 }
4322
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004323 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004324}
4325
Mark Lobodzinski96210742017-02-09 10:33:46 -07004326// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4327// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004328template <typename T1>
4329bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4330 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4331 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004332 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004333 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004334 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004335 if (strict) {
4336 correct_usage = ((actual & desired) == desired);
4337 } else {
4338 correct_usage = ((actual & desired) != 0);
4339 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004340
Mark Lobodzinski96210742017-02-09 10:33:46 -07004341 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004342 // All callers should have a valid VUID
4343 assert(msgCode != kVUIDUndefined);
4344 skip =
4345 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4346 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004347 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004348 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004349}
4350
4351// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4352// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004353bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004354 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004355 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004356 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004357}
4358
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004359bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004360 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004361 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004362 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4363 if ((image_format_features & desired) != desired) {
4364 // Same error, but more details if it was an AHB external format
4365 if (image_state->has_ahb_format == true) {
4366 skip |= LogError(image_state->image, vuid,
4367 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4368 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4369 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004370 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004371 } else {
4372 skip |= LogError(image_state->image, vuid,
4373 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4374 "with tiling %s.",
4375 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4376 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4377 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004378 }
4379 }
4380 return skip;
4381}
4382
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004383bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004384 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004385 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004386 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004387 // layerCount must not be zero
4388 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004389 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4390 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004391 }
4392 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004393 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004394 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4395 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004396 }
4397 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004398 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 -07004399 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4400 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4401 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4402 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004403 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004404 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4405 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4406 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4407 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4408 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4409 member);
4410 }
Cort Strattond619a302018-05-17 19:46:32 -07004411 return skip;
4412}
4413
Mark Lobodzinski96210742017-02-09 10:33:46 -07004414// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4415// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004416bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004417 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004418 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004419 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004420}
4421
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004422bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004423 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004424 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004425
4426 const VkDeviceSize &range = pCreateInfo->range;
4427 if (range != VK_WHOLE_SIZE) {
4428 // Range must be greater than 0
4429 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004430 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004431 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004432 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4433 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004434 }
4435 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004436 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4437 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004438 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004439 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004440 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4441 "(%" PRIu32 ").",
4442 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004443 }
4444 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004445 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004446 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004447 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004448 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4449 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4450 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004451 }
4452 // The sum of range and offset must be less than or equal to the size of buffer
4453 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004454 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004455 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004456 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4457 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4458 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004459 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004460 } else {
4461 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4462
4463 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4464 // VkPhysicalDeviceLimits::maxTexelBufferElements
4465 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4466 device_limits->maxTexelBufferElements) {
4467 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4468 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4469 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4470 "), divided by the element size of the format (%" PRIu32
4471 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4472 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4473 device_limits->maxTexelBufferElements);
4474 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004475 }
4476 return skip;
4477}
4478
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004479bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004480 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004481 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004482 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4483 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004484 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004485 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004486 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4487 "be supported for uniform texel buffers",
4488 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004489 }
4490 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4491 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004492 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004493 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004494 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4495 "be supported for storage texel buffers",
4496 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004497 }
4498 return skip;
4499}
4500
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004501bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004502 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004503 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004504
Dave Houltond8ed0212018-05-16 17:18:24 -06004505 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004506
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004507 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004508 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004509 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004510 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004511 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4512 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004513 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004514 }
4515 }
4516
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004517 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004518 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004519 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004520 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004521 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004522 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4523 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004524 }
4525 }
4526
Mike Schuchardt2df08912020-12-15 16:28:09 -08004527 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004528 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4529 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004530 skip |= LogError(
4531 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004532 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004533 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004534 }
4535
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004536 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004537 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4538 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4539 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004540 }
4541
sfricke-samsungedce77a2020-07-03 22:35:13 -07004542 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4543 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4544 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4545 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4546 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4547 }
4548 const VkBufferCreateFlags invalid_flags =
4549 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4550 if ((pCreateInfo->flags & invalid_flags) != 0) {
4551 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4552 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4553 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4554 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4555 }
4556 }
4557
Mark Lobodzinski96210742017-02-09 10:33:46 -07004558 return skip;
4559}
4560
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004561bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004562 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004563 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004564 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004565 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4566 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004567 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004568 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4569 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004570 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004571 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4572 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4573 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004574
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004575 // Buffer view offset must be less than the size of buffer
4576 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004577 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004578 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004579 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4580 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004581 }
4582
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004583 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004584 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4585 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4586 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004587 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4588 : "VUID-VkBufferViewCreateInfo-offset-00926";
4589 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004590 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004591 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4592 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004593 }
4594
4595 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004596 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4597 if ((element_size % 3) == 0) {
4598 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004599 }
4600 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004601 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004602 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4603 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004604 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004605 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004606 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004607 skip |= LogError(
4608 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004609 "vkCreateBufferView(): If buffer was created with usage containing "
4610 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004611 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4612 ") must be a multiple of the lesser of "
4613 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4614 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4615 "(%" PRId32
4616 ") is VK_TRUE, the size of a texel of the requested format. "
4617 "If the size of a texel is a multiple of three bytes, then the size of a "
4618 "single component of format is used instead",
4619 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4620 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4621 }
4622 }
4623 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004624 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004625 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4626 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004627 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004628 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004629 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004630 skip |= LogError(
4631 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004632 "vkCreateBufferView(): If buffer was created with usage containing "
4633 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004634 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4635 ") must be a multiple of the lesser of "
4636 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4637 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4638 "(%" PRId32
4639 ") is VK_TRUE, the size of a texel of the requested format. "
4640 "If the size of a texel is a multiple of three bytes, then the size of a "
4641 "single component of format is used instead",
4642 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4643 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4644 }
4645 }
4646 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004647
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004648 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004649
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004650 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004651 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004652 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004653}
4654
Mark Lobodzinski602de982017-02-09 11:01:33 -07004655// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004656bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004657 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004658 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004659 const IMAGE_STATE *image_state = GetImageState(image);
4660 // checks color format and (single-plane or non-disjoint)
4661 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004662 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004663 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004664 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 -07004665 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004666 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 -07004667 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004668 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004669 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004670 skip |= LogError(image, vuid,
4671 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4672 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4673 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004674 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004675 skip |= LogError(image, vuid,
4676 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4677 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4678 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004679 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004680 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004681 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004682 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 -07004683 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004684 skip |=
4685 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 -07004686 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004687 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004688 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004689 skip |=
4690 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 -07004691 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004692 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4693 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004694 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004695 } else if (FormatIsMultiplane(format)) {
4696 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4697 if (3 == FormatPlaneCount(format)) {
4698 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4699 }
4700 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004701 skip |=
4702 LogError(image, vuid,
4703 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4704 "set, where n = [0, 1, 2].",
4705 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004706 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004707 }
4708 return skip;
4709}
4710
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004711bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4712 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004713 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4714 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004715 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004716
4717 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004718 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004719 skip |= LogError(image, errorCodes.base_mip_err,
4720 "%s: %s.baseMipLevel (= %" PRIu32
4721 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4722 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004723 }
Petr Kraus4d718682017-05-18 03:38:41 +02004724
Petr Krausffa94af2017-08-08 21:46:02 +02004725 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4726 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004727 skip |=
4728 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004729 } else {
4730 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004731
Petr Krausffa94af2017-08-08 21:46:02 +02004732 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004733 skip |= LogError(image, errorCodes.mip_count_err,
4734 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4735 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4736 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4737 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004738 }
Petr Kraus4d718682017-05-18 03:38:41 +02004739 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004740 }
Petr Kraus4d718682017-05-18 03:38:41 +02004741
4742 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004743 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004744 skip |= LogError(image, errorCodes.base_layer_err,
4745 "%s: %s.baseArrayLayer (= %" PRIu32
4746 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4747 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004748 }
Petr Kraus4d718682017-05-18 03:38:41 +02004749
Petr Krausffa94af2017-08-08 21:46:02 +02004750 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4751 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004752 skip |=
4753 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004754 } else {
4755 const uint64_t necessary_layer_count =
4756 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004757
Petr Krausffa94af2017-08-08 21:46:02 +02004758 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004759 skip |= LogError(image, errorCodes.layer_count_err,
4760 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4761 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4762 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4763 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004764 }
Petr Kraus4d718682017-05-18 03:38:41 +02004765 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004766 }
Petr Kraus4d718682017-05-18 03:38:41 +02004767
Mark Lobodzinski602de982017-02-09 11:01:33 -07004768 return skip;
4769}
4770
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004771bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004772 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004773 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004774 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004775 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004776 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 +02004777
David McFarland2853f2f2020-11-30 15:50:39 -04004778 uint32_t image_layer_count;
4779
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004780 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004781 const auto layers = LayersFromRange(subresourceRange);
4782 const auto extent = GetImageSubresourceExtent(image_state, &layers);
4783 image_layer_count = extent.depth;
4784 } else {
4785 image_layer_count = image_state->createInfo.arrayLayers;
4786 }
4787
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004788 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004789
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004790 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4791 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4792 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4793 subresource_range_error_codes.base_layer_err =
4794 is_khr_maintenance1
4795 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4796 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4797 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4798 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4799 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4800 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004801
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004802 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004803 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004804 image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004805}
4806
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004807bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004808 const VkImageSubresourceRange &subresourceRange,
4809 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004810 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4811 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4812 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4813 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4814 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004815
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004816 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004817 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004818 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004819}
4820
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004821bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004822 const VkImageSubresourceRange &subresourceRange,
4823 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004824 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4825 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4826 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4827 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4828 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004829
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004830 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004831 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004832 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004833}
4834
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004835bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004836 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004837 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004838 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4839 subresource_range_error_codes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4840 subresource_range_error_codes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4841 subresource_range_error_codes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4842 subresource_range_error_codes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004843
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004844 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004845 cmd_name, param_name, "arrayLayers", image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004846}
4847
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004848bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4849 const VkImageUsageFlags image_usage) const {
4850 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4851 bool skip = false;
4852
4853 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4854 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4855
4856 if (image_state->has_ahb_format == true) {
4857 // AHB image view and image share same feature sets
4858 tiling_features = image_state->format_features;
4859 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4860 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4861 assert(device_extensions.vk_ext_image_drm_format_modifier);
4862 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4863 nullptr};
4864 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4865
4866 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4867 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4868 nullptr};
4869 format_properties_2.pNext = (void *)&drm_properties_list;
4870 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4871
4872 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4873 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4874 0) {
4875 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4876 }
4877 }
4878 } else {
4879 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4880 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4881 : format_properties.optimalTilingFeatures;
4882 }
4883
4884 if (tiling_features == 0) {
4885 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4886 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4887 "physical device.",
4888 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4889 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4890 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4891 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4892 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4893 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4894 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4895 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4896 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4897 "VK_IMAGE_USAGE_STORAGE_BIT.",
4898 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4899 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4900 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4901 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4902 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4903 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4904 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4905 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4906 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4907 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4908 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4909 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4910 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4911 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4912 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4913 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4914 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4915 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00004916 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
4917 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
4918 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
4919 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-04550",
4920 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4921 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
4922 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4923 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004924 }
4925
4926 return skip;
4927}
4928
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004929bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004930 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004931 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004932 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004933 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004934 skip |=
4935 ValidateImageUsageFlags(image_state,
4936 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4937 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004938 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4939 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4940 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004941 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004942 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004943 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004944 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004945 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004946 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004947 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004948 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004949
4950 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4951 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004952 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004953 VkFormat view_format = pCreateInfo->format;
4954 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004955 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004956 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004957
Dave Houltonbd2e2622018-04-10 16:41:14 -06004958 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004959 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004960 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004961 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004962 if (!device_extensions.vk_ext_separate_stencil_usage) {
4963 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004964 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4965 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4966 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004967 }
4968 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004969 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05004970 if (image_stencil_struct == nullptr) {
4971 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004972 skip |= LogError(
4973 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004974 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4975 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4976 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4977 }
4978 } else {
4979 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4980 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4981 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004982 skip |= LogError(
4983 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004984 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4985 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4986 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4987 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4988 }
4989 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4990 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004991 skip |= LogError(
4992 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004993 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4994 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4995 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4996 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4997 }
4998 }
4999 }
5000 }
5001
Dave Houltonbd2e2622018-04-10 16:41:14 -06005002 image_usage = chained_ivuci_struct->usage;
5003 }
5004
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005005 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5006 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005007 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005008 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005009 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005010 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005011 std::stringstream ss;
5012 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005013 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005014 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005015 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005016 }
5017 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005018 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005019 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5020 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005021 const char *error_vuid;
5022 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5023 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5024 } else if ((device_extensions.vk_khr_maintenance2) &&
5025 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5026 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5027 } else if ((!device_extensions.vk_khr_maintenance2) &&
5028 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5029 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5030 } else {
5031 // both enabled
5032 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5033 }
Dave Houltonc7988072018-04-16 11:46:56 -06005034 std::stringstream ss;
5035 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005036 << " is not in the same format compatibility class as "
5037 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005038 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5039 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005040 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005041 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005042 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005043 }
5044 } else {
5045 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005046 // Unless it is a multi-planar color bit aspect
5047 if ((image_format != view_format) &&
5048 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5049 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5050 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005051 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005052 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005053 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005054 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005055 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005056 }
5057 }
5058
5059 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005060 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005061
5062 switch (image_type) {
5063 case VK_IMAGE_TYPE_1D:
5064 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005065 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5066 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5067 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005068 }
5069 break;
5070 case VK_IMAGE_TYPE_2D:
5071 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5072 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5073 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005074 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5075 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5076 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005077 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005078 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5079 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5080 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005081 }
5082 }
5083 break;
5084 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005085 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005086 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5087 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005088 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005089 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005090 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5091 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5092 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005093 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5094 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005095 skip |= LogError(
5096 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5097 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5098 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5099 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5100 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005101 }
5102 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005103 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5104 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5105 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005106 }
5107 }
5108 } else {
5109 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005110 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5111 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5112 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005113 }
5114 }
5115 break;
5116 default:
5117 break;
5118 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005119
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005120 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005121 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005122 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005123 }
5124
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005125 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005126
Tobias Hector6663c9b2020-11-05 10:18:02 +00005127 if (enabled_features.shading_rate_image.shadingRateImage) {
5128 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5129 if (view_format != VK_FORMAT_R8_UINT) {
5130 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5131 "vkCreateImageView() If image was created with usage containing "
5132 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5133 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005134 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005135 }
5136
5137 if (enabled_features.shading_rate_image.shadingRateImage ||
5138 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5139 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5140 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5141 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5142 "vkCreateImageView() If image was created with usage containing "
5143 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5144 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5145 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005146 }
5147 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005148
Tobias Hector6663c9b2020-11-05 10:18:02 +00005149 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5150 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5151 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5152 pCreateInfo->subresourceRange.layerCount != 1) {
5153 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5154 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5155 pCreateInfo->subresourceRange.layerCount);
5156 }
5157
Jeff Bolz99e3f632020-03-24 22:59:22 -05005158 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5159 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5160 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5161 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5162 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5163 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5164 }
5165 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5166 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5167 skip |= LogError(
5168 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5169 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5170 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5171 }
5172 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005173
5174 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5175 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005176 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005177 "vkCreateImageView(): If image was created with usage containing "
5178 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5179 pCreateInfo->subresourceRange.levelCount);
5180 }
5181 }
5182 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5183 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005184 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005185 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5186 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5187 }
5188 } else {
5189 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5190 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5191 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005192 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005193 "vkCreateImageView(): If image was created with usage containing "
5194 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5195 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5196 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5197 }
5198 }
5199 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005200
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005201 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5202 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5203 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5204 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5205 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5206 }
5207 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5208 skip |=
5209 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5210 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5211 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5212 }
5213 }
5214 if (device_extensions.vk_ext_fragment_density_map_2) {
5215 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5216 (pCreateInfo->subresourceRange.layerCount >
5217 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5218 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5219 "vkCreateImageView(): If image was created with flags containing "
5220 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5221 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5222 pCreateInfo->subresourceRange.layerCount,
5223 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5224 }
5225 }
5226
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005227 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005228 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5229 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5230 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5231 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5232 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5233 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5234 }
5235 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005236
5237 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5238 // If swizzling is disabled, make sure it isn't used
5239 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5240 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5241 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5242 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5243 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5244 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5245 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5246 }
5247
5248 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5249 // disabled
5250 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5251 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5252 // spec. See Github issue #2361.
5253 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5254 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5255 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5256 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5257 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5258 "vkCreateImageView (portability error): ImageView format must have"
5259 " the same number of components and bits per component as the Image's format");
5260 }
5261 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005262 }
5263 return skip;
5264}
5265
Jeff Leger178b1e52020-10-05 12:22:23 -04005266template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005267bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005268 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005269 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005270 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5271 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5272 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005273
5274 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5275 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5276 VkDeviceSize src_min = UINT64_MAX;
5277 VkDeviceSize src_max = 0;
5278 VkDeviceSize dst_min = UINT64_MAX;
5279 VkDeviceSize dst_max = 0;
5280
5281 for (uint32_t i = 0; i < regionCount; i++) {
5282 src_min = std::min(src_min, pRegions[i].srcOffset);
5283 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5284 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5285 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5286
5287 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5288 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005289 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5290 skip |= LogError(src_buffer_state->buffer, vuid,
5291 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5292 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005293 }
5294
5295 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5296 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005297 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5298 skip |= LogError(dst_buffer_state->buffer, vuid,
5299 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5300 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005301 }
5302
5303 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5304 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005305 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5306 skip |= LogError(src_buffer_state->buffer, vuid,
5307 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005308 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005309 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005310 }
5311
5312 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5313 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005314 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5315 skip |= LogError(dst_buffer_state->buffer, vuid,
5316 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005317 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005318 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005319 }
5320 }
5321
5322 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5323 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5324 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005325 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5326 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5327 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005328 }
5329 }
5330
5331 return skip;
5332}
5333
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005334bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005335 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005336 const auto cb_node = GetCBState(commandBuffer);
5337 const auto src_buffer_state = GetBufferState(srcBuffer);
5338 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005339
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005340 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005341 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5342 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005343 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005344 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005345 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5346 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005347 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005348 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5349 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005350 skip |=
5351 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5352 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005353 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5354 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005355 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005356 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5357 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5358 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005359 return skip;
5360}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005361
Jeff Leger178b1e52020-10-05 12:22:23 -04005362bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5363 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5364 const auto cb_node = GetCBState(commandBuffer);
5365 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5366 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5367
5368 bool skip = false;
5369 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5370 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5371 // Validate that SRC & DST buffers have correct usage flags set
5372 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5373 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5374 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5375 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5376 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5377 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5378 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5379 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5380 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5381 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5382 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5383 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5384 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5385 skip |=
5386 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5387 skip |=
5388 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5389 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5390 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5391 return skip;
5392}
5393
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005394bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005395 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005396 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005397 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005398 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005399 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5400 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005401 }
5402 }
5403 return skip;
5404}
5405
Jeff Bolz5c801d12019-10-09 10:38:45 -05005406bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5407 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005408 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005409 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005410
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005411 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005412 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005413 skip |=
5414 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005415 }
5416 return skip;
5417}
5418
Jeff Bolz5c801d12019-10-09 10:38:45 -05005419bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005420 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005421
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005422 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005423 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005424 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005425 }
5426 return skip;
5427}
5428
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005429bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005430 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005431 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005432 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005433 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005434 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005435 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005436 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005437 }
5438 return skip;
5439}
5440
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005441bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005442 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005443 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005444 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005445 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005446 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005447 skip |=
5448 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5449 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005450 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005451 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005452 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5453 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005454 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005455
sfricke-samsung022fa252020-07-24 03:26:16 -07005456 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5457 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5458
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005459 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005460 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5461 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5462 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5463 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005464 }
5465
5466 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005467 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5468 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5469 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5470 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005471 }
5472
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005473 return skip;
5474}
5475
Jeff Leger178b1e52020-10-05 12:22:23 -04005476template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005477bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005478 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005479 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005480 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005481 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5482 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005483
sfricke-samsung125d2b42020-05-28 06:32:43 -07005484 assert(image_state != nullptr);
5485 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005486
5487 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005488 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005489 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5490 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005491 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005492 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5493 "and 1, respectively.",
5494 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005495 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005496 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005497
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005498 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5499 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005500 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005501 "%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 -07005502 "must be 0 and 1, respectively.",
5503 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005504 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005505 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005506
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005507 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5508 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005509 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005510 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005511 "For 3D images these must be 0 and 1, respectively.",
5512 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005513 }
5514 }
5515
5516 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005517 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08005518 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
5519 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07005520
sfricke-samsung8feecc12021-01-23 03:28:38 -08005521 if (FormatIsDepthOrStencil(image_format)) {
5522 if (SafeModulo(bufferOffset, 4) != 0) {
5523 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
5524 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5525 " must be a multiple 4 if using a depth/stencil format (%s).",
5526 function, i, bufferOffset, string_VkFormat(image_format));
5527 }
5528 } else {
5529 // If not depth/stencil and not multi-plane
5530 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
5531 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5532 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
5533 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
5534 skip |= LogError(image_state->image, vuid,
5535 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5536 " must be a multiple of this format's texel size (%" PRIu32 ").",
5537 function, i, bufferOffset, element_size);
5538 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005539 }
5540
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005541 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5542 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005543 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005544 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005545 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005546 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005547 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005548 }
5549
5550 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5551 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005552 vuid =
5553 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04005554 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] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5557 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005558 }
5559
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005560 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005561 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005562 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005563 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 -06005564 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5565 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005566 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005567 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005568 "zero or <= image subresource width (%d).",
5569 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005570 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005571 }
5572
5573 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005574 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 -06005575 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5576 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005577 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005578 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005579 "zero or <= image subresource height (%d).",
5580 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005581 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005582 }
5583
5584 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005585 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 -06005586 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5587 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005588 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005589 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005590 "zero or <= image subresource depth (%d).",
5591 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005592 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005593 }
5594
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005595 // subresource aspectMask must have exactly 1 bit set
5596 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005597 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005598 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005599 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5600 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005601 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005602 }
5603
5604 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005605 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005606 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005607 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005608 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5609 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005610 }
5611
5612 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005613 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5614 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005615
5616 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005617 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005618 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005619 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005620 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5621 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005622 }
5623
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005624 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005625 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005626 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005627 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005628 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005629 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005630 }
5631
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005632 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005633 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5634 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5635 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005636 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005637 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005638 "width & height (%d, %d)..",
5639 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5640 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005641 }
5642
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005643 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005644 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08005645 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005646 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005647 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005648 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
sfricke-samsung8feecc12021-01-23 03:28:38 -08005649 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005650 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005651
5652 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005653 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005654 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005655 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005656 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005657 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005658 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5659 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5660 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005661 }
5662
5663 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005664 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005665 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005666 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005667 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005668 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5669 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5670 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005671 }
5672
5673 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005674 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005675 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005676 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005677 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005678 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5679 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5680 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005681 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005682 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005683
5684 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005685 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005686 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005687 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005688 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005689 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005690 "format has three planes.",
5691 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005692 }
5693
5694 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005695 if (0 ==
5696 (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 -07005697 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005698 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005699 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5700 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005701 } else {
5702 // Know aspect mask is valid
5703 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5704 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08005705 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005706 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005707 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005708 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005709 " 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 -08005710 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07005711 string_VkFormat(compatible_format));
5712 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005713 }
5714 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08005715
5716 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5717 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5718 assert(command_pool != nullptr);
5719 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5720 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5721 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
5722 LogObjectList objlist(cb_node->commandBuffer);
5723 objlist.add(command_pool->commandPool);
5724 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
5725 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5726 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
5727 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
5728 "VK_QUEUE_COMPUTE_BIT flag.",
5729 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5730 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
5731 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005732 }
5733
5734 return skip;
5735}
5736
Jeff Leger178b1e52020-10-05 12:22:23 -04005737template <typename BufferImageCopyRegionType>
5738bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5739 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005740 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005741 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005742
5743 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005744 VkExtent3D extent = pRegions[i].imageExtent;
5745 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005746
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005747 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5748 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005749 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5750 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5751 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005752 }
5753
5754 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5755
5756 // 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 -06005757 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005758 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005759 if (image_extent.width % block_extent.width) {
5760 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5761 }
5762 if (image_extent.height % block_extent.height) {
5763 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5764 }
5765 if (image_extent.depth % block_extent.depth) {
5766 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5767 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005768 }
5769
Dave Houltonfc1a4052017-04-27 14:32:45 -06005770 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005771 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005772 }
5773 }
5774
5775 return skip;
5776}
5777
Jeff Leger178b1e52020-10-05 12:22:23 -04005778template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005779bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005780 const BufferImageCopyRegionType *pRegions, const char *func_name,
5781 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005782 bool skip = false;
5783
5784 VkDeviceSize buffer_size = buff_state->createInfo.size;
5785
5786 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005787 VkDeviceSize max_buffer_offset =
5788 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5789 if (buffer_size < max_buffer_offset) {
5790 skip |=
5791 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 -07005792 }
5793 }
5794
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005795 return skip;
5796}
5797
Jeff Leger178b1e52020-10-05 12:22:23 -04005798template <typename BufferImageCopyRegionType>
5799bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5800 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5801 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005802 const auto cb_node = GetCBState(commandBuffer);
5803 const auto src_image_state = GetImageState(srcImage);
5804 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005805
Jeff Leger178b1e52020-10-05 12:22:23 -04005806 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5807 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5808 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5809 const char *vuid;
5810
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005811 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005812
5813 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005814 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005815
5816 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005817 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005818
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005819 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005820
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005821 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005822 vuid =
5823 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5824 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5825 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5826 "or transfer capabilities.",
5827 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005828 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005829 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5830 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5831 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5832 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005833
Jeff Leger178b1e52020-10-05 12:22:23 -04005834 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5835 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5836 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5837
5838 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5839 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5840 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5841 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005842
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005843 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005844 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5845 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005846 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005847 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5848 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005849 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005850 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5851 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5852 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5853 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5854 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5855 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005856
5857 // Validation for VK_EXT_fragment_density_map
5858 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005859 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5860 skip |= LogError(cb_node->commandBuffer, vuid,
5861 "%s: srcImage must not have been created with flags containing "
5862 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5863 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005864 }
5865
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005866 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005867 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5868 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005869 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005870 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5871 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005872 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005873
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005874 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 -04005875 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5876 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5877 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5878 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5879
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005880 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005881 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5882 vuid =
5883 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005884 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005885 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5886 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5887 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5888 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5889 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5890 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5891 "imageSubresource", vuid);
5892 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5893 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005894 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005895 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005896 }
5897 return skip;
5898}
5899
Jeff Leger178b1e52020-10-05 12:22:23 -04005900bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5901 VkBuffer dstBuffer, uint32_t regionCount,
5902 const VkBufferImageCopy *pRegions) const {
5903 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5904 COPY_COMMAND_VERSION_1);
5905}
5906
5907bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5908 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5909 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5910 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5911 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5912}
5913
John Zulauf1686f232019-07-09 16:27:11 -06005914void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5915 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5916 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5917
5918 auto cb_node = GetCBState(commandBuffer);
5919 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005920 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005921 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005922 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005923 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005924}
5925
Jeff Leger178b1e52020-10-05 12:22:23 -04005926void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5927 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5928 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5929
5930 auto cb_node = GetCBState(commandBuffer);
5931 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5932 // Make sure that all image slices record referenced layout
5933 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5934 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5935 pCopyImageToBufferInfo->srcImageLayout);
5936 }
5937}
5938
5939template <typename RegionType>
5940bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5941 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5942 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005943 const auto cb_node = GetCBState(commandBuffer);
5944 const auto src_buffer_state = GetBufferState(srcBuffer);
5945 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005946
Jeff Leger178b1e52020-10-05 12:22:23 -04005947 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5948 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5949 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5950 const char *vuid;
5951
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005952 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005953
5954 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005955 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005956
sfricke-samsungea4fd142020-10-17 23:51:59 -07005957 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5958 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5959
Jeff Leger178b1e52020-10-05 12:22:23 -04005960 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5961 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5962 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5963 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5964
5965 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5966 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5967 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5968 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5969 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5970 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5971 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5972 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5973 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005974 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005975 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5976 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005977 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005978 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5979 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5980 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5981 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5982 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5983 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005984
5985 // Validation for VK_EXT_fragment_density_map
5986 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005987 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5988 skip |= LogError(cb_node->commandBuffer, vuid,
5989 "%s: dstImage must not have been created with flags containing "
5990 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5991 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005992 }
5993
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005994 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005995 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
5996 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005997 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005998 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
5999 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06006000 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006001
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006002 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 -04006003 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6004 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6005 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6006 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6007
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006008 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006009 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6010 vuid =
6011 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006012 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006013 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6014 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6015 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6016 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6017 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6018 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6019 "imageSubresource", vuid);
6020 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6021 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006022 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006023 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006024
6025 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6026 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6027 assert(command_pool != nullptr);
6028 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6029 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6030 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6031 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6032 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
6033 LogObjectList objlist(cb_node->commandBuffer);
6034 objlist.add(command_pool->commandPool);
6035 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6036 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
6037 skip |= LogError(dst_image_state->image, vuid,
6038 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6039 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6040 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
6041 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6042 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6043 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006044 }
6045 return skip;
6046}
6047
Jeff Leger178b1e52020-10-05 12:22:23 -04006048bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6049 VkImageLayout dstImageLayout, uint32_t regionCount,
6050 const VkBufferImageCopy *pRegions) const {
6051 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6052 COPY_COMMAND_VERSION_1);
6053}
6054
6055bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6056 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6057 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6058 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6059 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6060}
6061
John Zulauf1686f232019-07-09 16:27:11 -06006062void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6063 VkImageLayout dstImageLayout, uint32_t regionCount,
6064 const VkBufferImageCopy *pRegions) {
6065 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6066
6067 auto cb_node = GetCBState(commandBuffer);
6068 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006069 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006070 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006071 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006072 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006073}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006074
Jeff Leger178b1e52020-10-05 12:22:23 -04006075void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6076 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6077 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6078
6079 auto cb_node = GetCBState(commandBuffer);
6080 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6081 // Make sure that all image slices are record referenced layout
6082 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6083 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6084 pCopyBufferToImageInfo2KHR->dstImageLayout);
6085 }
6086}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006087bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006088 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006089 bool skip = false;
6090 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6091
Dave Houlton1d960ff2018-01-19 12:17:05 -07006092 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006093 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6094 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6095 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006096 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6097 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006098 }
6099
John Zulaufa26d3c82019-08-14 16:09:08 -06006100 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006101 if (!image_entry) {
6102 return skip;
6103 }
6104
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006105 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6106 if (device_extensions.vk_ext_image_drm_format_modifier) {
6107 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6108 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006109 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6110 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6111 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006112 }
6113 } else {
6114 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006115 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6116 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006117 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006118 }
6119
Dave Houlton1d960ff2018-01-19 12:17:05 -07006120 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006121 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006122 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6123 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6124 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006125 }
6126
Dave Houlton1d960ff2018-01-19 12:17:05 -07006127 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006128 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006129 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6130 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6131 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006132 }
6133
Dave Houlton1d960ff2018-01-19 12:17:05 -07006134 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006135 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006136 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6137 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006138 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006139 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6140 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006141 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006142 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6143 }
6144 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006145 skip |= LogError(image, vuid,
6146 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6147 ") must be a single-plane specifier flag.",
6148 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006149 }
6150 } else if (FormatIsColor(img_format)) {
6151 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006152 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6153 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6154 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006155 }
6156 } else if (FormatIsDepthOrStencil(img_format)) {
6157 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6158 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006159 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006160 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6161 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6162 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6163 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006164 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6165 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6166 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006167 }
6168 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006169
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006170 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006171 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006172 }
6173
Mike Weiblen672b58b2017-02-21 14:32:53 -07006174 return skip;
6175}
sfricke-samsung022fa252020-07-24 03:26:16 -07006176
6177// Validates the image is allowed to be protected
6178bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006179 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006180 bool skip = false;
6181 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6182 LogObjectList objlist(cb_state->commandBuffer);
6183 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006184 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 -07006185 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006186 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006187 }
6188 return skip;
6189}
6190
6191// Validates the image is allowed to be unprotected
6192bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006193 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006194 bool skip = false;
6195 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6196 LogObjectList objlist(cb_state->commandBuffer);
6197 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006198 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 -07006199 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006200 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006201 }
6202 return skip;
6203}
6204
6205// Validates the buffer is allowed to be protected
6206bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006207 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006208 bool skip = false;
6209 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6210 LogObjectList objlist(cb_state->commandBuffer);
6211 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006212 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 -07006213 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006214 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006215 }
6216 return skip;
6217}
6218
6219// Validates the buffer is allowed to be unprotected
6220bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006221 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006222 bool skip = false;
6223 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6224 LogObjectList objlist(cb_state->commandBuffer);
6225 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006226 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 -07006227 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006228 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006229 }
6230 return skip;
6231}