blob: a3d7bfbd380d1a97dffb9bfe388892379d906d09 [file] [log] [blame]
sfricke-samsung552d5e12020-01-07 22:00:20 -08001/* Copyright (c) 2015-2020 The Khronos Group Inc.
2 * Copyright (c) 2015-2020 Valve Corporation
3 * Copyright (c) 2015-2020 LunarG, Inc.
4 * Copyright (C) 2015-2020 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",
154 }}
155 };
156 // clang-format on
157
158 uint8_t index = 0;
159 index |= (image_to_buffer) ? 0x1 : 0;
160 index |= (copy2) ? 0x2 : 0;
161 return copy_imagebuffer_vuid.at(id).at(index);
162}
163
David McFarland2853f2f2020-11-30 15:50:39 -0400164// Transfer VkImageSubresourceRange into VkImageSubresourceLayers struct
165static VkImageSubresourceLayers LayersFromRange(const VkImageSubresourceRange &subresource_range) {
166 VkImageSubresourceLayers subresource_layers;
167 subresource_layers.aspectMask = subresource_range.aspectMask;
168 subresource_layers.baseArrayLayer = subresource_range.baseArrayLayer;
169 subresource_layers.layerCount = subresource_range.layerCount;
170 subresource_layers.mipLevel = subresource_range.baseMipLevel;
171 return subresource_layers;
172}
173
John Zulauff660ad62019-03-23 07:16:05 -0600174// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
175static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
176 VkImageSubresourceRange subresource_range;
177 subresource_range.aspectMask = subresource_layers.aspectMask;
178 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
179 subresource_range.layerCount = subresource_layers.layerCount;
180 subresource_range.baseMipLevel = subresource_layers.mipLevel;
181 subresource_range.levelCount = 1;
182 return subresource_range;
183}
184
John Zulaufb58415b2019-12-09 15:02:32 -0700185static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
186 const auto format = create_info.format;
187 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200188
189#ifdef VK_USE_PLATFORM_ANDROID_KHR
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700190 const VkExternalFormatANDROID *external_format_android = lvl_find_in_chain<VkExternalFormatANDROID>(&create_info);
191 bool is_external_format_conversion = (external_format_android != nullptr && external_format_android->externalFormat != 0);
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200192#else
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700193 bool is_external_format_conversion = false;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200194#endif
195
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700196 if (FormatIsColor(format) || FormatIsMultiplane(format) || is_external_format_conversion) {
John Zulaufb58415b2019-12-09 15:02:32 -0700197 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
198 } else {
199 init_range.aspectMask =
200 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
201 }
202 return NormalizeSubresourceRange(create_info, init_range);
203}
204
locke-lunarg296a3c92020-03-25 01:04:29 -0600205IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -0600206 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -0700207 safe_create_info(pCreateInfo),
208 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -0600209 valid(false),
210 acquired(false),
211 shared_presentable(false),
212 layout_locked(false),
213 get_sparse_reqs_called(false),
214 sparse_metadata_required(false),
215 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -0600216 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700217 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -0600218 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700219 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -0600220 create_from_swapchain(VK_NULL_HANDLE),
221 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -0600222 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700223 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -0700224 disjoint(false),
225 plane0_memory_requirements_checked(false),
226 plane1_memory_requirements_checked(false),
227 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -0600228 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -0600229 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -0600230 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
unknown08c57af2019-06-21 16:33:35 -0600231 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600232 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700233 uint32_t *queue_family_indices = new uint32_t[createInfo.queueFamilyIndexCount];
John Zulauff660ad62019-03-23 07:16:05 -0600234 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700235 queue_family_indices[i] = pCreateInfo->pQueueFamilyIndices[i];
John Zulauff660ad62019-03-23 07:16:05 -0600236 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700237 createInfo.pQueueFamilyIndices = queue_family_indices;
John Zulauff660ad62019-03-23 07:16:05 -0600238 }
239
240 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
241 sparse = true;
242 }
Locked8af3732019-05-10 09:47:56 -0600243
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700244 auto *external_memory_info = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
245 if (external_memory_info) {
246 external_memory_handle = external_memory_info->handleTypes;
sfricke-samsunge2441192019-11-06 14:07:57 -0800247 }
John Zulauff660ad62019-03-23 07:16:05 -0600248}
249
unknown2c877272019-07-11 12:56:50 -0600250bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
251 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
252 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
253 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
254 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
255 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
256 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600257 return is_equal &&
258 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600259}
260
Jeff Bolz82f854d2019-09-17 14:56:47 -0500261// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
262bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
263 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
264 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
265 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
266 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
267 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600268 is_compatible = is_compatible &&
269 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
270 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500271
272 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
273 createInfo.extent.height <= other_createInfo.extent.height &&
274 createInfo.extent.depth <= other_createInfo.extent.depth &&
275 createInfo.arrayLayers <= other_createInfo.arrayLayers;
276 return is_compatible;
277}
278
unknown2c877272019-07-11 12:56:50 -0600279bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700280 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700281 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700282 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700283 }
locke-lunarg5f59e782019-12-19 10:32:23 -0700284 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
285 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600286 IsCreateInfoEqual(other_image_state->createInfo)) {
287 return true;
288 }
unknowne1661522019-07-11 13:04:18 -0600289 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
290 return true;
291 }
unknown2c877272019-07-11 12:56:50 -0600292 return false;
293}
294
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500295IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
296 : image_view(iv),
297 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700298 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600299 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500300 samplerConversion(VK_NULL_HANDLE),
301 image_state(im) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700302 auto *conversion_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
303 if (conversion_info) samplerConversion = conversion_info->conversion;
John Zulauff660ad62019-03-23 07:16:05 -0600304 if (image_state) {
305 // A light normalization of the createInfo range
306 auto &sub_res_range = create_info.subresourceRange;
307 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
308 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
309
310 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700311 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500312 samples = image_state->createInfo.samples;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200313
314 if (image_state->has_ahb_format) {
315 // When the image has a external format the views format must be VK_FORMAT_UNDEFINED and it is required to use a sampler
316 // Ycbcr conversion. Thus we can't extract any meaningful information from the format parameter. As a Sampler Ycbcr
317 // conversion must be used the shader type is always float.
318 descriptor_format_bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
319 } else {
320 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
321 }
John Zulauff660ad62019-03-23 07:16:05 -0600322 }
323}
324
locke-lunarg540b2252020-08-03 13:23:36 -0600325bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600326 if (image_view == compare_view.image_view) {
327 return true;
328 }
locke-lunargdc287022020-08-21 12:03:57 -0600329 if (image_state->image != compare_view.image_state->image) {
330 return false;
331 }
locke-lunarg540b2252020-08-03 13:23:36 -0600332 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
333 return false;
334 }
335
336 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600337 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600338 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600339 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600340 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600341 }
342
343 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600344 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600345 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600346 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600347 }
348
349 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600350 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600351 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600352 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600353 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600354 }
355
356 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600357 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600358 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600359 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600360 }
locke-lunargdc287022020-08-21 12:03:57 -0600361 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600362}
363
Dave Houltond9611312018-11-19 17:03:36 -0700364uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
365 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700366 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700367}
368
369uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
370
371uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
372
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500373bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700374 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700375 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700376
John Zulauf2076e812020-01-08 14:55:54 -0700377 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
378 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700379 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
380 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
381
John Zulauf2076e812020-01-08 14:55:54 -0700382 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
383
384 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
385 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700386 return false;
387 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700388
John Zulauf2076e812020-01-08 14:55:54 -0700389 for (auto entry : *layout_range_map) {
390 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700391 }
392 return true;
393}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700394
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600395// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600396void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600397 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
398 VkImageLayout expected_layout) {
399 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
400 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600401 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600402 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700403 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700404 for (const auto &image : image_state.aliasing_images) {
405 auto alias_state = GetImageState(image);
406 // The map state of the aliases should all be in sync, so no need to check the return value
407 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
408 assert(subresource_map);
409 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
410 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700411}
John Zulauff660ad62019-03-23 07:16:05 -0600412
413// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600414void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600415 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500416 return;
417 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500418 IMAGE_STATE *image_state = view_state.image_state.get();
419 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700420 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700421 for (const auto &image : image_state->aliasing_images) {
422 image_state = GetImageState(image);
423 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
424 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
425 }
John Zulauff660ad62019-03-23 07:16:05 -0600426}
427
428// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600429void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600430 const VkImageSubresourceRange &range, VkImageLayout layout) {
431 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
432 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600433 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700434 for (const auto &image : image_state.aliasing_images) {
435 auto alias_state = GetImageState(image);
436 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
437 assert(subresource_map);
438 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
439 }
John Zulauff660ad62019-03-23 07:16:05 -0600440}
441
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600442void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600443 VkImageLayout layout) {
444 const IMAGE_STATE *image_state = GetImageState(image);
445 if (!image_state) return;
446 SetImageInitialLayout(cb_node, *image_state, range, layout);
447};
448
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600449void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600450 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
451 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600452}
Dave Houltonddd65c52018-05-08 14:58:01 -0600453
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600454// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700455void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
456 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500457 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600458
John Zulauff660ad62019-03-23 07:16:05 -0600459 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600460 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
461 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600462 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 -0600463 sub_range.baseArrayLayer = 0;
464 sub_range.layerCount = image_state->createInfo.extent.depth;
465 }
466
Piers Daniell4fde9b72019-11-27 16:19:46 -0700467 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
468 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
469 SetImageLayout(cb_node, *image_state, sub_range, layout);
470 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
471 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
472 } else {
473 SetImageLayout(cb_node, *image_state, sub_range, layout);
474 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600475}
476
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700477bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
478 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700479 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600480 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100481 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700482 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100483 const char *vuid;
484 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700485 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100486
487 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600488 LogObjectList objlist(image);
489 objlist.add(renderpass);
490 objlist.add(framebuffer);
491 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700492 skip |=
493 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
494 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
495 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
496 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100497 return skip;
498 }
499
500 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200501 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
502 if (stencil_usage_info) {
503 image_usage |= stencil_usage_info->stencilUsage;
504 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100505
506 // Check for layouts that mismatch image usages in the framebuffer
507 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800508 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600509 LogObjectList objlist(image);
510 objlist.add(renderpass);
511 objlist.add(framebuffer);
512 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700513 skip |= LogError(objlist, vuid,
514 "%s: Layout/usage mismatch for attachment %u in %s"
515 " - the %s is %s but the image attached to %s via %s"
516 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
517 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
518 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
519 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100520 }
521
522 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
523 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800524 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600525 LogObjectList objlist(image);
526 objlist.add(renderpass);
527 objlist.add(framebuffer);
528 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700529 skip |= LogError(objlist, vuid,
530 "%s: Layout/usage mismatch for attachment %u in %s"
531 " - the %s is %s but the image attached to %s via %s"
532 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
533 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
534 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
535 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100536 }
537
538 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800539 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600540 LogObjectList objlist(image);
541 objlist.add(renderpass);
542 objlist.add(framebuffer);
543 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700544 skip |= LogError(objlist, vuid,
545 "%s: Layout/usage mismatch for attachment %u in %s"
546 " - the %s is %s but the image attached to %s via %s"
547 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
548 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
549 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
550 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100551 }
552
553 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800554 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600555 LogObjectList objlist(image);
556 objlist.add(renderpass);
557 objlist.add(framebuffer);
558 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700559 skip |= LogError(objlist, vuid,
560 "%s: Layout/usage mismatch for attachment %u in %s"
561 " - the %s is %s but the image attached to %s via %s"
562 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
563 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
564 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
565 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100566 }
567
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600568 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100569 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
570 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
571 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
572 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
573 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800574 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600575 LogObjectList objlist(image);
576 objlist.add(renderpass);
577 objlist.add(framebuffer);
578 objlist.add(image_view);
579 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700580 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700581 " - the %s is %s but the image attached to %s via %s"
582 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700583 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700584 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
585 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100586 }
587 } else {
588 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
589 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
590 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
591 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600592 LogObjectList objlist(image);
593 objlist.add(renderpass);
594 objlist.add(framebuffer);
595 objlist.add(image_view);
596 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700597 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700598 " - the %s is %s but the image attached to %s via %s"
599 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700600 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700601 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
602 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100603 }
604 }
605 return skip;
606}
607
John Zulauf17a01bb2019-08-09 16:41:19 -0600608bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700609 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600610 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600611 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700612 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
613 auto const &framebuffer_info = framebuffer_state->createInfo;
614 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100615
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700616 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100617 auto framebuffer = framebuffer_state->framebuffer;
618
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700619 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700620 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
621 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700622 }
John Zulauf8e308292018-09-21 11:34:37 -0600623
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700624 const auto *attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
625 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachment_info != nullptr) {
626 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100627 }
628
Tobias Hectorc9057422019-07-23 12:15:52 +0100629 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700630 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
631 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100632 auto image_view = attachments[i];
633 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100634
Tobias Hectorc9057422019-07-23 12:15:52 +0100635 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600636 LogObjectList objlist(pRenderPassBegin->renderPass);
637 objlist.add(framebuffer_state->framebuffer);
638 objlist.add(image_view);
639 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700640 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
641 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
642 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100643 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100644 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100645
646 const VkImage image = view_state->create_info.image;
647 const IMAGE_STATE *image_state = GetImageState(image);
648
649 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600650 LogObjectList objlist(pRenderPassBegin->renderPass);
651 objlist.add(framebuffer_state->framebuffer);
652 objlist.add(image_view);
653 objlist.add(image);
654 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700655 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
656 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
657 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100658 continue;
659 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700660 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
661 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100662
Piers Daniell7f894f62020-01-09 16:33:48 -0700663 // Default to expecting stencil in the same layout.
664 auto attachment_stencil_initial_layout = attachment_initial_layout;
665
666 // If a separate layout is specified, look for that.
667 const auto *attachment_description_stencil_layout =
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700668 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700669 if (attachment_description_stencil_layout) {
670 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
671 }
672
Tobias Hectorc9057422019-07-23 12:15:52 +0100673 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
674 // in common with the non-const version.)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700675 const ImageSubresourceLayoutMap *subresource_map = (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED)
676 ? GetImageSubresourceLayoutMap(const_p_cb, image)
677 : nullptr;
Tobias Hectorc9057422019-07-23 12:15:52 +0100678
679 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
680 LayoutUseCheckAndMessage layout_check(subresource_map);
681 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700682 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700683 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
684 // the next "constant value" range
685 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700686 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700687
John Zulauf5e617452019-11-19 14:44:16 -0700688 // Allow for differing depth and stencil layouts
689 VkImageLayout check_layout = attachment_initial_layout;
690 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
691
692 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700693 subres_skip |= LogError(
694 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700695 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
696 "and the %s layout of the attachment is %s. The layouts must match, or the render "
697 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700698 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100699 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700700 }
John Zulauf5e617452019-11-19 14:44:16 -0700701
Tobias Hectorc9057422019-07-23 12:15:52 +0100702 skip |= subres_skip;
703 }
704
705 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
706 framebuffer, render_pass, i, "initial layout");
707
708 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
709 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100710 }
711
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700712 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
713 auto &subpass = render_pass_info->pSubpasses[j];
714 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100715 auto &attachment_ref = subpass.pInputAttachments[k];
716 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
717 auto image_view = attachments[attachment_ref.attachment];
718 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100719
Tobias Hectorc9057422019-07-23 12:15:52 +0100720 if (view_state) {
721 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700722 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
723 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100724 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100725 }
726 }
727 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100728
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700729 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100730 auto &attachment_ref = subpass.pColorAttachments[k];
731 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
732 auto image_view = attachments[attachment_ref.attachment];
733 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100734
Tobias Hectorc9057422019-07-23 12:15:52 +0100735 if (view_state) {
736 auto image = view_state->create_info.image;
737 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
738 framebuffer, render_pass, attachment_ref.attachment,
739 "color attachment layout");
740 if (subpass.pResolveAttachments) {
741 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
742 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
743 attachment_ref.attachment, "resolve attachment layout");
744 }
745 }
746 }
747 }
748
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700749 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100750 auto &attachment_ref = *subpass.pDepthStencilAttachment;
751 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
752 auto image_view = attachments[attachment_ref.attachment];
753 auto view_state = GetImageViewState(image_view);
754
755 if (view_state) {
756 auto image = view_state->create_info.image;
757 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
758 framebuffer, render_pass, attachment_ref.attachment,
759 "input attachment layout");
760 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100761 }
762 }
763 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700764 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600765 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700766}
767
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600768void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700769 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700770 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinski8d46f802020-12-07 16:33:54 -0700771 IMAGE_VIEW_STATE *image_view = GetActiveAttachmentImageViewState(pCB, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600772 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700773 VkImageLayout stencil_layout = kInvalidLayout;
774 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
775 if (attachment_reference_stencil_layout) {
776 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
777 }
778
779 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600780 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700781 }
782}
783
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600784void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
785 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700786 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700787
788 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700789 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700790 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700791 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700792 }
793 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700794 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700795 }
796 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700797 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700798 }
799 }
800}
801
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700802// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
803// 1. Transition into initialLayout state
804// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600805void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700806 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700807 // First transition into initialLayout
808 auto const rpci = render_pass_state->createInfo.ptr();
809 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -0700810 auto *view_state = GetActiveAttachmentImageViewState(cb_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600811 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700812 VkImageLayout stencil_layout = kInvalidLayout;
813 const auto *attachment_description_stencil_layout =
814 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
815 if (attachment_description_stencil_layout) {
816 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
817 }
818
819 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600820 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700821 }
822 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700823 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700824}
825
Dave Houlton10b39482017-03-16 13:18:15 -0600826bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600827 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600828 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600829 }
830 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600831 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600832 }
833 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600834 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600835 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700836 if (0 !=
837 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
838 if (FormatPlaneCount(format) == 1) return false;
839 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600840 return true;
841}
842
Mike Weiblen62d08a32017-03-07 22:18:27 -0700843// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200844bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
845 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600846 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700847 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200848 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600849 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700850
851 switch (layout) {
852 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
853 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600854 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700855 }
856 break;
857 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
858 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600859 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700860 }
861 break;
862 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
863 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600864 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700865 }
866 break;
867 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
868 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600869 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700870 }
871 break;
872 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
873 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600874 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700875 }
876 break;
877 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
878 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600879 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700880 }
881 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600882 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500883 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
884 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
885 }
886 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700887 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
888 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
889 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
890 }
891 break;
892 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
893 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
894 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
895 }
896 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700897 default:
898 // Other VkImageLayout values do not have VUs defined in this context.
899 break;
900 }
901
Dave Houlton8e9f6542018-05-18 12:18:22 -0600902 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700903 skip |= LogError(img_barrier.image, msg_code,
904 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
905 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
906 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700907 }
908 return skip;
909}
910
911// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600912bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
913 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700914 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700915
Petr Krausad0096a2019-08-09 18:35:04 +0200916 // Scoreboard for checking for duplicate and inconsistent barriers to images
917 struct ImageBarrierScoreboardEntry {
918 uint32_t index;
919 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
920 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
921 const VkImageMemoryBarrier *barrier;
922 };
923 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
924 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
925
John Zulauf463c51e2018-05-31 13:29:20 -0600926 // Scoreboard for duplicate layout transition barriers within the list
927 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
928 ImageBarrierScoreboardImageMap layout_transitions;
929
Mike Weiblen62d08a32017-03-07 22:18:27 -0700930 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200931 const auto &img_barrier = pImageMemoryBarriers[i];
932 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700933
John Zulauf463c51e2018-05-31 13:29:20 -0600934 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
935 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
936 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200937 if (img_barrier.oldLayout != img_barrier.newLayout) {
938 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
939 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600940 if (image_it != layout_transitions.end()) {
941 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200942 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600943 if (subres_it != subres_map.end()) {
944 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200945 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
946 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
947 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700948 skip = LogError(
949 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200950 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600951 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
952 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200953 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
954 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
955 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600956 }
957 entry = new_entry;
958 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200959 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600960 }
961 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200962 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600963 }
964 }
965
Petr Krausad0096a2019-08-09 18:35:04 +0200966 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600967 if (image_state) {
968 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200969 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
970 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600971
972 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
973 if (image_state->layout_locked) {
974 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700975 skip |= LogError(
976 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700977 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600978 " 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 -0700979 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200980 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600981 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600982
John Zulaufa4472282019-08-22 14:44:34 -0600983 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700984 const VkFormat image_format = image_create_info.format;
985 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600986 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700987 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700988 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600989 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
990 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700991 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
992 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
993 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
994 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700995 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600996 }
997 } else {
998 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
999 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -07001000 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
1001 ? "VUID-VkImageMemoryBarrier-image-03320"
1002 : "VUID-VkImageMemoryBarrier-image-01207";
1003 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001004 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
1005 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1006 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001007 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001008 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001009 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001010 }
John Zulauff660ad62019-03-23 07:16:05 -06001011
Petr Krausad0096a2019-08-09 18:35:04 +02001012 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1013 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001014 // TODO: Set memory invalid which is in mem_tracker currently
1015 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1016 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001017 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001018 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001019 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001020 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001021 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1022 // the next "constant value" range
1023 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001024 const auto &value = *pos;
1025 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001026 subres_skip = LogError(
1027 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001028 "%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 -07001029 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001030 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -07001031 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1032 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001033 }
John Zulauf5e617452019-11-19 14:44:16 -07001034 }
John Zulauff660ad62019-03-23 07:16:05 -06001035 skip |= subres_skip;
1036 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001037
1038 // checks color format and (single-plane or non-disjoint)
1039 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1040 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001041 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001042 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1043 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
1044 ? "VUID-VkImageMemoryBarrier-image-01671"
1045 : "VUID-VkImageMemoryBarrier-image-02902";
1046 skip |= LogError(img_barrier.image, vuid,
1047 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1048 "but its aspectMask is 0x%" PRIx32 ".",
1049 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1050 string_VkFormat(image_format), aspect_mask);
1051 }
1052 }
1053
1054 VkImageAspectFlags valid_disjoint_mask =
1055 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 -07001056 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001057 ((aspect_mask & valid_disjoint_mask) == 0)) {
1058 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1059 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1060 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1061 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1062 string_VkFormat(image_format), aspect_mask);
1063 }
1064
1065 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1066 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1067 "%s: Image barrier %s references %s of format %s has only two planes but included "
1068 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1069 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1070 string_VkFormat(image_format), aspect_mask);
1071 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001072 }
1073 }
1074 return skip;
1075}
1076
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001077bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001078 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001079
Jeff Bolz6835fda2019-10-06 00:15:34 -05001080 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001081 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001082}
1083
John Zulauf6b4aae82018-05-09 13:03:36 -06001084template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001085bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1086 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001087 using BarrierRecord = QFOTransferBarrier<Barrier>;
1088 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001089 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001090 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1091 const char *barrier_name = BarrierRecord::BarrierName();
1092 const char *handle_name = BarrierRecord::HandleName();
1093 const char *transfer_type = nullptr;
1094 for (uint32_t b = 0; b < barrier_count; b++) {
1095 if (!IsTransferOp(&barriers[b])) continue;
1096 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001097 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001098 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001099 const auto found = barrier_sets.release.find(barriers[b]);
1100 if (found != barrier_sets.release.cend()) {
1101 barrier_record = &(*found);
1102 transfer_type = "releasing";
1103 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001104 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001105 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001106 const auto found = barrier_sets.acquire.find(barriers[b]);
1107 if (found != barrier_sets.acquire.cend()) {
1108 barrier_record = &(*found);
1109 transfer_type = "acquiring";
1110 }
1111 }
1112 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001113 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1114 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1115 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1116 func_name, barrier_name, b, transfer_type, handle_name,
1117 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1118 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001119 }
1120 }
1121 return skip;
1122}
1123
John Zulaufa4472282019-08-22 14:44:34 -06001124VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1125 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1126}
1127
1128const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1129 return device_state.GetImageState(barrier.image);
1130}
1131
1132VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1133 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1134}
1135
1136const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1137 return device_state.GetBufferState(barrier.buffer);
1138}
1139
1140VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1141
John Zulauf6b4aae82018-05-09 13:03:36 -06001142template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001143void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1144 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001145 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001146 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1147 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001148 auto &barrier = barriers[b];
1149 if (IsTransferOp(&barrier)) {
1150 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001151 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001152 barrier_sets.release.emplace(barrier);
1153 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001154 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001155 barrier_sets.acquire.emplace(barrier);
1156 }
1157 }
1158
1159 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1160 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1161 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1162 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1163 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1164 auto handle_state = BarrierHandleState(*this, barrier);
1165 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1166 if (!mode_concurrent) {
1167 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001168 cb_state->queue_submit_functions.emplace_back(
1169 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1170 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1171 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1172 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001173 });
1174 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001175 }
1176 }
1177}
1178
John Zulaufa4472282019-08-22 14:44:34 -06001179bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001180 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001181 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001182 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001183 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001184 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1185 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001186 return skip;
1187}
1188
John Zulaufa4472282019-08-22 14:44:34 -06001189void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1190 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1191 const VkImageMemoryBarrier *pImageMemBarriers) {
1192 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1193 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001194}
1195
1196template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001197bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001198 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001199 // Record to the scoreboard or report that we have a duplication
1200 bool skip = false;
1201 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1202 if (!inserted.second && inserted.first->second != cb_state) {
1203 // 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 -06001204 LogObjectList objlist(cb_state->commandBuffer);
1205 objlist.add(barrier.handle);
1206 objlist.add(inserted.first->second->commandBuffer);
1207 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001208 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1209 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1210 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1211 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1212 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001213 }
1214 return skip;
1215}
1216
1217template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001218bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1219 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001220 using BarrierRecord = QFOTransferBarrier<Barrier>;
1221 using TypeTag = typename BarrierRecord::Tag;
1222 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001223 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001224 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001225 const char *barrier_name = BarrierRecord::BarrierName();
1226 const char *handle_name = BarrierRecord::HandleName();
1227 // No release should have an extant duplicate (WARNING)
1228 for (const auto &release : cb_barriers.release) {
1229 // Check the global pending release barriers
1230 const auto set_it = global_release_barriers.find(release.handle);
1231 if (set_it != global_release_barriers.cend()) {
1232 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1233 const auto found = set_for_handle.find(release);
1234 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001235 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1236 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1237 " to dstQueueFamilyIndex %" PRIu32
1238 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1239 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1240 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001241 }
1242 }
1243 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1244 }
1245 // Each acquire must have a matching release (ERROR)
1246 for (const auto &acquire : cb_barriers.acquire) {
1247 const auto set_it = global_release_barriers.find(acquire.handle);
1248 bool matching_release_found = false;
1249 if (set_it != global_release_barriers.cend()) {
1250 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1251 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1252 }
1253 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001254 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1255 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1256 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1257 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1258 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001259 }
1260 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1261 }
1262 return skip;
1263}
1264
John Zulauf3b04ebd2019-07-18 14:08:11 -06001265bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001266 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001267 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001268 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001269 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1270 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001271 return skip;
1272}
1273
1274template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001275void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001276 using BarrierRecord = QFOTransferBarrier<Barrier>;
1277 using TypeTag = typename BarrierRecord::Tag;
1278 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001279 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001280
1281 // Add release barriers from this submit to the global map
1282 for (const auto &release : cb_barriers.release) {
1283 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1284 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1285 global_release_barriers[release.handle].insert(release);
1286 }
1287
1288 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1289 for (const auto &acquire : cb_barriers.acquire) {
1290 // NOTE: We're not using [] because we don't want to create entries for missing releases
1291 auto set_it = global_release_barriers.find(acquire.handle);
1292 if (set_it != global_release_barriers.end()) {
1293 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1294 set_for_handle.erase(acquire);
1295 if (set_for_handle.size() == 0) { // Clean up empty sets
1296 global_release_barriers.erase(set_it);
1297 }
1298 }
1299 }
1300}
1301
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001302void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001303 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1304 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001305}
1306
John Zulauf6b4aae82018-05-09 13:03:36 -06001307// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001308void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001309
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001310void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001311 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001312 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001313 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001314
Chris Forbes4de4b132017-08-21 11:27:08 -07001315 // For ownership transfers, the barrier is specified twice; as a release
1316 // operation on the yielding queue family, and as an acquire operation
1317 // on the acquiring queue family. This barrier may also include a layout
1318 // transition, which occurs 'between' the two operations. For validation
1319 // purposes it doesn't seem important which side performs the layout
1320 // transition, but it must not be performed twice. We'll arbitrarily
1321 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001322 //
1323 // However, we still need to record initial layout for the "initial layout" validation
1324 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001325
Petr Krausad0096a2019-08-09 18:35:04 +02001326 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001327 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001328 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001329 }
1330}
1331
unknown86bcb3a2019-07-11 13:05:36 -06001332void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001333 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001334 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1335 const auto &image_create_info = image_state->createInfo;
1336
1337 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1338 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1339 // for all (potential) layer sub_resources.
1340 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1341 normalized_isr.baseArrayLayer = 0;
1342 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1343 }
1344
Michael Spang8af7c102020-05-03 20:50:09 -04001345 VkImageLayout initial_layout = mem_barrier.oldLayout;
1346
1347 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001348 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001349 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1350 }
1351
John Zulauf2be3fe02019-12-30 09:48:02 -07001352 if (is_release_op) {
1353 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1354 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001355 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001356 }
unknown86bcb3a2019-07-11 13:05:36 -06001357}
1358
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001359bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1360 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1361 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1362 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001363 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001364 assert(cb_node);
1365 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001366 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001367 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001368
John Zulauff660ad62019-03-23 07:16:05 -06001369 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1370 if (subresource_map) {
1371 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001372 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001373 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1374 // the next "constant value" range
1375 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001376 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001377 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001378 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1379 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1380 "%s layout %s.",
1381 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1382 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1383 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001384 }
John Zulauf5e617452019-11-19 14:44:16 -07001385 }
John Zulauff660ad62019-03-23 07:16:05 -06001386 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001387 }
John Zulauff660ad62019-03-23 07:16:05 -06001388
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001389 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1390 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1391 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001392 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1393 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001394 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1395 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1396 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001397 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001398 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001399 if (image_state->shared_presentable) {
1400 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001401 skip |=
1402 LogError(device, layout_invalid_msg_code,
1403 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1404 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001405 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001406 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001407 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001408 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001409 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1410 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1411 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1412 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001413 }
1414 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001415 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001416}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001417bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001418 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1419 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001420 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001421 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1422 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1423}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001424
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001425void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001426 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001427 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1428 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001429
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001430 const VkRenderPassCreateInfo2KHR *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001431 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001432 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001433 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001434 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001435 VkImageLayout stencil_layout = kInvalidLayout;
1436 const auto *attachment_description_stencil_layout =
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001437 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001438 if (attachment_description_stencil_layout) {
1439 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1440 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001441 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001442 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001443 }
1444 }
1445}
Dave Houltone19e20d2018-02-02 16:32:41 -07001446
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001447#ifdef VK_USE_PLATFORM_ANDROID_KHR
1448// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1449// This could also move into a seperate core_validation_android.cpp file... ?
1450
1451//
1452// AHB-specific validation within non-AHB APIs
1453//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001454bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001455 bool skip = false;
1456
1457 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1458 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001459 if (0 != ext_fmt_android->externalFormat) {
1460 if (VK_FORMAT_UNDEFINED != create_info->format) {
1461 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001462 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1463 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1464 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001465 }
1466
1467 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001468 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1469 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1470 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001471 }
1472
1473 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001474 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1475 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001476 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1477 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1478 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001479 }
1480
1481 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001482 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1483 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1484 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001485 }
1486 }
1487
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001488 if ((0 != ext_fmt_android->externalFormat) &&
1489 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001490 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001491 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1492 ") which has "
1493 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1494 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001495 }
1496 }
1497
Dave Houltond9611312018-11-19 17:03:36 -07001498 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001499 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001500 skip |=
1501 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1502 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1503 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001504 }
1505 }
1506
1507 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1508 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1509 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001510 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001511 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1512 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1513 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1514 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001515 }
1516
1517 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001518 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1519 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1520 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1521 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1522 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001523 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001524 }
1525
1526 return skip;
1527}
1528
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001529bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001530 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001531 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001532
1533 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001534 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001535 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1536 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001537 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001538 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001539 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001540
Dave Houltond9611312018-11-19 17:03:36 -07001541 // Chain must include a compatible ycbcr conversion
1542 bool conv_found = false;
1543 uint64_t external_format = 0;
1544 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1545 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001546 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001547 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001548 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001549 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001550 }
Dave Houltond9611312018-11-19 17:03:36 -07001551 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001552 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001553 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001554 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1555 "an externalFormat (%" PRIu64
1556 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1557 "with the same external format.",
1558 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001559 }
1560
1561 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001562 if (IsIdentitySwizzle(create_info->components) == false) {
1563 skip |= LogError(
1564 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1565 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1566 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1567 "= %s.",
1568 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1569 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001570 }
1571 }
Dave Houltond9611312018-11-19 17:03:36 -07001572
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001573 return skip;
1574}
1575
John Zulaufa26d3c82019-08-14 16:09:08 -06001576bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001577 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001578
John Zulaufa26d3c82019-08-14 16:09:08 -06001579 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001580 if (image_state != nullptr) {
1581 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1582 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1583 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1584 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1585 "bound to memory.");
1586 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001587 }
1588 return skip;
1589}
1590
1591#else
1592
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001593bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001594 return false;
1595}
1596
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001597bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001598
John Zulaufa26d3c82019-08-14 16:09:08 -06001599bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001600
1601#endif // VK_USE_PLATFORM_ANDROID_KHR
1602
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001603bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1604 bool skip = false;
1605
1606 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1607 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1608 const VkImageTiling image_tiling = pCreateInfo->tiling;
1609 const VkFormat image_format = pCreateInfo->format;
1610
1611 if (image_format == VK_FORMAT_UNDEFINED) {
1612 // VU 01975 states format can't be undefined unless an android externalFormat
1613#ifdef VK_USE_PLATFORM_ANDROID_KHR
1614 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1615 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1616 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1617 if (it != ahb_ext_formats_map.end()) {
1618 tiling_features = it->second;
1619 }
1620 }
1621#endif
1622 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1623 uint64_t drm_format_modifier = 0;
1624 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1625 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1626 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1627 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1628
1629 if (drm_explicit != nullptr) {
1630 drm_format_modifier = drm_explicit->drmFormatModifier;
1631 } else {
1632 // VUID 02261 makes sure its only explict or implict in parameter checking
1633 assert(drm_implicit != nullptr);
1634 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1635 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1636 }
1637 }
1638
1639 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1640 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1641 nullptr};
1642 format_properties_2.pNext = (void *)&drm_properties_list;
1643 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001644 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1645 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1646 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1647 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001648
1649 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1650 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1651 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1652 }
1653 }
1654 } else {
1655 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1656 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1657 : format_properties.optimalTilingFeatures;
1658 }
1659
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001660 // Lack of disjoint format feature support while using the flag
1661 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1662 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1663 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1664 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1665 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1666 string_VkFormat(pCreateInfo->format));
1667 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001668
1669 return skip;
1670}
1671
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001672bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001673 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001674 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001675
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001676 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001677 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001678 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1679 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001680 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1681 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001682 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001683 }
1684
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001685 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1686 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001687 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1688 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1689 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001690 }
1691
1692 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001693 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1694 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1695 "height (%d) and arrayLayers (%d) must be >= 6.",
1696 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001697 }
Dave Houlton130c0212018-01-29 13:39:56 -07001698 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001699
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001700 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001701 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1702 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1703 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001704 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1705 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1706 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001707 }
1708
1709 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001710 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1711 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1712 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001713 }
1714
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001715 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001716 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1717 static_cast<float>(device_limits->maxFramebufferWidth) /
1718 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001719 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1720 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001721 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1722 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1723 "ceiling of device "
1724 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1725 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1726 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001727 }
1728
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001729 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1730 static_cast<float>(device_limits->maxFramebufferHeight) /
1731 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001732 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1733 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001734 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1735 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1736 "ceiling of device "
1737 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1738 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1739 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001740 }
1741 }
1742
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001743 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001744 VkResult result = VK_SUCCESS;
1745 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1746 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1747 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1748 &format_limits);
1749 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001750 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1751 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1752 if (modifier_list) {
1753 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1754 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1755 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1756 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1757 image_format_info.type = pCreateInfo->imageType;
1758 image_format_info.format = pCreateInfo->format;
1759 image_format_info.tiling = pCreateInfo->tiling;
1760 image_format_info.usage = pCreateInfo->usage;
1761 image_format_info.flags = pCreateInfo->flags;
1762 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1763
1764 result =
1765 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1766 format_limits = image_format_properties.imageFormatProperties;
1767
1768 /* The application gives a list of modifier and the driver
1769 * selects one. If one is wrong, stop there.
1770 */
1771 if (result != VK_SUCCESS) break;
1772 }
1773 } else if (explicit_modifier) {
1774 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1775 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1776 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1777 image_format_info.type = pCreateInfo->imageType;
1778 image_format_info.format = pCreateInfo->format;
1779 image_format_info.tiling = pCreateInfo->tiling;
1780 image_format_info.usage = pCreateInfo->usage;
1781 image_format_info.flags = pCreateInfo->flags;
1782 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1783
1784 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1785 format_limits = image_format_properties.imageFormatProperties;
1786 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001787 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001788
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001789 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1790 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1791 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1792 if (result != VK_SUCCESS) {
1793 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001794#ifdef VK_USE_PLATFORM_ANDROID_KHR
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001795 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001796#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001797 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001798 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001799 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1800 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001801#ifdef VK_USE_PLATFORM_ANDROID_KHR
1802 }
1803#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001804 } else {
1805 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1806 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001807 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1808 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1809 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001810 }
Dave Houlton130c0212018-01-29 13:39:56 -07001811
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001812 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1813 static_cast<uint64_t>(pCreateInfo->extent.height) *
1814 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1815 static_cast<uint64_t>(pCreateInfo->samples);
1816 uint64_t total_size =
1817 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07001818
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001819 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001820 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1821 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001822 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001823
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001824 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001825 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1826 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1827 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1828 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001829 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001830
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001831 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001832 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1833 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1834 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001835 }
1836
1837 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001838 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1839 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1840 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001841 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001842
1843 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1844 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1845 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1846 pCreateInfo->extent.width, format_limits.maxExtent.width);
1847 }
1848
1849 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1850 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1851 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1852 pCreateInfo->extent.height, format_limits.maxExtent.height);
1853 }
1854
1855 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1856 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1857 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1858 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1859 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001860 }
1861
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001862 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001863 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1864 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1865 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1866 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001867 skip |= LogError(device, error_vuid,
1868 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1869 "YCbCr Conversion format, arrayLayers must be 1",
1870 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001871 }
1872
1873 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001874 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1875 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1876 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001877 }
1878
1879 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001880 skip |= LogError(
1881 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001882 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1883 string_VkSampleCountFlagBits(pCreateInfo->samples));
1884 }
1885
1886 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001887 skip |= LogError(
1888 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001889 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1890 string_VkImageType(pCreateInfo->imageType));
1891 }
1892 }
1893
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001894 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001895 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001896 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001897 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001898 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1899 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1900 "format must be block, ETC or ASTC compressed, but is %s",
1901 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001902 }
1903 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001904 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1905 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1906 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001907 }
1908 }
1909 }
1910
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001911 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001912 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1913 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1914 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001915 }
1916
unknown2c877272019-07-11 12:56:50 -06001917 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1918 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1919 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001920 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1921 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1922 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001923 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001924
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001925 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1926 if (swapchain_create_info != nullptr) {
1927 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1928 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1929 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1930
1931 // Validate rest of Swapchain Image create check that require swapchain state
1932 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1933 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1934 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1935 skip |= LogError(
1936 device, vuid,
1937 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1938 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1939 }
1940 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1941 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1942 skip |= LogError(device, vuid,
1943 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1944 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1945 }
1946 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1947 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1948 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1949 skip |= LogError(device, vuid,
1950 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1951 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1952 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1953 }
1954 }
1955 }
1956
sfricke-samsungedce77a2020-07-03 22:35:13 -07001957 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1958 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1959 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1960 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1961 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1962 }
1963 const VkImageCreateFlags invalid_flags =
1964 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1965 if ((pCreateInfo->flags & invalid_flags) != 0) {
1966 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1967 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1968 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1969 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1970 }
1971 }
1972
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001973 skip |= ValidateImageFormatFeatures(pCreateInfo);
1974
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07001975 // Check compatibility with VK_KHR_portability_subset
1976 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
1977 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
1978 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
1979 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
1980 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
1981 }
1982 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
1983 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
1984 skip |=
1985 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
1986 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
1987 }
1988 }
1989
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001990 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001991}
1992
John Zulauf7eeb6f72019-06-17 11:56:36 -06001993void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1994 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1995 if (VK_SUCCESS != result) return;
1996
1997 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001998 auto image_state = Get<IMAGE_STATE>(*pImage);
1999 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002000}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002001
Jeff Bolz5c801d12019-10-09 10:38:45 -05002002bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002003 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06002004 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002005 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002006 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002007 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002008 }
2009 return skip;
2010}
2011
John Zulauf7eeb6f72019-06-17 11:56:36 -06002012void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2013 // Clean up validation specific data
2014 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002015
locke-lunargcba7d5f2019-12-30 16:59:11 -07002016 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002017
2018 // Clean up generic image state
2019 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002020}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002021
sfricke-samsungcd924d92020-05-20 23:51:17 -07002022bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2023 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002024 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002025 const VkImage image = image_state->image;
2026 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002027
2028 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002029 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2030 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002031 }
2032
sfricke-samsungcd924d92020-05-20 23:51:17 -07002033 if (FormatIsDepthOrStencil(format)) {
2034 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2035 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2036 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2037 } else if (FormatIsCompressed(format)) {
2038 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2039 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2040 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002041 }
2042
2043 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002044 skip |=
2045 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2046 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2047 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002048 }
2049 return skip;
2050}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002051
John Zulauf07288512019-07-05 11:09:50 -06002052bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2053 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2054 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002055 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002056 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2057 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002058 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2059 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2060 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002061 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002062
2063 } else {
2064 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2065 if (!device_extensions.vk_khr_shared_presentable_image) {
2066 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002067 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2068 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2069 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002070 }
2071 } else {
2072 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2073 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002074 skip |= LogError(
2075 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002076 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2077 func_name, string_VkImageLayout(dest_image_layout));
2078 }
2079 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002080 }
2081
John Zulauff660ad62019-03-23 07:16:05 -06002082 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002083 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002084 if (subresource_map) {
2085 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002086 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002087 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002088 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2089 // the next "constant value" range
2090 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002091 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002092 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2093 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2094 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2095 } else {
2096 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002097 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002098 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2099 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2100 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2101 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002102 }
John Zulauf5e617452019-11-19 14:44:16 -07002103 }
John Zulauff660ad62019-03-23 07:16:05 -06002104 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002105 }
2106
2107 return skip;
2108}
2109
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002110bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2111 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002112 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002113 bool skip = false;
2114 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002115 const auto *cb_node = GetCBState(commandBuffer);
2116 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002117 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002118 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002119 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002120 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002121 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002122 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002123 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2124 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002125 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002126 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002127 skip |=
2128 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2129 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2130 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002131 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002132 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002133 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002134 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002135 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002136 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002137 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2138 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2139 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2140 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2141 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2142 string_VkFormat(image_state->createInfo.format));
2143 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002144 }
2145 return skip;
2146}
2147
John Zulaufeabb4462019-07-05 14:13:03 -06002148void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2149 const VkClearColorValue *pColor, uint32_t rangeCount,
2150 const VkImageSubresourceRange *pRanges) {
2151 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2152
2153 auto cb_node = GetCBState(commandBuffer);
2154 auto image_state = GetImageState(image);
2155 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002156 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002157 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002158 }
2159 }
2160}
2161
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002162bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2163 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002164 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002165 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002166
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002167 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002168 const auto *cb_node = GetCBState(commandBuffer);
2169 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002170 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002171 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002172 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002173 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002174 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002175 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002176 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002177 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002178 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002179 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002180 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002181 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002182 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2183 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2184 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2185 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002186
2187 bool any_include_aspect_depth_bit = false;
2188 bool any_include_aspect_stencil_bit = false;
2189
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002190 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002191 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002192 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002193 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002194 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002195 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2196 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002197 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2198 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2199 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2200 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002201 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002202 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2203 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002204 if (FormatHasDepth(image_format) == false) {
2205 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2206 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2207 "doesn't have a depth component.",
2208 i, string_VkFormat(image_format));
2209 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002210 }
2211 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2212 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002213 if (FormatHasStencil(image_format) == false) {
2214 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2215 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2216 "%s doesn't have a stencil component.",
2217 i, string_VkFormat(image_format));
2218 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002219 }
2220 }
2221 if (any_include_aspect_stencil_bit) {
2222 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2223 if (image_stencil_struct != nullptr) {
2224 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2225 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002226 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2227 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2228 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2229 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002230 }
2231 } else {
2232 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002233 skip |= LogError(
2234 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002235 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2236 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2237 "in VkImageCreateInfo::usage used to create image");
2238 }
2239 }
2240 }
2241 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002242 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2243 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2244 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002245 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002246 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002247 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2248 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002249 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002250 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002251 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002252 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2253 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2254 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2255 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002256 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002257 }
2258 return skip;
2259}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002260
John Zulaufeabb4462019-07-05 14:13:03 -06002261void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2262 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2263 const VkImageSubresourceRange *pRanges) {
2264 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2265 auto cb_node = GetCBState(commandBuffer);
2266 auto image_state = GetImageState(image);
2267 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002268 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002269 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002270 }
2271 }
2272}
2273
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002274// Returns true if [x, xoffset] and [y, yoffset] overlap
2275static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2276 bool result = false;
2277 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2278 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2279
2280 if (intersection_max > intersection_min) {
2281 result = true;
2282 }
2283 return result;
2284}
2285
Jeff Leger178b1e52020-10-05 12:22:23 -04002286// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002287// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002288template <typename RegionType>
2289static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002290 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002291
Dave Houltonc991cc92018-03-06 11:08:51 -07002292 // Separate planes within a multiplane image cannot intersect
2293 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002294 return result;
2295 }
2296
Dave Houltonc991cc92018-03-06 11:08:51 -07002297 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2298 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2299 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002300 result = true;
2301 switch (type) {
2302 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002303 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002304 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002305 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002306 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002307 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002308 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002309 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002310 break;
2311 default:
2312 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2313 assert(false);
2314 }
2315 }
2316 return result;
2317}
2318
Dave Houltonfc1a4052017-04-27 14:32:45 -06002319// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002320static const uint32_t kXBit = 1;
2321static const uint32_t kYBit = 2;
2322static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002323static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002324 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002325 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002326 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2327 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002328 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002329 }
2330 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2331 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002332 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002333 }
2334 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2335 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002336 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002337 }
2338 return result;
2339}
2340
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002341// Test if two VkExtent3D structs are equivalent
2342static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2343 bool result = true;
2344 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2345 (extent->depth != other_extent->depth)) {
2346 result = false;
2347 }
2348 return result;
2349}
2350
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002351// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002352static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002353 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2354}
2355
2356// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002357VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002358 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2359 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002360 auto pool = cb_node->command_pool.get();
2361 if (pool) {
2362 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002363 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002364 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002365 granularity.width *= block_size.width;
2366 granularity.height *= block_size.height;
2367 }
2368 }
2369 return granularity;
2370}
2371
2372// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2373static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2374 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002375 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2376 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002377 valid = false;
2378 }
2379 return valid;
2380}
2381
2382// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002383bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002384 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002385 bool skip = false;
2386 VkExtent3D offset_extent = {};
2387 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2388 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2389 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002390 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002391 // 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 -07002392 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002393 skip |= LogError(cb_node->commandBuffer, vuid,
2394 "%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 "
2395 "image transfer granularity is (w=0, h=0, d=0).",
2396 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002397 }
2398 } else {
2399 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2400 // integer multiples of the image transfer granularity.
2401 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002402 skip |= LogError(cb_node->commandBuffer, vuid,
2403 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2404 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2405 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2406 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002407 }
2408 }
2409 return skip;
2410}
2411
2412// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002413bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002414 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002415 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002416 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002417 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002418 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2419 // subresource extent.
2420 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002421 skip |= LogError(cb_node->commandBuffer, vuid,
2422 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2423 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2424 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2425 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002426 }
2427 } else {
2428 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2429 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2430 // subresource extent dimensions.
2431 VkExtent3D offset_extent_sum = {};
2432 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2433 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2434 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002435 bool x_ok = true;
2436 bool y_ok = true;
2437 bool z_ok = true;
2438 switch (image_type) {
2439 case VK_IMAGE_TYPE_3D:
2440 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2441 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002442 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002443 case VK_IMAGE_TYPE_2D:
2444 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2445 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002446 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002447 case VK_IMAGE_TYPE_1D:
2448 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2449 (subresource_extent->width == offset_extent_sum.width));
2450 break;
2451 default:
2452 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2453 assert(false);
2454 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002455 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002456 skip |=
2457 LogError(cb_node->commandBuffer, vuid,
2458 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2459 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2460 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2461 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2462 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2463 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002464 }
2465 }
2466 return skip;
2467}
2468
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002469bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002470 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002471 bool skip = false;
2472 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002473 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2474 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002475 }
2476 return skip;
2477}
2478
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002479bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002480 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002481 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002482 bool skip = false;
2483 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2484 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002485 skip |= LogError(cb_node->commandBuffer, vuid,
2486 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2487 "%u, but provided %s has %u array layers.",
2488 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2489 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002490 }
2491 return skip;
2492}
2493
Jeff Leger178b1e52020-10-05 12:22:23 -04002494// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2495template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002496bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002497 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002498 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002499 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002500 VkExtent3D granularity = GetScaledItg(cb_node, img);
2501 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002502 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002503 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002504 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002505 return skip;
2506}
2507
Jeff Leger178b1e52020-10-05 12:22:23 -04002508// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2509template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002510bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002511 const IMAGE_STATE *dst_img, const RegionType *region,
2512 const uint32_t i, const char *function,
2513 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002514 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002515 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2516 const char *vuid;
2517
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002518 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002519 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002520 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2521 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002522 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002523 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002524 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002525 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002526 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002527
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002528 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002529 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002530 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2531 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002532 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002533 const VkExtent3D dest_effective_extent =
2534 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002535 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002536 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002537 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002538 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002539 return skip;
2540}
2541
Jeff Leger178b1e52020-10-05 12:22:23 -04002542// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2543template <typename ImageCopyRegionType>
2544bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2545 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2546 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002547 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002548 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2549 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2550 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002551
2552 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002553 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002554
2555 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002556 const VkExtent3D src_copy_extent = region.extent;
2557 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002558 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2559
Dave Houlton6f9059e2017-05-02 17:15:13 -06002560 bool slice_override = false;
2561 uint32_t depth_slices = 0;
2562
2563 // Special case for copying between a 1D/2D array and a 3D image
2564 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2565 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002566 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002567 slice_override = (depth_slices != 1);
2568 } 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 -07002569 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002570 slice_override = (depth_slices != 1);
2571 }
2572
2573 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002574 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002575 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002576 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2577 skip |= LogError(src_state->image, vuid,
2578 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2579 "be 0 and 1, respectively.",
2580 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002581 }
2582 }
2583
Dave Houlton533be9f2018-03-26 17:08:30 -06002584 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 -04002585 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2586 skip |= LogError(src_state->image, vuid,
2587 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002588 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002589 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002590 }
2591
Dave Houlton533be9f2018-03-26 17:08:30 -06002592 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002593 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2594 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2595 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002596 }
2597
Dave Houltonc991cc92018-03-06 11:08:51 -07002598 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002599 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002600 if (FormatIsCompressed(src_state->createInfo.format) ||
2601 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002602 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002603 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002604 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2605 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2606 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002607 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002608 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002609 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002610 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002611 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002612 }
2613
Dave Houlton94a00372017-12-14 15:08:47 -07002614 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002615 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2616 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002617 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2618 skip |= LogError(src_state->image, vuid,
2619 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2620 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2621 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002622 }
2623
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002624 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002625 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2626 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002627 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2628 skip |= LogError(src_state->image, vuid,
2629 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2630 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2631 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002632 }
2633
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002634 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002635 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2636 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002637 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2638 skip |= LogError(src_state->image, vuid,
2639 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2640 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2641 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002642 }
2643 } // Compressed
2644
2645 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002646 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002647 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002648 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2649 skip |= LogError(dst_state->image, vuid,
2650 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002651 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002652 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002653 }
2654 }
2655
Dave Houlton533be9f2018-03-26 17:08:30 -06002656 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 -04002657 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2658 skip |= LogError(dst_state->image, vuid,
2659 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2660 "and 1, respectively.",
2661 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002662 }
2663
Dave Houlton533be9f2018-03-26 17:08:30 -06002664 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002665 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2666 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2667 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002668 }
2669
sfricke-samsung30b094c2020-05-30 11:42:11 -07002670 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002671 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002672 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2673 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002674 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2675 skip |= LogError(src_state->image, vuid,
2676 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2677 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2678 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002679 }
2680 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002681 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002682 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002683 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2684 skip |= LogError(dst_state->image, vuid,
2685 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2686 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2687 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002688 }
2689 }
2690 } else { // Pre maint 1
2691 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002692 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002693 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2694 skip |= LogError(src_state->image, vuid,
2695 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002696 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2697 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002698 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002699 }
Dave Houltonee281a52017-12-08 13:51:02 -07002700 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002701 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2702 skip |= LogError(dst_state->image, vuid,
2703 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002704 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2705 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002706 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002707 }
2708 }
2709 }
2710
Dave Houltonc991cc92018-03-06 11:08:51 -07002711 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2712 if (FormatIsCompressed(dst_state->createInfo.format) ||
2713 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002714 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002715
2716 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002717 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2718 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2719 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002720 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002721 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002722 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002723 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002724 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002725 }
2726
Dave Houlton94a00372017-12-14 15:08:47 -07002727 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002728 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2729 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002730 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2731 skip |= LogError(dst_state->image, vuid,
2732 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2733 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2734 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002735 }
2736
Dave Houltonee281a52017-12-08 13:51:02 -07002737 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2738 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2739 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002740 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002741 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002742 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002743 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2744 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002745 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002746 }
2747
Dave Houltonee281a52017-12-08 13:51:02 -07002748 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2749 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2750 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002751 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2752 skip |= LogError(dst_state->image, vuid,
2753 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2754 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2755 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002756 }
2757 } // Compressed
2758 }
2759 return skip;
2760}
2761
Jeff Leger178b1e52020-10-05 12:22:23 -04002762// vkCmdCopyImage / vmCmdCopyImage2KHR checks that only apply if the multiplane extension is enabled
2763template <typename RegionType>
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002764bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04002765 const IMAGE_STATE *dst_image_state, const RegionType region,
2766 CopyCommandVersion version) const {
2767 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Dave Houltonc991cc92018-03-06 11:08:51 -07002768 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002769
Jeff Leger178b1e52020-10-05 12:22:23 -04002770 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2771 const char *vuid;
2772
Dave Houltonc991cc92018-03-06 11:08:51 -07002773 // Neither image is multiplane
2774 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2775 // If neither image is multi-plane the aspectMask member of src and dst must match
2776 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2777 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002778 ss << func_name << ": Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002779 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Jeff Leger178b1e52020-10-05 12:22:23 -04002780 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2781 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002782 }
2783 } else {
2784 // Source image multiplane checks
2785 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2786 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2787 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2788 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002789 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2790 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2791 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002792 }
2793 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2794 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2795 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002796 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2797 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2798 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002799 }
2800 // Single-plane to multi-plane
2801 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2802 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2803 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002804 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2805 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2806 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002807 }
2808
2809 // Dest image multiplane checks
2810 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2811 aspect = region.dstSubresource.aspectMask;
2812 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2813 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002814 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2815 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2816 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002817 }
2818 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2819 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2820 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002821 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2822 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2823 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002824 }
2825 // Multi-plane to single-plane
2826 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2827 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2828 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002829 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2830 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2831 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002832 }
2833 }
2834
2835 return skip;
2836}
2837
Jeff Leger178b1e52020-10-05 12:22:23 -04002838template <typename RegionType>
2839bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2840 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2841 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002842 const auto *cb_node = GetCBState(commandBuffer);
2843 const auto *src_image_state = GetImageState(srcImage);
2844 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002845 const VkFormat src_format = src_image_state->createInfo.format;
2846 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002847 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002848 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002849
Jeff Leger178b1e52020-10-05 12:22:23 -04002850 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2851 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2852 const char *vuid;
2853
2854 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002855
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002856 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2857
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002858 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002859 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002860
2861 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2862 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002863 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002864
Dave Houlton6f9059e2017-05-02 17:15:13 -06002865 bool slice_override = false;
2866 uint32_t depth_slices = 0;
2867
2868 // Special case for copying between a 1D/2D array and a 3D image
2869 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2870 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2871 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002872 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002873 slice_override = (depth_slices != 1);
2874 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2875 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002876 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002877 slice_override = (depth_slices != 1);
2878 }
2879
Jeff Leger178b1e52020-10-05 12:22:23 -04002880 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2881 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2882 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2883 skip |=
2884 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2885 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2886 skip |=
2887 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2888 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002889 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002890 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2891 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002892 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002893 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002894
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002895 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002896 // No chance of mismatch if we're overriding depth slice count
2897 if (!slice_override) {
2898 // The number of depth slices in srcSubresource and dstSubresource must match
2899 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2900 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002901 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2902 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002903 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002904 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2905 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002906 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002907 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2908 skip |= LogError(command_buffer, vuid,
2909 "%s: number of depth slices in source and destination subresources for "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002910 "pRegions[%u] do not match.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002911 func_name, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002912 }
2913 }
2914 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002915 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002916 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002917 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
2918 skip |= LogError(command_buffer, vuid,
2919 "%s: number of layers in source and destination subresources for pRegions[%u] do not match",
2920 func_name, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002921 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002922 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002923
Dave Houltonc991cc92018-03-06 11:08:51 -07002924 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002925 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002926 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region, version);
Dave Houltonc991cc92018-03-06 11:08:51 -07002927 }
2928
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002929 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002930 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2931 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002932 std::stringstream ss;
2933 ss << func_name << ": Src and dest aspectMasks for each region must match";
2934 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
2935 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonf5217612018-02-02 16:18:52 -07002936 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002937 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002938
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002939 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002940 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002941 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002942 ss << func_name << ": pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002943 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Jeff Leger178b1e52020-10-05 12:22:23 -04002944 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
2945 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002946 }
2947
2948 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002949 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002950 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002951 ss << func_name << ": pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2952 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
2953 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002954 }
2955
Dave Houltonfc1a4052017-04-27 14:32:45 -06002956 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002957 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2958 if (slice_override) src_copy_extent.depth = depth_slices;
2959 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002960 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002961 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
2962 skip |= LogError(command_buffer, vuid,
2963 "%s: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2964 "width [%1d].",
2965 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002966 }
2967
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002968 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002969 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
2970 skip |= LogError(command_buffer, vuid,
2971 "%s: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2972 "height [%1d].",
2973 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002974 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002975 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002976 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
2977 skip |= LogError(command_buffer, vuid,
2978 "%s: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2979 "depth [%1d].",
2980 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002981 }
2982
Dave Houltonee281a52017-12-08 13:51:02 -07002983 // Adjust dest extent if necessary
2984 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2985 if (slice_override) dst_copy_extent.depth = depth_slices;
2986
2987 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002988 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002989 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
2990 skip |= LogError(command_buffer, vuid,
2991 "%s: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002992 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002993 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002994 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002995 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002996 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
2997 skip |= LogError(command_buffer, vuid,
2998 "%s): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002999 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003000 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003001 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003002 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003003 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3004 skip |= LogError(command_buffer, vuid,
3005 "%s: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003006 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003007 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003008 }
3009
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003010 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3011 // must not overlap in memory
3012 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003013 for (uint32_t j = 0; j < regionCount; j++) {
3014 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003015 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003016 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003017 ss << func_name << ": pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
3018 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
3019 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003020 }
3021 }
3022 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003023
3024 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3025 if (device_extensions.vk_khr_maintenance1) {
3026 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3027 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3028 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003029 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3030 skip |= LogError(command_buffer, vuid,
3031 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3032 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003033 }
3034 } else {
3035 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3036 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3037 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003038 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3039 skip |= LogError(command_buffer, vuid,
3040 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3041 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003042 }
3043 }
3044
3045 // Check if 2D with 3D and depth not equal to 2D layerCount
3046 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3047 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3048 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003049 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3050 skip |= LogError(command_buffer, vuid,
3051 "%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 -08003052 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003053 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003054 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3055 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3056 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003057 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3058 skip |= LogError(command_buffer, vuid,
3059 "%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 -08003060 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003061 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003062 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003063
3064 // Check for multi-plane format compatiblity
3065 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3066 size_t src_format_size = 0;
3067 size_t dst_format_size = 0;
3068 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003069 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3070 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003071 } else {
3072 src_format_size = FormatElementSize(src_format);
3073 }
3074 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003075 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3076 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003077 } else {
3078 dst_format_size = FormatElementSize(dst_format);
3079 }
3080 // If size is still zero, then format is invalid and will be caught in another VU
3081 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003082 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3083 skip |= LogError(command_buffer, vuid,
3084 "%s: pRegions[%u] called with non-compatible image formats. "
3085 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3086 func_name, i, string_VkFormat(src_format),
3087 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3088 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003089 }
3090 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003091 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003092
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003093 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3094 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3095 // because because both texels are 4 bytes in size.
3096 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003097 const char *compatible_vuid =
3098 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3099 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3100 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003101 // Depth/stencil formats must match exactly.
3102 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3103 if (src_format != dst_format) {
3104 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003105 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003106 string_VkFormat(src_format), string_VkFormat(dst_format));
3107 }
3108 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003109 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003110 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003111 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003112 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003113 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003114 FormatElementSize(dst_format));
3115 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003116 }
3117 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003118
Dave Houlton33c22b72017-02-28 13:16:02 -07003119 // Source and dest image sample counts must match
3120 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003121 std::stringstream ss;
3122 ss << func_name << " called on image pair with non-identical sample counts.";
3123 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
3124 skip |= LogError(command_buffer, vuid, "%s", ss.str().c_str());
Dave Houlton33c22b72017-02-28 13:16:02 -07003125 }
3126
Jeff Leger178b1e52020-10-05 12:22:23 -04003127 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127";
3128 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3129 vuid = is_2khr ? "" : "";
3130 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003131 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003132 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3133 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3134 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3135 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3136 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3137 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3138 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3139 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3140 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3141 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3142 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3143 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003144
3145 // Validation for VK_EXT_fragment_density_map
3146 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003147 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3148 skip |=
3149 LogError(command_buffer, vuid,
3150 "%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 +02003151 }
3152 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003153 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3154 skip |=
3155 LogError(command_buffer, vuid,
3156 "%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 +02003157 }
3158
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003159 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003160 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3161 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3162 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3163 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003164 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003165 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3166 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3167 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3168 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3169 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003170 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003171
3172 const char *invalid_src_layout_vuid =
3173 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3174 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3175 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3176 const char *invalid_dst_layout_vuid =
3177 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3178 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3179 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3180
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003181 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003182 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003183 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003184 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3185 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003186 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003187 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003188 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003189 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003190 }
3191
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003192 return skip;
3193}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003194
Jeff Leger178b1e52020-10-05 12:22:23 -04003195bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3196 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3197 const VkImageCopy *pRegions) const {
3198 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3199 COPY_COMMAND_VERSION_1);
3200}
3201
3202bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3203 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3204 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3205 COPY_COMMAND_VERSION_2);
3206}
3207
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003208void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3209 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3210 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003211 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3212 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003213 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003214 auto src_image_state = GetImageState(srcImage);
3215 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003216
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003217 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003218 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003219 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3220 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003221 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003222}
3223
Jeff Leger178b1e52020-10-05 12:22:23 -04003224void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3225 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3226 auto cb_node = GetCBState(commandBuffer);
3227 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3228 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3229
3230 // Make sure that all image slices are updated to correct layout
3231 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3232 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3233 pCopyImageInfo->srcImageLayout);
3234 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3235 pCopyImageInfo->dstImageLayout);
3236 }
3237}
3238
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003239// Returns true if sub_rect is entirely contained within rect
3240static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3241 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 -07003242 (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 -07003243 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003244 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003245 return true;
3246}
3247
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003248bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003249 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003250 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3251 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003252 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003253 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3254 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003255 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003256 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003257
3258 for (uint32_t j = 0; j < rect_count; j++) {
3259 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003260 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3261 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3262 "the current render pass instance.",
3263 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003264 }
3265
3266 if (image_view_state) {
3267 // The layers specified by a given element of pRects must be contained within every attachment that
3268 // pAttachments refers to
3269 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3270 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3271 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003272 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3273 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3274 "of pAttachment[%d].",
3275 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003276 }
3277 }
3278 }
3279 return skip;
3280}
3281
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003282bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3283 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003284 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003285 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003286 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003287 if (!cb_node) return skip;
3288
3289 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3290 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3291 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003292 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003293
3294 // Validate that attachment is in reference list of active subpass
3295 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003296 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003297 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003298 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003299 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003300 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003301
John Zulauf3a548ef2019-02-01 16:14:07 -07003302 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3303 auto clear_desc = &pAttachments[attachment_index];
3304 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003305 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003306
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003307 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3308 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3309 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3310 attachment_index);
3311 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3312 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3313 skip |=
3314 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3315 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3316 attachment_index);
3317 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003318 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3319 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3320 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3321 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003322 skip |= LogError(
3323 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3324 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3325 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3326 attachment_index, clear_desc->colorAttachment,
3327 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3328 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003329
John Zulauff2582972019-02-09 14:53:30 -07003330 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3331 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003332 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003333 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3334 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3335 " subpass %u. colorAttachmentCount=%u",
3336 attachment_index, clear_desc->colorAttachment,
3337 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3338 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003339 }
John Zulauff2582972019-02-09 14:53:30 -07003340 fb_attachment = color_attachment;
3341
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003342 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3343 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3344 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3345 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3346 "of a color attachment.",
3347 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003348 }
3349 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003350 bool subpass_depth = false;
3351 bool subpass_stencil = false;
3352 if (subpass_desc->pDepthStencilAttachment &&
3353 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3354 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3355 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3356 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3357 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003358 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003359 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3360 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003361 skip |= LogError(
3362 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3363 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003364 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003365 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003366 }
3367 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003368 skip |= LogError(
3369 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3370 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003371 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003372 attachment_index);
3373 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003374 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003375 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003376 }
3377 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003378 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003379 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3380 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003381 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003382
3383 // Once the framebuffer attachment is found, can get the image view state
3384 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3385 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3386 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003387 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003388 if (image_view_state != nullptr) {
3389 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3390 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3391 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3392 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3393 }
3394 }
John Zulauf441558b2019-08-12 11:47:39 -06003395 }
3396 }
3397 return skip;
3398}
3399
3400void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3401 const VkClearAttachment *pAttachments, uint32_t rectCount,
3402 const VkClearRect *pRects) {
3403 auto *cb_node = GetCBState(commandBuffer);
3404 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3405 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3406 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3407 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3408 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3409 const auto clear_desc = &pAttachments[attachment_index];
3410 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3411 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3412 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3413 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3414 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3415 subpass_desc->pDepthStencilAttachment) {
3416 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3417 }
3418 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003419 if (!clear_rect_copy) {
3420 // We need a copy of the clear rectangles that will persist until the last lambda executes
3421 // but we want to create it as lazily as possible
3422 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003423 }
John Zulauf441558b2019-08-12 11:47:39 -06003424 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3425 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003426 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003427 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003428 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003429 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3430 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003431 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003432 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003433 return skip;
3434 };
3435 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003436 }
3437 }
3438 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003439}
3440
Jeff Leger178b1e52020-10-05 12:22:23 -04003441template <typename RegionType>
3442bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3443 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3444 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003445 const auto *cb_node = GetCBState(commandBuffer);
3446 const auto *src_image_state = GetImageState(srcImage);
3447 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003448 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3449 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3450 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3451 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003452
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003453 bool skip = false;
3454 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003455 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3456 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3457 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3458 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3459 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3460 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3461 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3462 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3463 skip |= InsideRenderPass(cb_node, func_name, vuid);
3464 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3465 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3466 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3467 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3468 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3469 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3470 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3471 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003472
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003473 // Validation for VK_EXT_fragment_density_map
3474 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003475 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3476 skip |= LogError(cb_node->commandBuffer, vuid,
3477 "%s: srcImage must not have been created with flags containing "
3478 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3479 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003480 }
3481 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003482 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3483 skip |= LogError(cb_node->commandBuffer, vuid,
3484 "%s: dstImage must not have been created with flags containing "
3485 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3486 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003487 }
3488
Cort Stratton7df30962018-05-17 19:45:57 -07003489 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003490 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003491 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3492 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003493 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003494 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3495 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3496 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003497 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003498 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3499 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3500 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3501 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3502 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3503 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003504 // For each region, the number of layers in the image subresource should not be zero
3505 // For each region, src and dest image aspect must be color only
3506 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003507 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003508 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3509 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003510 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3511 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3512 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003513 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003514 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3515 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003516 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003517 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3518 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3519 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3520 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3521 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3522 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003523 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003524 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3525 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003526 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003527 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003528
3529 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003530 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003531 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3532 skip |=
3533 LogError(cb_node->commandBuffer, vuid,
3534 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003535 }
Cort Stratton7df30962018-05-17 19:45:57 -07003536 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003537 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3538 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003539 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3540 skip |= LogError(cb_node->commandBuffer, vuid,
3541 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3542 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003543 }
3544
3545 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3546 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3547
3548 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003549 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003550 LogObjectList objlist(cb_node->commandBuffer);
3551 objlist.add(src_image_state->image);
3552 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003553 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3554 skip |= LogError(objlist, vuid,
3555 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003556 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003557 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003558 }
3559 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3560 LogObjectList objlist(cb_node->commandBuffer);
3561 objlist.add(src_image_state->image);
3562 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003563 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3564 skip |= LogError(objlist, vuid,
3565 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003566 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003567 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003568 }
3569 }
3570
3571 if (VK_IMAGE_TYPE_1D == src_image_type) {
3572 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3573 LogObjectList objlist(cb_node->commandBuffer);
3574 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003575 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3576 skip |= LogError(objlist, vuid,
3577 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003578 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003579 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3580 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003581 }
3582 }
3583 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3584 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3585 LogObjectList objlist(cb_node->commandBuffer);
3586 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003587 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3588 skip |= LogError(objlist, vuid,
3589 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003590 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003591 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3592 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003593 }
3594 }
3595
3596 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3597 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3598 LogObjectList objlist(cb_node->commandBuffer);
3599 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003600 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3601 skip |= LogError(objlist, vuid,
3602 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003603 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003604 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3605 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003606 }
3607 }
3608 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3609 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3610 LogObjectList objlist(cb_node->commandBuffer);
3611 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003612 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3613 skip |= LogError(objlist, vuid,
3614 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003615 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003616 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3617 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003618 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003619 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003620
3621 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3622 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3623 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3624 // developer
3625 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3626 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003627 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003628 LogObjectList objlist(cb_node->commandBuffer);
3629 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003630 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3631 skip |= LogError(objlist, vuid,
3632 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003633 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003634 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003635 region.extent.width, subresource_extent.width);
3636 }
3637
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003638 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003639 LogObjectList objlist(cb_node->commandBuffer);
3640 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003641 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3642 skip |= LogError(objlist, vuid,
3643 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003644 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003645 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003646 region.extent.height, subresource_extent.height);
3647 }
3648
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003649 if ((extent_check & kZBit) != 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-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3653 skip |= LogError(objlist, vuid,
3654 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003655 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003656 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003657 region.extent.depth, subresource_extent.depth);
3658 }
3659 }
3660
3661 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3662 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3663 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3664 // developer
3665 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3666 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003667 if ((extent_check & kXBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003668 LogObjectList objlist(cb_node->commandBuffer);
3669 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003670 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3671 skip |= LogError(objlist, vuid,
3672 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003673 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003674 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003675 region.extent.width, subresource_extent.width);
3676 }
3677
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003678 if ((extent_check & kYBit) != 0) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003679 LogObjectList objlist(cb_node->commandBuffer);
3680 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003681 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3682 skip |= LogError(objlist, vuid,
3683 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003684 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003685 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003686 region.extent.height, subresource_extent.height);
3687 }
3688
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003689 if ((extent_check & kZBit) != 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-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3693 skip |= LogError(objlist, vuid,
3694 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003695 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003696 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003697 region.extent.depth, subresource_extent.depth);
3698 }
3699 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003700 }
3701
3702 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003703 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3704 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3705 func_name, string_VkFormat(src_image_state->createInfo.format),
3706 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003707 }
3708 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003709 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003710 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003711 string_VkImageType(src_image_state->createInfo.imageType),
3712 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003713 }
3714 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003715 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3716 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 -07003717 }
3718 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003719 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3720 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3721 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003722 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003723 } else {
3724 assert(0);
3725 }
3726 return skip;
3727}
3728
Jeff Leger178b1e52020-10-05 12:22:23 -04003729bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3730 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3731 const VkImageResolve *pRegions) const {
3732 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3733 COPY_COMMAND_VERSION_1);
3734}
3735
3736bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3737 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3738 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3739 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3740 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3741}
3742
3743template <typename RegionType>
3744bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3745 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3746 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003747 const auto *cb_node = GetCBState(commandBuffer);
3748 const auto *src_image_state = GetImageState(srcImage);
3749 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003750
Jeff Leger178b1e52020-10-05 12:22:23 -04003751 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3752 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3753 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3754
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003755 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003756 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003757 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003758 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003759 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003760 const char *vuid;
3761 const char *location;
3762 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3763 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3764 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3765 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3766 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3767 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3768 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3769 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3770 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3771 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3772 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3773 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3774 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3775 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3776 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3777 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3778 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3779 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3780 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3781 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3782 skip |= InsideRenderPass(cb_node, func_name, vuid);
3783 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3784 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3785 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3786 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3787 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3788 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3789 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3790 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3791 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3792 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003793
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003794 // Validation for VK_EXT_fragment_density_map
3795 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003796 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3797 skip |= LogError(cb_node->commandBuffer, vuid,
3798 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3799 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003800 }
3801 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003802 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3803 skip |= LogError(cb_node->commandBuffer, vuid,
3804 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3805 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003806 }
3807
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003808 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003809
Dave Houlton33c2d252017-06-09 17:08:32 -06003810 VkFormat src_format = src_image_state->createInfo.format;
3811 VkFormat dst_format = dst_image_state->createInfo.format;
3812 VkImageType src_type = src_image_state->createInfo.imageType;
3813 VkImageType dst_type = dst_image_state->createInfo.imageType;
3814
Cort Stratton186b1a22018-05-01 20:18:06 -04003815 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003816 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3817 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3818 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003819 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003820 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003821 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003822 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003823 }
3824
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003825 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003826 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3827 skip |= LogError(device, vuid,
3828 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003829 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003830 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003831 }
3832
3833 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003834 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3835 skip |= LogError(device, vuid,
3836 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003837 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003838 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003839 }
3840
Dave Houlton33c2d252017-06-09 17:08:32 -06003841 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003842 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3843 skip |= LogError(cb_node->commandBuffer, vuid,
3844 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003845 }
3846
Dave Houlton33c2d252017-06-09 17:08:32 -06003847 // Validate consistency for unsigned formats
3848 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3849 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003850 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003851 << "the other one must also have unsigned integer format. "
3852 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003853 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3854 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003855 }
3856
3857 // Validate consistency for signed formats
3858 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3859 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003860 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003861 << "the other one must also have signed integer format. "
3862 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003863 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3864 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003865 }
3866
3867 // Validate filter for Depth/Stencil formats
3868 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3869 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003870 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003871 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003872 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3873 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003874 }
3875
3876 // Validate aspect bits and formats for depth/stencil images
3877 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3878 if (src_format != dst_format) {
3879 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003880 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 -06003881 << "stencil, the other one must have exactly the same format. "
3882 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3883 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003884 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3885 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003886 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003887 } // Depth or Stencil
3888
3889 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003890 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003891 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3892 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3893 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3894 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3895 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3896 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003897 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003898 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3899 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3900 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3901 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3902 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3903 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003904 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003905 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003906 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003907 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003908 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003909 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3910 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003911 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003912 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3913 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3914 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3915 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3916 skip |=
3917 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3918 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3919 skip |=
3920 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3921 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003922 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003923 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3924 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003925 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003926 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003927 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003928 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3929 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003930 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003931 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003932 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003933 }
Dave Houlton48989f32017-05-26 15:01:46 -06003934 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3935 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003936 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003937 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003938 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003939 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003940
3941 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003942 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003943 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
3944 skip |=
3945 LogError(cb_node->commandBuffer, vuid,
3946 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003947 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003948
Dave Houlton48989f32017-05-26 15:01:46 -06003949 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003950 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
3951 skip |=
3952 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003953 }
Dave Houlton48989f32017-05-26 15:01:46 -06003954
Dave Houlton33c2d252017-06-09 17:08:32 -06003955 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003956 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
3957 skip |= LogError(cb_node->commandBuffer, vuid,
3958 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003959 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003960 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003961 }
3962
3963 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003964 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
3965 skip |= LogError(cb_node->commandBuffer, vuid,
3966 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3967 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003968 }
3969
Dave Houlton48989f32017-05-26 15:01:46 -06003970 // Validate source image offsets
3971 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003972 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003973 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003974 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
3975 skip |= LogError(cb_node->commandBuffer, vuid,
3976 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3977 "of (%1d, %1d). These must be (0, 1).",
3978 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003979 }
3980 }
3981
Dave Houlton33c2d252017-06-09 17:08:32 -06003982 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003983 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003984 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
3985 skip |= LogError(cb_node->commandBuffer, vuid,
3986 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3987 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3988 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003989 }
3990 }
3991
Dave Houlton33c2d252017-06-09 17:08:32 -06003992 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003993 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3994 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003995 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003996 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
3997 skip |= LogError(cb_node->commandBuffer, vuid,
3998 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3999 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004000 }
4001 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4002 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004003 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004004 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
4005 skip |= LogError(cb_node->commandBuffer, vuid,
4006 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4007 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004008 }
4009 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4010 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004011 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004012 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
4013 skip |= LogError(cb_node->commandBuffer, vuid,
4014 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4015 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004016 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004017 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004018 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4019 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4020 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004021 }
Dave Houlton48989f32017-05-26 15:01:46 -06004022
4023 // Validate dest image offsets
4024 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004025 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004026 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004027 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4028 skip |= LogError(cb_node->commandBuffer, vuid,
4029 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4030 "(%1d, %1d). These must be (0, 1).",
4031 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004032 }
4033 }
4034
Dave Houlton33c2d252017-06-09 17:08:32 -06004035 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004036 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004037 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4038 skip |= LogError(cb_node->commandBuffer, vuid,
4039 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004040 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004041 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004042 }
4043 }
4044
Dave Houlton33c2d252017-06-09 17:08:32 -06004045 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004046 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4047 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004048 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004049 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4050 skip |= LogError(cb_node->commandBuffer, vuid,
4051 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4052 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004053 }
4054 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4055 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004056 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004057 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4058 skip |= LogError(cb_node->commandBuffer, vuid,
4059 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4060 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004061 }
4062 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4063 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004064 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004065 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4066 skip |= LogError(cb_node->commandBuffer, vuid,
4067 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4068 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004069 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004070 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004071 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4072 skip |= LogError(cb_node->commandBuffer, vuid,
4073 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004074 }
4075
Dave Houlton33c2d252017-06-09 17:08:32 -06004076 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4077 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4078 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004079 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4080 skip |= LogError(cb_node->commandBuffer, vuid,
4081 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4082 "layerCount other than 1.",
4083 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004084 }
4085 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004086 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004087 } else {
4088 assert(0);
4089 }
4090 return skip;
4091}
4092
Jeff Leger178b1e52020-10-05 12:22:23 -04004093bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4094 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4095 const VkImageBlit *pRegions, VkFilter filter) const {
4096 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4097 COPY_COMMAND_VERSION_1);
4098}
4099
4100bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4101 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4102 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4103 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4104}
4105
4106template <typename RegionType>
4107void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4108 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4109 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004110 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004111 auto src_image_state = GetImageState(srcImage);
4112 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004113
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004114 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004115 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004116 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4117 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004118 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004119}
4120
Jeff Leger178b1e52020-10-05 12:22:23 -04004121void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4122 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4123 const VkImageBlit *pRegions, VkFilter filter) {
4124 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4125 pRegions, filter);
4126 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4127}
4128
4129void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4130 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4131 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4132 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4133 pBlitImageInfo->filter);
4134}
4135
John Zulauf2076e812020-01-08 14:55:54 -07004136GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4137 assert(map);
4138 // This approach allows for a single hash lookup or/create new
4139 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4140 if (inserted.second) {
4141 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004142 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004143 inserted.first->second.reset(layout_map);
4144 return layout_map;
4145 } else {
4146 assert(nullptr != inserted.first->second.get());
4147 return inserted.first->second.get();
4148 }
4149 return nullptr;
4150}
4151
4152const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4153 auto it = map.find(image);
4154 if (it != map.end()) {
4155 return it->second.get();
4156 }
4157 return nullptr;
4158}
4159
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004160// 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 -07004161bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4162 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004163 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004164 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004165 GlobalImageLayoutMap &overlay_layout_map = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004166 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004167 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004168 for (const auto &layout_map_entry : pCB->image_layout_map) {
4169 const auto image = layout_map_entry.first;
4170 const auto *image_state = GetImageState(image);
4171 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004172 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004173 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004174 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004175 if (initial_layout_map.empty()) continue;
4176
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004177 auto *overlay_map = GetLayoutRangeMap(&overlay_layout_map, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004178 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4179 if (global_map == nullptr) {
4180 global_map = &empty_map;
4181 }
4182
4183 // Note: don't know if it would matter
4184 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4185
4186 auto pos = initial_layout_map.begin();
4187 const auto end = initial_layout_map.end();
4188 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4189 pos->first.begin);
4190 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004191 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004192 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004193 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 -07004194 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004195 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004196 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004197 image_layout = current_layout->pos_B->lower_bound->second;
4198 }
4199 const auto intersected_range = pos->first & current_layout->range;
4200 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4201 // TODO: Set memory invalid which is in mem_tracker currently
4202 } else if (image_layout != initial_layout) {
4203 // Need to look up the inital layout *state* to get a bit more information
4204 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4205 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4206 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4207 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004208 // We can report all the errors for the intersected range directly
4209 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004210 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004211 skip |= LogError(
4212 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004213 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004214 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004215 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004216 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004217 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004218 }
4219 }
John Zulauf2076e812020-01-08 14:55:54 -07004220 if (pos->first.includes(intersected_range.end)) {
4221 current_layout.seek(intersected_range.end);
4222 } else {
4223 ++pos;
4224 if (pos != end) {
4225 current_layout.seek(pos->first.begin);
4226 }
4227 }
John Zulauff660ad62019-03-23 07:16:05 -06004228 }
4229
locke-lunargf155ccf2020-02-18 11:34:15 -07004230 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004231 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004232 }
John Zulauff660ad62019-03-23 07:16:05 -06004233
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004234 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004235}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004236
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004237void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004238 for (const auto &layout_map_entry : pCB->image_layout_map) {
4239 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004240 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004241 const auto *image_state = GetImageState(image);
4242 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004243 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4244 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004245 }
4246}
4247
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004248// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004249// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4250// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004251bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4252 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06004253 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004254 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004255 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4256
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004257 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004258 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4259 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004260 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004261 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4262 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4263 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004264 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004265 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004266 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004267 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4268 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4269 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004270 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004271 string_VkImageLayout(first_layout));
4272 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4273 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004274 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004275 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004276 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004277 }
4278 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004279
4280 // Same as above for loadOp, but for stencilLoadOp
4281 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4282 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4283 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4284 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4285 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004286 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004287 string_VkImageLayout(first_layout));
4288 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4289 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4290 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004291 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004292 string_VkImageLayout(first_layout));
4293 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4294 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4295 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004296 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004297 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004298 }
4299 }
4300
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004301 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004302}
4303
Mark Lobodzinski96210742017-02-09 10:33:46 -07004304// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4305// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004306template <typename T1>
4307bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4308 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4309 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004310 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004311 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004312 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004313 if (strict) {
4314 correct_usage = ((actual & desired) == desired);
4315 } else {
4316 correct_usage = ((actual & desired) != 0);
4317 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004318
Mark Lobodzinski96210742017-02-09 10:33:46 -07004319 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004320 // All callers should have a valid VUID
4321 assert(msgCode != kVUIDUndefined);
4322 skip =
4323 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4324 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004325 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004326 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004327}
4328
4329// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4330// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004331bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004332 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004333 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004334 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004335}
4336
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004337bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004338 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004339 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004340 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4341 if ((image_format_features & desired) != desired) {
4342 // Same error, but more details if it was an AHB external format
4343 if (image_state->has_ahb_format == true) {
4344 skip |= LogError(image_state->image, vuid,
4345 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4346 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4347 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004348 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004349 } else {
4350 skip |= LogError(image_state->image, vuid,
4351 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4352 "with tiling %s.",
4353 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4354 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4355 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004356 }
4357 }
4358 return skip;
4359}
4360
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004361bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004362 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004363 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004364 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004365 // layerCount must not be zero
4366 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004367 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4368 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004369 }
4370 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004371 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004372 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4373 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004374 }
4375 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004376 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 -07004377 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4378 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4379 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4380 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004381 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004382 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4383 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4384 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4385 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4386 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4387 member);
4388 }
Cort Strattond619a302018-05-17 19:46:32 -07004389 return skip;
4390}
4391
Mark Lobodzinski96210742017-02-09 10:33:46 -07004392// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4393// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004394bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004395 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004396 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004397 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004398}
4399
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004400bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004401 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004402 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004403
4404 const VkDeviceSize &range = pCreateInfo->range;
4405 if (range != VK_WHOLE_SIZE) {
4406 // Range must be greater than 0
4407 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004408 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004409 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004410 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4411 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004412 }
4413 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004414 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4415 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004416 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004417 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004418 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4419 "(%" PRIu32 ").",
4420 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004421 }
4422 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004423 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004424 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004425 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004426 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4427 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4428 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004429 }
4430 // The sum of range and offset must be less than or equal to the size of buffer
4431 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004432 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004433 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004434 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4435 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4436 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004437 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004438 } else {
4439 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4440
4441 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4442 // VkPhysicalDeviceLimits::maxTexelBufferElements
4443 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4444 device_limits->maxTexelBufferElements) {
4445 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4446 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4447 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4448 "), divided by the element size of the format (%" PRIu32
4449 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4450 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4451 device_limits->maxTexelBufferElements);
4452 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004453 }
4454 return skip;
4455}
4456
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004457bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004458 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004459 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004460 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4461 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004462 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004463 "vkCreateBufferView(): If buffer was created with `usage` containing "
4464 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004465 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004466 }
4467 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4468 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004469 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004470 "vkCreateBufferView(): If buffer was created with `usage` containing "
4471 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004472 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004473 }
4474 return skip;
4475}
4476
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004477bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004478 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004479 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004480
Dave Houltond8ed0212018-05-16 17:18:24 -06004481 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004482
Jeff Bolz87697532019-01-11 22:54:00 -06004483 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4484 if (chained_devaddr_struct) {
4485 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4486 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004487 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4488 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4489 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004490 }
4491 }
4492
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004493 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4494 if (chained_opaqueaddr_struct) {
4495 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4496 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004497 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4498 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4499 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004500 }
4501 }
4502
Shannon McPherson4984e642019-12-05 13:04:34 -07004503 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004504 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4505 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004506 skip |= LogError(
4507 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004508 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4509 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4510 }
4511
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004512 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004513 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4514 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4515 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004516 }
4517
sfricke-samsungedce77a2020-07-03 22:35:13 -07004518 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4519 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4520 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4521 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4522 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4523 }
4524 const VkBufferCreateFlags invalid_flags =
4525 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4526 if ((pCreateInfo->flags & invalid_flags) != 0) {
4527 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4528 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4529 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4530 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4531 }
4532 }
4533
Mark Lobodzinski96210742017-02-09 10:33:46 -07004534 return skip;
4535}
4536
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004537bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004538 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004539 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004540 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004541 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4542 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004543 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004544 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4545 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004546 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004547 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4548 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4549 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004550
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004551 // Buffer view offset must be less than the size of buffer
4552 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004553 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004554 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004555 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4556 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004557 }
4558
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004559 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004560 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4561 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4562 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004563 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4564 : "VUID-VkBufferViewCreateInfo-offset-00926";
4565 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004566 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004567 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4568 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004569 }
4570
4571 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004572 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4573 if ((element_size % 3) == 0) {
4574 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004575 }
4576 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004577 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004578 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4579 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004580 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004581 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004582 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004583 skip |= LogError(
4584 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004585 "vkCreateBufferView(): If buffer was created with usage containing "
4586 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004587 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4588 ") must be a multiple of the lesser of "
4589 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4590 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4591 "(%" PRId32
4592 ") is VK_TRUE, the size of a texel of the requested format. "
4593 "If the size of a texel is a multiple of three bytes, then the size of a "
4594 "single component of format is used instead",
4595 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4596 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4597 }
4598 }
4599 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004600 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004601 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4602 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004603 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004604 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004605 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004606 skip |= LogError(
4607 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004608 "vkCreateBufferView(): If buffer was created with usage containing "
4609 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004610 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4611 ") must be a multiple of the lesser of "
4612 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4613 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4614 "(%" PRId32
4615 ") is VK_TRUE, the size of a texel of the requested format. "
4616 "If the size of a texel is a multiple of three bytes, then the size of a "
4617 "single component of format is used instead",
4618 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4619 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4620 }
4621 }
4622 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004623
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004624 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004625
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004626 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004627 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004628 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004629}
4630
Mark Lobodzinski602de982017-02-09 11:01:33 -07004631// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004632bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004633 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004634 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004635 const IMAGE_STATE *image_state = GetImageState(image);
4636 // checks color format and (single-plane or non-disjoint)
4637 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004638 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004639 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004640 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 -07004641 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004642 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 -07004643 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004644 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004645 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004646 skip |= LogError(image, vuid,
4647 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4648 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4649 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004650 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004651 skip |= LogError(image, vuid,
4652 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4653 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4654 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004655 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004656 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004657 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004658 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 -07004659 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004660 skip |=
4661 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 -07004662 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004663 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004664 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004665 skip |=
4666 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 -07004667 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004668 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4669 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004670 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004671 } else if (FormatIsMultiplane(format)) {
4672 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4673 if (3 == FormatPlaneCount(format)) {
4674 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4675 }
4676 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004677 skip |=
4678 LogError(image, vuid,
4679 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4680 "set, where n = [0, 1, 2].",
4681 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004682 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004683 }
4684 return skip;
4685}
4686
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004687bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4688 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004689 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4690 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004691 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004692
4693 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004694 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004695 skip |= LogError(image, errorCodes.base_mip_err,
4696 "%s: %s.baseMipLevel (= %" PRIu32
4697 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4698 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004699 }
Petr Kraus4d718682017-05-18 03:38:41 +02004700
Petr Krausffa94af2017-08-08 21:46:02 +02004701 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4702 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004703 skip |=
4704 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004705 } else {
4706 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004707
Petr Krausffa94af2017-08-08 21:46:02 +02004708 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004709 skip |= LogError(image, errorCodes.mip_count_err,
4710 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4711 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4712 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4713 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004714 }
Petr Kraus4d718682017-05-18 03:38:41 +02004715 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004716 }
Petr Kraus4d718682017-05-18 03:38:41 +02004717
4718 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004719 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004720 skip |= LogError(image, errorCodes.base_layer_err,
4721 "%s: %s.baseArrayLayer (= %" PRIu32
4722 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4723 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004724 }
Petr Kraus4d718682017-05-18 03:38:41 +02004725
Petr Krausffa94af2017-08-08 21:46:02 +02004726 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4727 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004728 skip |=
4729 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004730 } else {
4731 const uint64_t necessary_layer_count =
4732 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004733
Petr Krausffa94af2017-08-08 21:46:02 +02004734 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004735 skip |= LogError(image, errorCodes.layer_count_err,
4736 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4737 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4738 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4739 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004740 }
Petr Kraus4d718682017-05-18 03:38:41 +02004741 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004742 }
Petr Kraus4d718682017-05-18 03:38:41 +02004743
Mark Lobodzinski602de982017-02-09 11:01:33 -07004744 return skip;
4745}
4746
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004747bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004748 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004749 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004750 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4751 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004752 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 +02004753
David McFarland2853f2f2020-11-30 15:50:39 -04004754 uint32_t image_layer_count;
4755
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004756 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004757 const auto layers = LayersFromRange(subresourceRange);
4758 const auto extent = GetImageSubresourceExtent(image_state, &layers);
4759 image_layer_count = extent.depth;
4760 } else {
4761 image_layer_count = image_state->createInfo.arrayLayers;
4762 }
4763
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004764 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004765
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004766 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4767 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4768 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4769 subresource_range_error_codes.base_layer_err =
4770 is_khr_maintenance1
4771 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4772 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4773 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4774 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4775 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4776 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004777
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004778 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004779 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004780 image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004781}
4782
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004783bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004784 const VkImageSubresourceRange &subresourceRange,
4785 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004786 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4787 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4788 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4789 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4790 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004791
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004792 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004793 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004794 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004795}
4796
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004797bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004798 const VkImageSubresourceRange &subresourceRange,
4799 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004800 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4801 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4802 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4803 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4804 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004805
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004806 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004807 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004808 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004809}
4810
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004811bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004812 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004813 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004814 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4815 subresource_range_error_codes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4816 subresource_range_error_codes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4817 subresource_range_error_codes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4818 subresource_range_error_codes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004819
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004820 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004821 cmd_name, param_name, "arrayLayers", image_state->image, subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004822}
4823
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004824bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4825 const VkImageUsageFlags image_usage) const {
4826 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4827 bool skip = false;
4828
4829 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4830 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4831
4832 if (image_state->has_ahb_format == true) {
4833 // AHB image view and image share same feature sets
4834 tiling_features = image_state->format_features;
4835 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4836 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4837 assert(device_extensions.vk_ext_image_drm_format_modifier);
4838 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4839 nullptr};
4840 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4841
4842 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4843 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4844 nullptr};
4845 format_properties_2.pNext = (void *)&drm_properties_list;
4846 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4847
4848 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4849 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4850 0) {
4851 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4852 }
4853 }
4854 } else {
4855 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4856 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4857 : format_properties.optimalTilingFeatures;
4858 }
4859
4860 if (tiling_features == 0) {
4861 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4862 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4863 "physical device.",
4864 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4865 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4866 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4867 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4868 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4869 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4870 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4871 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4872 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4873 "VK_IMAGE_USAGE_STORAGE_BIT.",
4874 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4875 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4876 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4877 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4878 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4879 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4880 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4881 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4882 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4883 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4884 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4885 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4886 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4887 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4888 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4889 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4890 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4891 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00004892 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
4893 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
4894 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
4895 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-04550",
4896 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4897 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
4898 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4899 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004900 }
4901
4902 return skip;
4903}
4904
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004905bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004906 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004907 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004908 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004909 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004910 skip |=
4911 ValidateImageUsageFlags(image_state,
4912 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4913 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004914 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4915 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4916 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004917 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004918 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004919 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004920 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004921 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004922 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004923 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004924 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004925
4926 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4927 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004928 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004929 VkFormat view_format = pCreateInfo->format;
4930 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004931 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004932 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004933
Dave Houltonbd2e2622018-04-10 16:41:14 -06004934 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004935 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004936 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004937 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004938 if (!device_extensions.vk_ext_separate_stencil_usage) {
4939 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4941 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4942 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004943 }
4944 } else {
4945 const auto image_stencil_struct =
4946 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4947 if (image_stencil_struct == nullptr) {
4948 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004949 skip |= LogError(
4950 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004951 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4952 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4953 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4954 }
4955 } else {
4956 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4957 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4958 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004959 skip |= LogError(
4960 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004961 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4962 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4963 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4964 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4965 }
4966 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4967 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004968 skip |= LogError(
4969 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004970 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4971 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4972 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4973 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4974 }
4975 }
4976 }
4977 }
4978
Dave Houltonbd2e2622018-04-10 16:41:14 -06004979 image_usage = chained_ivuci_struct->usage;
4980 }
4981
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004982 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4983 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004984 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004985 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004986 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004987 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004988 std::stringstream ss;
4989 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004990 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004991 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004992 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004993 }
4994 } else {
Nathaniel Cesario0046c312020-10-07 23:28:28 -06004995 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004996 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4997 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004998 const char *error_vuid;
4999 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5000 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5001 } else if ((device_extensions.vk_khr_maintenance2) &&
5002 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5003 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5004 } else if ((!device_extensions.vk_khr_maintenance2) &&
5005 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5006 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5007 } else {
5008 // both enabled
5009 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5010 }
Dave Houltonc7988072018-04-16 11:46:56 -06005011 std::stringstream ss;
5012 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005013 << " is not in the same format compatibility class as "
5014 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005015 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5016 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005017 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005018 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005019 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005020 }
5021 } else {
5022 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005023 // Unless it is a multi-planar color bit aspect
5024 if ((image_format != view_format) &&
5025 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5026 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5027 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005028 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005029 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005030 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005031 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005032 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005033 }
5034 }
5035
5036 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005037 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005038
5039 switch (image_type) {
5040 case VK_IMAGE_TYPE_1D:
5041 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005042 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5043 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5044 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005045 }
5046 break;
5047 case VK_IMAGE_TYPE_2D:
5048 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5049 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5050 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005051 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5052 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5053 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005054 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005055 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5056 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5057 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005058 }
5059 }
5060 break;
5061 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005062 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005063 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5064 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5065 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005066 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005067 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5068 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5069 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005070 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5071 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005072 skip |= LogError(
5073 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5074 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5075 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5076 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5077 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005078 }
5079 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005080 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5081 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5082 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005083 }
5084 }
5085 } else {
5086 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005087 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5088 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5089 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005090 }
5091 }
5092 break;
5093 default:
5094 break;
5095 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005096
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005097 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005098 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005099 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005100 }
5101
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005102 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005103
Tobias Hector6663c9b2020-11-05 10:18:02 +00005104 if (enabled_features.shading_rate_image.shadingRateImage) {
5105 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5106 if (view_format != VK_FORMAT_R8_UINT) {
5107 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5108 "vkCreateImageView() If image was created with usage containing "
5109 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5110 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005111 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005112 }
5113
5114 if (enabled_features.shading_rate_image.shadingRateImage ||
5115 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5116 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5117 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5118 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5119 "vkCreateImageView() If image was created with usage containing "
5120 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5121 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5122 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005123 }
5124 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005125
Tobias Hector6663c9b2020-11-05 10:18:02 +00005126 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5127 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5128 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5129 pCreateInfo->subresourceRange.layerCount != 1) {
5130 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5131 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5132 pCreateInfo->subresourceRange.layerCount);
5133 }
5134
Jeff Bolz99e3f632020-03-24 22:59:22 -05005135 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5136 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5137 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5138 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5139 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5140 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5141 }
5142 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5143 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5144 skip |= LogError(
5145 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5146 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5147 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5148 }
5149 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005150
5151 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5152 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005153 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005154 "vkCreateImageView(): If image was created with usage containing "
5155 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5156 pCreateInfo->subresourceRange.levelCount);
5157 }
5158 }
5159 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5160 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005161 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005162 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5163 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5164 }
5165 } else {
5166 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5167 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5168 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005169 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005170 "vkCreateImageView(): If image was created with usage containing "
5171 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5172 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5173 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5174 }
5175 }
5176 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005177
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005178 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5179 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5180 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5181 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5182 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5183 }
5184 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5185 skip |=
5186 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5187 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5188 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5189 }
5190 }
5191 if (device_extensions.vk_ext_fragment_density_map_2) {
5192 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5193 (pCreateInfo->subresourceRange.layerCount >
5194 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5195 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5196 "vkCreateImageView(): If image was created with flags containing "
5197 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5198 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5199 pCreateInfo->subresourceRange.layerCount,
5200 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5201 }
5202 }
5203
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005204 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5205 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5206 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5207 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5208 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5209 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5210 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5211 }
5212 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005213
5214 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5215 // If swizzling is disabled, make sure it isn't used
5216 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5217 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5218 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5219 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5220 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5221 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5222 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5223 }
5224
5225 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5226 // disabled
5227 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5228 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5229 // spec. See Github issue #2361.
5230 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5231 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5232 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5233 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5234 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5235 "vkCreateImageView (portability error): ImageView format must have"
5236 " the same number of components and bits per component as the Image's format");
5237 }
5238 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005239 }
5240 return skip;
5241}
5242
Jeff Leger178b1e52020-10-05 12:22:23 -04005243template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005244bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005245 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005246 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005247 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5248 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5249 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005250
5251 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5252 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5253 VkDeviceSize src_min = UINT64_MAX;
5254 VkDeviceSize src_max = 0;
5255 VkDeviceSize dst_min = UINT64_MAX;
5256 VkDeviceSize dst_max = 0;
5257
5258 for (uint32_t i = 0; i < regionCount; i++) {
5259 src_min = std::min(src_min, pRegions[i].srcOffset);
5260 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5261 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5262 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5263
5264 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5265 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005266 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5267 skip |= LogError(src_buffer_state->buffer, vuid,
5268 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5269 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005270 }
5271
5272 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5273 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005274 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5275 skip |= LogError(dst_buffer_state->buffer, vuid,
5276 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5277 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005278 }
5279
5280 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5281 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005282 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5283 skip |= LogError(src_buffer_state->buffer, vuid,
5284 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005285 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005286 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005287 }
5288
5289 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5290 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005291 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5292 skip |= LogError(dst_buffer_state->buffer, vuid,
5293 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005294 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005295 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005296 }
5297 }
5298
5299 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5300 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5301 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005302 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5303 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5304 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005305 }
5306 }
5307
5308 return skip;
5309}
5310
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005311bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005312 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005313 const auto cb_node = GetCBState(commandBuffer);
5314 const auto src_buffer_state = GetBufferState(srcBuffer);
5315 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005316
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005317 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005318 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5319 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005320 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005321 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005322 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5323 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005324 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005325 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5326 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005327 skip |=
5328 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5329 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005330 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5331 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005332 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005333 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5334 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5335 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005336 return skip;
5337}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005338
Jeff Leger178b1e52020-10-05 12:22:23 -04005339bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5340 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5341 const auto cb_node = GetCBState(commandBuffer);
5342 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5343 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5344
5345 bool skip = false;
5346 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5347 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5348 // Validate that SRC & DST buffers have correct usage flags set
5349 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5350 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5351 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5352 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5353 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5354 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5355 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5356 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5357 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5358 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5359 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5360 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5361 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5362 skip |=
5363 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5364 skip |=
5365 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5366 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5367 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5368 return skip;
5369}
5370
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005371bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005372 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005373 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005374 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005375 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005376 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5377 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005378 }
5379 }
5380 return skip;
5381}
5382
Jeff Bolz5c801d12019-10-09 10:38:45 -05005383bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5384 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005385 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005386 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005387
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005388 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005389 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005390 skip |=
5391 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005392 }
5393 return skip;
5394}
5395
Jeff Bolz5c801d12019-10-09 10:38:45 -05005396bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005397 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005398
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005399 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005400 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005401 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005402 }
5403 return skip;
5404}
5405
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005406bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005407 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005408 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005409 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005410 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005411 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005412 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005413 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005414 }
5415 return skip;
5416}
5417
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005418bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005419 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005420 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005421 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005422 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005423 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005424 skip |=
5425 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5426 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005427 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005428 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005429 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5430 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005431 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005432
sfricke-samsung022fa252020-07-24 03:26:16 -07005433 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5434 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5435
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005436 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005437 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5438 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5439 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5440 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005441 }
5442
5443 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005444 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5445 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5446 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5447 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005448 }
5449
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005450 return skip;
5451}
5452
Jeff Leger178b1e52020-10-05 12:22:23 -04005453template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005454bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005455 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005456 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005457 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005458 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5459 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005460
sfricke-samsung125d2b42020-05-28 06:32:43 -07005461 assert(image_state != nullptr);
5462 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005463
5464 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005465 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005466 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5467 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005468 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005469 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5470 "and 1, respectively.",
5471 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005472 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005473 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005474
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005475 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5476 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005477 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005478 "%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 -07005479 "must be 0 and 1, respectively.",
5480 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005481 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005482 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005483
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005484 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5485 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005486 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005487 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005488 "For 3D images these must be 0 and 1, respectively.",
5489 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005490 }
5491 }
5492
5493 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005494 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005495 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005496
sfricke-samsung125d2b42020-05-28 06:32:43 -07005497 // If not depth/stencil and not multi-plane
5498 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5499 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005500 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5501 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
5502 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005503 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005504 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005505 " must be a multiple of this format's texel size (%" PRIu32 ").",
5506 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005507 }
5508
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005509 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5510 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005511 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005512 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005513 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005514 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005515 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005516 }
5517
5518 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5519 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005520 vuid =
5521 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04005522 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005523 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005524 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5525 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005526 }
5527
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005528 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005529 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005530 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005531 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 -06005532 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5533 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005534 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005535 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005536 "zero or <= image subresource width (%d).",
5537 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005538 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005539 }
5540
5541 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005542 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 -06005543 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5544 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005545 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005546 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005547 "zero or <= image subresource height (%d).",
5548 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005549 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005550 }
5551
5552 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005553 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 -06005554 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5555 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005556 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005557 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005558 "zero or <= image subresource depth (%d).",
5559 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005560 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005561 }
5562
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005563 // subresource aspectMask must have exactly 1 bit set
5564 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005565 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005566 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005567 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5568 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005569 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005570 }
5571
5572 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005573 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005574 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005575 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005576 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5577 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005578 }
5579
5580 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005581 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5582 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005583
5584 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005585 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005586 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005587 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005588 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5589 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005590 }
5591
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005592 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005593 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005594 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005595 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005596 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005597 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005598 }
5599
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005600 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005601 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5602 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5603 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005604 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005605 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005606 "width & height (%d, %d)..",
5607 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5608 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005609 }
5610
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005611 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005612 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005613 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005614 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005615 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005616 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5617 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005618 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005619
5620 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005621 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005622 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005623 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005624 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005625 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005626 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5627 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5628 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005629 }
5630
5631 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005632 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005633 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005634 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005635 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005636 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5637 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5638 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005639 }
5640
5641 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005642 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005643 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005644 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005645 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005646 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5647 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5648 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005649 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005650 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005651
5652 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005653 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005654 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005655 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005656 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005657 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005658 "format has three planes.",
5659 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005660 }
5661
5662 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005663 if (0 ==
5664 (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 -07005665 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005666 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005667 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5668 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005669 } else {
5670 // Know aspect mask is valid
5671 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5672 const uint32_t compatible_size = FormatElementSize(compatible_format);
5673 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5674 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005675 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005676 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005677 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5678 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5679 string_VkFormat(compatible_format));
5680 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005681 }
5682 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005683 }
5684
5685 return skip;
5686}
5687
Jeff Leger178b1e52020-10-05 12:22:23 -04005688template <typename BufferImageCopyRegionType>
5689bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5690 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005691 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005692 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005693
5694 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005695 VkExtent3D extent = pRegions[i].imageExtent;
5696 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005697
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005698 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5699 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005700 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5701 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5702 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005703 }
5704
5705 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5706
5707 // 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 -06005708 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005709 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005710 if (image_extent.width % block_extent.width) {
5711 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5712 }
5713 if (image_extent.height % block_extent.height) {
5714 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5715 }
5716 if (image_extent.depth % block_extent.depth) {
5717 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5718 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005719 }
5720
Dave Houltonfc1a4052017-04-27 14:32:45 -06005721 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005722 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005723 }
5724 }
5725
5726 return skip;
5727}
5728
Jeff Leger178b1e52020-10-05 12:22:23 -04005729template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005730bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005731 const BufferImageCopyRegionType *pRegions, const char *func_name,
5732 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005733 bool skip = false;
5734
5735 VkDeviceSize buffer_size = buff_state->createInfo.size;
5736
5737 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005738 VkDeviceSize max_buffer_offset =
5739 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5740 if (buffer_size < max_buffer_offset) {
5741 skip |=
5742 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 -07005743 }
5744 }
5745
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005746 return skip;
5747}
5748
Jeff Leger178b1e52020-10-05 12:22:23 -04005749template <typename BufferImageCopyRegionType>
5750bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5751 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5752 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005753 const auto cb_node = GetCBState(commandBuffer);
5754 const auto src_image_state = GetImageState(srcImage);
5755 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005756
Jeff Leger178b1e52020-10-05 12:22:23 -04005757 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5758 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5759 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5760 const char *vuid;
5761
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005762 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005763
5764 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005765 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005766
5767 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005768 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005769
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005770 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005771
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005772 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005773 vuid =
5774 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5775 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5776 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5777 "or transfer capabilities.",
5778 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005779 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005780 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5781 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5782 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5783 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005784
Jeff Leger178b1e52020-10-05 12:22:23 -04005785 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5786 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5787 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5788
5789 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5790 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5791 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5792 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005793
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005794 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005795 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5796 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005797 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005798 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5799 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005800 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005801 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5802 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5803 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5804 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5805 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5806 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005807
5808 // Validation for VK_EXT_fragment_density_map
5809 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005810 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5811 skip |= LogError(cb_node->commandBuffer, vuid,
5812 "%s: srcImage must not have been created with flags containing "
5813 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5814 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005815 }
5816
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005817 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005818 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5819 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005820 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005821 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5822 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005823 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005824
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005825 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 -04005826 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5827 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5828 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5829 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5830
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005831 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005832 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5833 vuid =
5834 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005835 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005836 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5837 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5838 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5839 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5840 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5841 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5842 "imageSubresource", vuid);
5843 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5844 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005845 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005846 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005847 }
5848 return skip;
5849}
5850
Jeff Leger178b1e52020-10-05 12:22:23 -04005851bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5852 VkBuffer dstBuffer, uint32_t regionCount,
5853 const VkBufferImageCopy *pRegions) const {
5854 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5855 COPY_COMMAND_VERSION_1);
5856}
5857
5858bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5859 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5860 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5861 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5862 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5863}
5864
John Zulauf1686f232019-07-09 16:27:11 -06005865void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5866 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5867 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5868
5869 auto cb_node = GetCBState(commandBuffer);
5870 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005871 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005872 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005873 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005874 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005875}
5876
Jeff Leger178b1e52020-10-05 12:22:23 -04005877void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5878 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5879 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5880
5881 auto cb_node = GetCBState(commandBuffer);
5882 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5883 // Make sure that all image slices record referenced layout
5884 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5885 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5886 pCopyImageToBufferInfo->srcImageLayout);
5887 }
5888}
5889
5890template <typename RegionType>
5891bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5892 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5893 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005894 const auto cb_node = GetCBState(commandBuffer);
5895 const auto src_buffer_state = GetBufferState(srcBuffer);
5896 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005897
Jeff Leger178b1e52020-10-05 12:22:23 -04005898 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5899 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5900 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5901 const char *vuid;
5902
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005903 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005904
5905 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005906 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005907
sfricke-samsungea4fd142020-10-17 23:51:59 -07005908 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5909 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5910
Jeff Leger178b1e52020-10-05 12:22:23 -04005911 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5912 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5913 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5914 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5915
5916 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5917 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5918 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5919 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5920 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5921 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5922 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5923 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5924 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005925 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005926 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5927 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005928 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005929 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5930 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5931 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5932 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5933 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5934 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005935
5936 // Validation for VK_EXT_fragment_density_map
5937 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005938 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5939 skip |= LogError(cb_node->commandBuffer, vuid,
5940 "%s: dstImage must not have been created with flags containing "
5941 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5942 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005943 }
5944
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005945 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005946 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
5947 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005948 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005949 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
5950 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005951 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005952
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005953 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 -04005954 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
5955 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
5956 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
5957 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
5958
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005959 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005960 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5961 vuid =
5962 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005963 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005964 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
5965 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
5966 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
5967 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
5968 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
5969 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5970 "imageSubresource", vuid);
5971 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
5972 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005973 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005974 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07005975
5976 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5977 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5978 assert(command_pool != nullptr);
5979 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5980 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5981 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
5982 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
5983 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
5984 LogObjectList objlist(cb_node->commandBuffer);
5985 objlist.add(command_pool->commandPool);
5986 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
5987 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
5988 skip |= LogError(dst_image_state->image, vuid,
5989 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5990 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5991 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5992 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5993 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
5994 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005995 }
5996 return skip;
5997}
5998
Jeff Leger178b1e52020-10-05 12:22:23 -04005999bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6000 VkImageLayout dstImageLayout, uint32_t regionCount,
6001 const VkBufferImageCopy *pRegions) const {
6002 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6003 COPY_COMMAND_VERSION_1);
6004}
6005
6006bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6007 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6008 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6009 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6010 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6011}
6012
John Zulauf1686f232019-07-09 16:27:11 -06006013void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6014 VkImageLayout dstImageLayout, uint32_t regionCount,
6015 const VkBufferImageCopy *pRegions) {
6016 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6017
6018 auto cb_node = GetCBState(commandBuffer);
6019 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006020 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006021 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006022 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006023 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006024}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006025
Jeff Leger178b1e52020-10-05 12:22:23 -04006026void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6027 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6028 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6029
6030 auto cb_node = GetCBState(commandBuffer);
6031 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6032 // Make sure that all image slices are record referenced layout
6033 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6034 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6035 pCopyBufferToImageInfo2KHR->dstImageLayout);
6036 }
6037}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006038bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006039 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006040 bool skip = false;
6041 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6042
Dave Houlton1d960ff2018-01-19 12:17:05 -07006043 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006044 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6045 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6046 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006047 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6048 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006049 }
6050
John Zulaufa26d3c82019-08-14 16:09:08 -06006051 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006052 if (!image_entry) {
6053 return skip;
6054 }
6055
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006056 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6057 if (device_extensions.vk_ext_image_drm_format_modifier) {
6058 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6059 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006060 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6061 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6062 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006063 }
6064 } else {
6065 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006066 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6067 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006068 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006069 }
6070
Dave Houlton1d960ff2018-01-19 12:17:05 -07006071 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006072 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006073 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6074 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6075 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006076 }
6077
Dave Houlton1d960ff2018-01-19 12:17:05 -07006078 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006079 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006080 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6081 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6082 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006083 }
6084
Dave Houlton1d960ff2018-01-19 12:17:05 -07006085 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006086 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006087 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6088 if (FormatIsMultiplane(img_format)) {
6089 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
6090 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6091 if (FormatPlaneCount(img_format) > 2u) {
6092 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
6093 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6094 }
6095 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006096 skip |= LogError(image, vuid,
6097 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6098 ") must be a single-plane specifier flag.",
6099 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006100 }
6101 } else if (FormatIsColor(img_format)) {
6102 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006103 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6104 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6105 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006106 }
6107 } else if (FormatIsDepthOrStencil(img_format)) {
6108 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6109 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006110 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006111 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6112 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6113 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6114 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006115 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6116 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6117 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006118 }
6119 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006120
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006121 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006122 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006123 }
6124
Mike Weiblen672b58b2017-02-21 14:32:53 -07006125 return skip;
6126}
sfricke-samsung022fa252020-07-24 03:26:16 -07006127
6128// Validates the image is allowed to be protected
6129bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006130 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006131 bool skip = false;
6132 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6133 LogObjectList objlist(cb_state->commandBuffer);
6134 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006135 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 -07006136 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006137 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006138 }
6139 return skip;
6140}
6141
6142// Validates the image is allowed to be unprotected
6143bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006144 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006145 bool skip = false;
6146 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6147 LogObjectList objlist(cb_state->commandBuffer);
6148 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006149 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 -07006150 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006151 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006152 }
6153 return skip;
6154}
6155
6156// Validates the buffer is allowed to be protected
6157bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006158 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006159 bool skip = false;
6160 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6161 LogObjectList objlist(cb_state->commandBuffer);
6162 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006163 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 -07006164 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006165 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006166 }
6167 return skip;
6168}
6169
6170// Validates the buffer is allowed to be unprotected
6171bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006172 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006173 bool skip = false;
6174 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6175 LogObjectList objlist(cb_state->commandBuffer);
6176 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006177 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 -07006178 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006179 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006180 }
6181 return skip;
6182}