blob: 36068ba5bc75db2f0a22ceffb6dacdffd25a056a [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
190 const VkExternalFormatANDROID *pExternalFormatANDROID = lvl_find_in_chain<VkExternalFormatANDROID>(&create_info);
191 bool isExternalFormatConversion = (pExternalFormatANDROID != nullptr && pExternalFormatANDROID->externalFormat != 0);
192#else
193 bool isExternalFormatConversion = false;
194#endif
195
196 if (FormatIsColor(format) || FormatIsMultiplane(format) || isExternalFormatConversion) {
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)) {
233 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
234 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
235 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
236 }
237 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
238 }
239
240 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
241 sparse = true;
242 }
Locked8af3732019-05-10 09:47:56 -0600243
sfricke-samsunge2441192019-11-06 14:07:57 -0800244 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
245 if (externalMemoryInfo) {
246 external_memory_handle = externalMemoryInfo->handleTypes;
247 }
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 &&
281 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
282 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700283 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
284 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600285 IsCreateInfoEqual(other_image_state->createInfo)) {
286 return true;
287 }
unknowne1661522019-07-11 13:04:18 -0600288 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
289 return true;
290 }
unknown2c877272019-07-11 12:56:50 -0600291 return false;
292}
293
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500294IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
295 : image_view(iv),
296 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700297 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600298 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500299 samplerConversion(VK_NULL_HANDLE),
300 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600301 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
302 if (conversionInfo) samplerConversion = conversionInfo->conversion;
303 if (image_state) {
304 // A light normalization of the createInfo range
305 auto &sub_res_range = create_info.subresourceRange;
306 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
307 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
308
309 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700310 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500311 samples = image_state->createInfo.samples;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200312
313 if (image_state->has_ahb_format) {
314 // When the image has a external format the views format must be VK_FORMAT_UNDEFINED and it is required to use a sampler
315 // Ycbcr conversion. Thus we can't extract any meaningful information from the format parameter. As a Sampler Ycbcr
316 // conversion must be used the shader type is always float.
317 descriptor_format_bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
318 } else {
319 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
320 }
John Zulauff660ad62019-03-23 07:16:05 -0600321 }
322}
323
locke-lunarg540b2252020-08-03 13:23:36 -0600324bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600325 if (image_view == compare_view.image_view) {
326 return true;
327 }
locke-lunargdc287022020-08-21 12:03:57 -0600328 if (image_state->image != compare_view.image_state->image) {
329 return false;
330 }
locke-lunarg540b2252020-08-03 13:23:36 -0600331 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
332 return false;
333 }
334
335 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600336 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600337 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600338 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600339 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600340 }
341
342 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600343 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600344 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600345 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600346 }
347
348 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600349 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600350 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600351 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600352 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600353 }
354
355 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600356 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600357 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600358 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600359 }
locke-lunargdc287022020-08-21 12:03:57 -0600360 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600361}
362
Dave Houltond9611312018-11-19 17:03:36 -0700363uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
364 // uint cast applies floor()
365 return 1u + (uint32_t)log2(std::max({height, width, depth}));
366}
367
368uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
369
370uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
371
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500372bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700373 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700374 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700375
John Zulauf2076e812020-01-08 14:55:54 -0700376 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
377 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700378 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
379 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
380
John Zulauf2076e812020-01-08 14:55:54 -0700381 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
382
383 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
384 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700385 return false;
386 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700387
John Zulauf2076e812020-01-08 14:55:54 -0700388 for (auto entry : *layout_range_map) {
389 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700390 }
391 return true;
392}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700393
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600394// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600395void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600396 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
397 VkImageLayout expected_layout) {
398 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
399 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600400 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600401 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700402 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700403 for (const auto &image : image_state.aliasing_images) {
404 auto alias_state = GetImageState(image);
405 // The map state of the aliases should all be in sync, so no need to check the return value
406 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
407 assert(subresource_map);
408 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
409 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700410}
John Zulauff660ad62019-03-23 07:16:05 -0600411
412// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600413void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600414 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500415 return;
416 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500417 IMAGE_STATE *image_state = view_state.image_state.get();
418 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700419 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700420 for (const auto &image : image_state->aliasing_images) {
421 image_state = GetImageState(image);
422 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
423 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
424 }
John Zulauff660ad62019-03-23 07:16:05 -0600425}
426
427// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600428void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600429 const VkImageSubresourceRange &range, VkImageLayout layout) {
430 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
431 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600432 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700433 for (const auto &image : image_state.aliasing_images) {
434 auto alias_state = GetImageState(image);
435 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
436 assert(subresource_map);
437 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
438 }
John Zulauff660ad62019-03-23 07:16:05 -0600439}
440
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600441void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600442 VkImageLayout layout) {
443 const IMAGE_STATE *image_state = GetImageState(image);
444 if (!image_state) return;
445 SetImageInitialLayout(cb_node, *image_state, range, layout);
446};
447
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600448void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600449 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
450 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600451}
Dave Houltonddd65c52018-05-08 14:58:01 -0600452
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600453// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700454void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
455 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500456 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600457
John Zulauff660ad62019-03-23 07:16:05 -0600458 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600459 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
460 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600461 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 -0600462 sub_range.baseArrayLayer = 0;
463 sub_range.layerCount = image_state->createInfo.extent.depth;
464 }
465
Piers Daniell4fde9b72019-11-27 16:19:46 -0700466 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
467 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
468 SetImageLayout(cb_node, *image_state, sub_range, layout);
469 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
470 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
471 } else {
472 SetImageLayout(cb_node, *image_state, sub_range, layout);
473 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600474}
475
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700476bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
477 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700478 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600479 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100480 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700481 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100482 const char *vuid;
483 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700484 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100485
486 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600487 LogObjectList objlist(image);
488 objlist.add(renderpass);
489 objlist.add(framebuffer);
490 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700491 skip |=
492 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
493 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
494 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
495 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100496 return skip;
497 }
498
499 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200500 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
501 if (stencil_usage_info) {
502 image_usage |= stencil_usage_info->stencilUsage;
503 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100504
505 // Check for layouts that mismatch image usages in the framebuffer
506 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800507 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600508 LogObjectList objlist(image);
509 objlist.add(renderpass);
510 objlist.add(framebuffer);
511 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700512 skip |= LogError(objlist, vuid,
513 "%s: Layout/usage mismatch for attachment %u in %s"
514 " - the %s is %s but the image attached to %s via %s"
515 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
516 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
517 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
518 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100519 }
520
521 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
522 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800523 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600524 LogObjectList objlist(image);
525 objlist.add(renderpass);
526 objlist.add(framebuffer);
527 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700528 skip |= LogError(objlist, vuid,
529 "%s: Layout/usage mismatch for attachment %u in %s"
530 " - the %s is %s but the image attached to %s via %s"
531 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
532 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
533 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
534 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100535 }
536
537 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800538 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600539 LogObjectList objlist(image);
540 objlist.add(renderpass);
541 objlist.add(framebuffer);
542 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700543 skip |= LogError(objlist, vuid,
544 "%s: Layout/usage mismatch for attachment %u in %s"
545 " - the %s is %s but the image attached to %s via %s"
546 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
547 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
548 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
549 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100550 }
551
552 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800553 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600554 LogObjectList objlist(image);
555 objlist.add(renderpass);
556 objlist.add(framebuffer);
557 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700558 skip |= LogError(objlist, vuid,
559 "%s: Layout/usage mismatch for attachment %u in %s"
560 " - the %s is %s but the image attached to %s via %s"
561 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
562 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
563 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
564 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100565 }
566
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600567 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100568 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
569 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
570 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
571 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
572 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800573 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600574 LogObjectList objlist(image);
575 objlist.add(renderpass);
576 objlist.add(framebuffer);
577 objlist.add(image_view);
578 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700579 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700580 " - the %s is %s but the image attached to %s via %s"
581 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700582 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700583 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
584 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100585 }
586 } else {
587 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
588 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
589 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
590 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600591 LogObjectList objlist(image);
592 objlist.add(renderpass);
593 objlist.add(framebuffer);
594 objlist.add(image_view);
595 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700596 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700597 " - the %s is %s but the image attached to %s via %s"
598 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700599 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700600 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
601 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100602 }
603 }
604 return skip;
605}
606
John Zulauf17a01bb2019-08-09 16:41:19 -0600607bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700608 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600609 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600610 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700611 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700612 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100613 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100614
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700615 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100616 auto framebuffer = framebuffer_state->framebuffer;
617
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700618 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700619 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
620 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700621 }
John Zulauf8e308292018-09-21 11:34:37 -0600622
Tobias Hectorc9057422019-07-23 12:15:52 +0100623 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
624 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
625 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100626 }
627
Tobias Hectorc9057422019-07-23 12:15:52 +0100628 if (attachments != nullptr) {
629 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
630 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
631 auto image_view = attachments[i];
632 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100633
Tobias Hectorc9057422019-07-23 12:15:52 +0100634 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600635 LogObjectList objlist(pRenderPassBegin->renderPass);
636 objlist.add(framebuffer_state->framebuffer);
637 objlist.add(image_view);
638 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700639 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
640 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
641 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100642 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100643 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100644
645 const VkImage image = view_state->create_info.image;
646 const IMAGE_STATE *image_state = GetImageState(image);
647
648 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600649 LogObjectList objlist(pRenderPassBegin->renderPass);
650 objlist.add(framebuffer_state->framebuffer);
651 objlist.add(image_view);
652 objlist.add(image);
653 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700654 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
655 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
656 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100657 continue;
658 }
659 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
660 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
661
Piers Daniell7f894f62020-01-09 16:33:48 -0700662 // Default to expecting stencil in the same layout.
663 auto attachment_stencil_initial_layout = attachment_initial_layout;
664
665 // If a separate layout is specified, look for that.
666 const auto *attachment_description_stencil_layout =
667 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
668 if (attachment_description_stencil_layout) {
669 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
670 }
671
Tobias Hectorc9057422019-07-23 12:15:52 +0100672 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
673 // in common with the non-const version.)
674 const ImageSubresourceLayoutMap *subresource_map =
675 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
676
677 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
678 LayoutUseCheckAndMessage layout_check(subresource_map);
679 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700680 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700681 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
682 // the next "constant value" range
683 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700684 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700685
John Zulauf5e617452019-11-19 14:44:16 -0700686 // Allow for differing depth and stencil layouts
687 VkImageLayout check_layout = attachment_initial_layout;
688 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
689
690 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700691 subres_skip |= LogError(
692 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700693 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
694 "and the %s layout of the attachment is %s. The layouts must match, or the render "
695 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700696 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100697 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700698 }
John Zulauf5e617452019-11-19 14:44:16 -0700699
Tobias Hectorc9057422019-07-23 12:15:52 +0100700 skip |= subres_skip;
701 }
702
703 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
704 framebuffer, render_pass, i, "initial layout");
705
706 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
707 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100708 }
709
Tobias Hectorc9057422019-07-23 12:15:52 +0100710 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
711 auto &subpass = pRenderPassInfo->pSubpasses[j];
712 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
713 auto &attachment_ref = subpass.pInputAttachments[k];
714 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
715 auto image_view = attachments[attachment_ref.attachment];
716 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100717
Tobias Hectorc9057422019-07-23 12:15:52 +0100718 if (view_state) {
719 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700720 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
721 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100722 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100723 }
724 }
725 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100726
Tobias Hectorc9057422019-07-23 12:15:52 +0100727 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
728 auto &attachment_ref = subpass.pColorAttachments[k];
729 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
730 auto image_view = attachments[attachment_ref.attachment];
731 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100732
Tobias Hectorc9057422019-07-23 12:15:52 +0100733 if (view_state) {
734 auto image = view_state->create_info.image;
735 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
736 framebuffer, render_pass, attachment_ref.attachment,
737 "color attachment layout");
738 if (subpass.pResolveAttachments) {
739 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
740 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
741 attachment_ref.attachment, "resolve attachment layout");
742 }
743 }
744 }
745 }
746
747 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
748 auto &attachment_ref = *subpass.pDepthStencilAttachment;
749 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
750 auto image_view = attachments[attachment_ref.attachment];
751 auto view_state = GetImageViewState(image_view);
752
753 if (view_state) {
754 auto image = view_state->create_info.image;
755 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
756 framebuffer, render_pass, attachment_ref.attachment,
757 "input attachment layout");
758 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100759 }
760 }
761 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700762 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600763 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700764}
765
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600766void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700767 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700768 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinski8d46f802020-12-07 16:33:54 -0700769 IMAGE_VIEW_STATE *image_view = GetActiveAttachmentImageViewState(pCB, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600770 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700771 VkImageLayout stencil_layout = kInvalidLayout;
772 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
773 if (attachment_reference_stencil_layout) {
774 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
775 }
776
777 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600778 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700779 }
780}
781
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600782void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
783 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700784 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700785
786 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700787 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700788 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700789 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700790 }
791 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700792 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700793 }
794 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700795 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700796 }
797 }
798}
799
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700800// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
801// 1. Transition into initialLayout state
802// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600803void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700804 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700805 // First transition into initialLayout
806 auto const rpci = render_pass_state->createInfo.ptr();
807 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -0700808 auto *view_state = GetActiveAttachmentImageViewState(cb_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600809 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700810 VkImageLayout stencil_layout = kInvalidLayout;
811 const auto *attachment_description_stencil_layout =
812 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
813 if (attachment_description_stencil_layout) {
814 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
815 }
816
817 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600818 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700819 }
820 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700821 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700822}
823
Dave Houlton10b39482017-03-16 13:18:15 -0600824bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600825 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600826 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600827 }
828 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600829 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600830 }
831 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600832 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600833 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700834 if (0 !=
835 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
836 if (FormatPlaneCount(format) == 1) return false;
837 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600838 return true;
839}
840
Mike Weiblen62d08a32017-03-07 22:18:27 -0700841// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200842bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
843 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600844 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700845 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200846 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600847 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700848
849 switch (layout) {
850 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
851 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600852 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700853 }
854 break;
855 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
856 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600857 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700858 }
859 break;
860 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
861 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600862 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700863 }
864 break;
865 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
866 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600867 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700868 }
869 break;
870 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
871 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600872 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700873 }
874 break;
875 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
876 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600877 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700878 }
879 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600880 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500881 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
882 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
883 }
884 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700885 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
886 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
887 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
888 }
889 break;
890 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
891 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
892 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
893 }
894 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700895 default:
896 // Other VkImageLayout values do not have VUs defined in this context.
897 break;
898 }
899
Dave Houlton8e9f6542018-05-18 12:18:22 -0600900 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700901 skip |= LogError(img_barrier.image, msg_code,
902 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
903 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
904 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700905 }
906 return skip;
907}
908
909// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600910bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
911 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700912 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700913
Petr Krausad0096a2019-08-09 18:35:04 +0200914 // Scoreboard for checking for duplicate and inconsistent barriers to images
915 struct ImageBarrierScoreboardEntry {
916 uint32_t index;
917 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
918 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
919 const VkImageMemoryBarrier *barrier;
920 };
921 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
922 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
923
John Zulauf463c51e2018-05-31 13:29:20 -0600924 // Scoreboard for duplicate layout transition barriers within the list
925 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
926 ImageBarrierScoreboardImageMap layout_transitions;
927
Mike Weiblen62d08a32017-03-07 22:18:27 -0700928 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200929 const auto &img_barrier = pImageMemoryBarriers[i];
930 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700931
John Zulauf463c51e2018-05-31 13:29:20 -0600932 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
933 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
934 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200935 if (img_barrier.oldLayout != img_barrier.newLayout) {
936 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
937 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600938 if (image_it != layout_transitions.end()) {
939 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200940 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600941 if (subres_it != subres_map.end()) {
942 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200943 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
944 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
945 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700946 skip = LogError(
947 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200948 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600949 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
950 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200951 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
952 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
953 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600954 }
955 entry = new_entry;
956 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200957 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600958 }
959 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200960 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600961 }
962 }
963
Petr Krausad0096a2019-08-09 18:35:04 +0200964 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600965 if (image_state) {
966 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200967 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
968 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600969
970 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
971 if (image_state->layout_locked) {
972 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700973 skip |= LogError(
974 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700975 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600976 " 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 -0700977 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200978 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600979 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600980
John Zulaufa4472282019-08-22 14:44:34 -0600981 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700982 const VkFormat image_format = image_create_info.format;
983 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600984 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700985 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700986 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600987 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
988 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700989 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
990 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
991 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
992 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700993 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600994 }
995 } else {
996 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
997 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700998 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
999 ? "VUID-VkImageMemoryBarrier-image-03320"
1000 : "VUID-VkImageMemoryBarrier-image-01207";
1001 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001002 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
1003 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1004 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001005 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001006 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001007 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001008 }
John Zulauff660ad62019-03-23 07:16:05 -06001009
Petr Krausad0096a2019-08-09 18:35:04 +02001010 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1011 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001012 // TODO: Set memory invalid which is in mem_tracker currently
1013 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1014 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001015 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001016 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001017 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001018 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001019 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1020 // the next "constant value" range
1021 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001022 const auto &value = *pos;
1023 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001024 subres_skip = LogError(
1025 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001026 "%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 -07001027 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001028 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -07001029 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1030 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001031 }
John Zulauf5e617452019-11-19 14:44:16 -07001032 }
John Zulauff660ad62019-03-23 07:16:05 -06001033 skip |= subres_skip;
1034 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001035
1036 // checks color format and (single-plane or non-disjoint)
1037 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1038 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001039 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001040 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1041 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
1042 ? "VUID-VkImageMemoryBarrier-image-01671"
1043 : "VUID-VkImageMemoryBarrier-image-02902";
1044 skip |= LogError(img_barrier.image, vuid,
1045 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1046 "but its aspectMask is 0x%" PRIx32 ".",
1047 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1048 string_VkFormat(image_format), aspect_mask);
1049 }
1050 }
1051
1052 VkImageAspectFlags valid_disjoint_mask =
1053 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 -07001054 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001055 ((aspect_mask & valid_disjoint_mask) == 0)) {
1056 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1057 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1058 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1059 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1060 string_VkFormat(image_format), aspect_mask);
1061 }
1062
1063 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1064 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1065 "%s: Image barrier %s references %s of format %s has only two planes but included "
1066 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1067 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1068 string_VkFormat(image_format), aspect_mask);
1069 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001070 }
1071 }
1072 return skip;
1073}
1074
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001075bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001076 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001077
Jeff Bolz6835fda2019-10-06 00:15:34 -05001078 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001079 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001080}
1081
John Zulauf6b4aae82018-05-09 13:03:36 -06001082template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001083bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1084 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001085 using BarrierRecord = QFOTransferBarrier<Barrier>;
1086 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001087 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001088 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1089 const char *barrier_name = BarrierRecord::BarrierName();
1090 const char *handle_name = BarrierRecord::HandleName();
1091 const char *transfer_type = nullptr;
1092 for (uint32_t b = 0; b < barrier_count; b++) {
1093 if (!IsTransferOp(&barriers[b])) continue;
1094 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001095 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001096 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001097 const auto found = barrier_sets.release.find(barriers[b]);
1098 if (found != barrier_sets.release.cend()) {
1099 barrier_record = &(*found);
1100 transfer_type = "releasing";
1101 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001102 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001103 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001104 const auto found = barrier_sets.acquire.find(barriers[b]);
1105 if (found != barrier_sets.acquire.cend()) {
1106 barrier_record = &(*found);
1107 transfer_type = "acquiring";
1108 }
1109 }
1110 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001111 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1112 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1113 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1114 func_name, barrier_name, b, transfer_type, handle_name,
1115 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1116 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001117 }
1118 }
1119 return skip;
1120}
1121
John Zulaufa4472282019-08-22 14:44:34 -06001122VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1123 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1124}
1125
1126const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1127 return device_state.GetImageState(barrier.image);
1128}
1129
1130VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1131 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1132}
1133
1134const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1135 return device_state.GetBufferState(barrier.buffer);
1136}
1137
1138VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1139
John Zulauf6b4aae82018-05-09 13:03:36 -06001140template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001141void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1142 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001143 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001144 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1145 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001146 auto &barrier = barriers[b];
1147 if (IsTransferOp(&barrier)) {
1148 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001149 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001150 barrier_sets.release.emplace(barrier);
1151 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001152 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001153 barrier_sets.acquire.emplace(barrier);
1154 }
1155 }
1156
1157 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1158 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1159 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1160 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1161 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1162 auto handle_state = BarrierHandleState(*this, barrier);
1163 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1164 if (!mode_concurrent) {
1165 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001166 cb_state->queue_submit_functions.emplace_back(
1167 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1168 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1169 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1170 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001171 });
1172 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001173 }
1174 }
1175}
1176
John Zulaufa4472282019-08-22 14:44:34 -06001177bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001178 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001179 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001180 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001181 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001182 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1183 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001184 return skip;
1185}
1186
John Zulaufa4472282019-08-22 14:44:34 -06001187void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1188 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1189 const VkImageMemoryBarrier *pImageMemBarriers) {
1190 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1191 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001192}
1193
1194template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001195bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001196 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001197 // Record to the scoreboard or report that we have a duplication
1198 bool skip = false;
1199 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1200 if (!inserted.second && inserted.first->second != cb_state) {
1201 // 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 -06001202 LogObjectList objlist(cb_state->commandBuffer);
1203 objlist.add(barrier.handle);
1204 objlist.add(inserted.first->second->commandBuffer);
1205 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001206 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1207 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1208 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1209 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1210 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001211 }
1212 return skip;
1213}
1214
1215template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001216bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1217 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001218 using BarrierRecord = QFOTransferBarrier<Barrier>;
1219 using TypeTag = typename BarrierRecord::Tag;
1220 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001221 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001222 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001223 const char *barrier_name = BarrierRecord::BarrierName();
1224 const char *handle_name = BarrierRecord::HandleName();
1225 // No release should have an extant duplicate (WARNING)
1226 for (const auto &release : cb_barriers.release) {
1227 // Check the global pending release barriers
1228 const auto set_it = global_release_barriers.find(release.handle);
1229 if (set_it != global_release_barriers.cend()) {
1230 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1231 const auto found = set_for_handle.find(release);
1232 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001233 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1234 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1235 " to dstQueueFamilyIndex %" PRIu32
1236 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1237 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1238 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001239 }
1240 }
1241 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1242 }
1243 // Each acquire must have a matching release (ERROR)
1244 for (const auto &acquire : cb_barriers.acquire) {
1245 const auto set_it = global_release_barriers.find(acquire.handle);
1246 bool matching_release_found = false;
1247 if (set_it != global_release_barriers.cend()) {
1248 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1249 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1250 }
1251 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001252 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1253 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1254 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1255 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1256 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001257 }
1258 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1259 }
1260 return skip;
1261}
1262
John Zulauf3b04ebd2019-07-18 14:08:11 -06001263bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001264 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001265 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001266 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001267 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1268 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001269 return skip;
1270}
1271
1272template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001273void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001274 using BarrierRecord = QFOTransferBarrier<Barrier>;
1275 using TypeTag = typename BarrierRecord::Tag;
1276 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001277 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001278
1279 // Add release barriers from this submit to the global map
1280 for (const auto &release : cb_barriers.release) {
1281 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1282 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1283 global_release_barriers[release.handle].insert(release);
1284 }
1285
1286 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1287 for (const auto &acquire : cb_barriers.acquire) {
1288 // NOTE: We're not using [] because we don't want to create entries for missing releases
1289 auto set_it = global_release_barriers.find(acquire.handle);
1290 if (set_it != global_release_barriers.end()) {
1291 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1292 set_for_handle.erase(acquire);
1293 if (set_for_handle.size() == 0) { // Clean up empty sets
1294 global_release_barriers.erase(set_it);
1295 }
1296 }
1297 }
1298}
1299
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001300void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001301 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1302 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001303}
1304
John Zulauf6b4aae82018-05-09 13:03:36 -06001305// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001306void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001307
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001308void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001309 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001310 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001311 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001312
Chris Forbes4de4b132017-08-21 11:27:08 -07001313 // For ownership transfers, the barrier is specified twice; as a release
1314 // operation on the yielding queue family, and as an acquire operation
1315 // on the acquiring queue family. This barrier may also include a layout
1316 // transition, which occurs 'between' the two operations. For validation
1317 // purposes it doesn't seem important which side performs the layout
1318 // transition, but it must not be performed twice. We'll arbitrarily
1319 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001320 //
1321 // However, we still need to record initial layout for the "initial layout" validation
1322 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001323
Petr Krausad0096a2019-08-09 18:35:04 +02001324 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001325 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001326 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001327 }
1328}
1329
unknown86bcb3a2019-07-11 13:05:36 -06001330void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001331 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001332 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1333 const auto &image_create_info = image_state->createInfo;
1334
1335 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1336 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1337 // for all (potential) layer sub_resources.
1338 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1339 normalized_isr.baseArrayLayer = 0;
1340 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1341 }
1342
Michael Spang8af7c102020-05-03 20:50:09 -04001343 VkImageLayout initial_layout = mem_barrier.oldLayout;
1344
1345 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001346 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001347 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1348 }
1349
John Zulauf2be3fe02019-12-30 09:48:02 -07001350 if (is_release_op) {
1351 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1352 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001353 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001354 }
unknown86bcb3a2019-07-11 13:05:36 -06001355}
1356
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001357bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1358 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1359 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1360 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001361 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001362 assert(cb_node);
1363 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001364 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001365 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001366
John Zulauff660ad62019-03-23 07:16:05 -06001367 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1368 if (subresource_map) {
1369 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001370 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001371 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1372 // the next "constant value" range
1373 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001374 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001375 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001376 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1377 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1378 "%s layout %s.",
1379 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1380 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1381 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001382 }
John Zulauf5e617452019-11-19 14:44:16 -07001383 }
John Zulauff660ad62019-03-23 07:16:05 -06001384 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001385 }
John Zulauff660ad62019-03-23 07:16:05 -06001386
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001387 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1388 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1389 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001390 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1391 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001392 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1393 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1394 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001395 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001396 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001397 if (image_state->shared_presentable) {
1398 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001399 skip |=
1400 LogError(device, layout_invalid_msg_code,
1401 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1402 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001403 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001404 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001405 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001406 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001407 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1408 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1409 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1410 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001411 }
1412 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001413 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001414}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001415bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001416 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1417 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001418 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001419 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1420 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1421}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001422
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001423void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001424 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001425 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001426 if (!renderPass) return;
1427
Tobias Hectorbbb12282018-10-22 15:17:59 +01001428 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001429 if (framebuffer_state) {
1430 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001431 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001432 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001433 VkImageLayout stencil_layout = kInvalidLayout;
1434 const auto *attachment_description_stencil_layout =
1435 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1436 if (attachment_description_stencil_layout) {
1437 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1438 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001439 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001440 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001441 }
1442 }
1443}
Dave Houltone19e20d2018-02-02 16:32:41 -07001444
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001445#ifdef VK_USE_PLATFORM_ANDROID_KHR
1446// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1447// This could also move into a seperate core_validation_android.cpp file... ?
1448
1449//
1450// AHB-specific validation within non-AHB APIs
1451//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001452bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001453 bool skip = false;
1454
1455 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1456 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001457 if (0 != ext_fmt_android->externalFormat) {
1458 if (VK_FORMAT_UNDEFINED != create_info->format) {
1459 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001460 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1461 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1462 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001463 }
1464
1465 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001466 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1467 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1468 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001469 }
1470
1471 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001472 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1473 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001474 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1475 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1476 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001477 }
1478
1479 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001480 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1481 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1482 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001483 }
1484 }
1485
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001486 if ((0 != ext_fmt_android->externalFormat) &&
1487 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001488 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001489 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1490 ") which has "
1491 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1492 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001493 }
1494 }
1495
Dave Houltond9611312018-11-19 17:03:36 -07001496 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001497 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001498 skip |=
1499 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1500 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1501 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001502 }
1503 }
1504
1505 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1506 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1507 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001508 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001509 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1510 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1511 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1512 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001513 }
1514
1515 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001516 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1517 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1518 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1519 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1520 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001521 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001522 }
1523
1524 return skip;
1525}
1526
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001527bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001528 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001529 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001530
1531 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001532 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001533 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1534 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001535 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001536 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001537 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001538
Dave Houltond9611312018-11-19 17:03:36 -07001539 // Chain must include a compatible ycbcr conversion
1540 bool conv_found = false;
1541 uint64_t external_format = 0;
1542 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1543 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001544 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001545 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001546 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001547 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001548 }
Dave Houltond9611312018-11-19 17:03:36 -07001549 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001550 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001551 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001552 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1553 "an externalFormat (%" PRIu64
1554 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1555 "with the same external format.",
1556 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001557 }
1558
1559 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001560 if (IsIdentitySwizzle(create_info->components) == false) {
1561 skip |= LogError(
1562 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1563 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1564 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1565 "= %s.",
1566 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1567 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001568 }
1569 }
Dave Houltond9611312018-11-19 17:03:36 -07001570
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001571 return skip;
1572}
1573
John Zulaufa26d3c82019-08-14 16:09:08 -06001574bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001575 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001576
John Zulaufa26d3c82019-08-14 16:09:08 -06001577 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001578 if (image_state != nullptr) {
1579 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1580 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1581 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1582 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1583 "bound to memory.");
1584 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001585 }
1586 return skip;
1587}
1588
1589#else
1590
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001591bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001592 return false;
1593}
1594
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001595bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001596
John Zulaufa26d3c82019-08-14 16:09:08 -06001597bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001598
1599#endif // VK_USE_PLATFORM_ANDROID_KHR
1600
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001601bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1602 bool skip = false;
1603
1604 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1605 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1606 const VkImageTiling image_tiling = pCreateInfo->tiling;
1607 const VkFormat image_format = pCreateInfo->format;
1608
1609 if (image_format == VK_FORMAT_UNDEFINED) {
1610 // VU 01975 states format can't be undefined unless an android externalFormat
1611#ifdef VK_USE_PLATFORM_ANDROID_KHR
1612 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1613 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1614 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1615 if (it != ahb_ext_formats_map.end()) {
1616 tiling_features = it->second;
1617 }
1618 }
1619#endif
1620 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1621 uint64_t drm_format_modifier = 0;
1622 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1623 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1624 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1625 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1626
1627 if (drm_explicit != nullptr) {
1628 drm_format_modifier = drm_explicit->drmFormatModifier;
1629 } else {
1630 // VUID 02261 makes sure its only explict or implict in parameter checking
1631 assert(drm_implicit != nullptr);
1632 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1633 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1634 }
1635 }
1636
1637 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1638 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1639 nullptr};
1640 format_properties_2.pNext = (void *)&drm_properties_list;
1641 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001642 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1643 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1644 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1645 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001646
1647 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1648 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1649 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1650 }
1651 }
1652 } else {
1653 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1654 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1655 : format_properties.optimalTilingFeatures;
1656 }
1657
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001658 // Lack of disjoint format feature support while using the flag
1659 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1660 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1661 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1662 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1663 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1664 string_VkFormat(pCreateInfo->format));
1665 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001666
1667 return skip;
1668}
1669
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001670bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001671 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001672 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001673
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001674 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001675 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001676 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1677 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001678 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1679 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001680 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001681 }
1682
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001683 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1684 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001685 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1686 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1687 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001688 }
1689
1690 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001691 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1692 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1693 "height (%d) and arrayLayers (%d) must be >= 6.",
1694 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001695 }
Dave Houlton130c0212018-01-29 13:39:56 -07001696 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001697
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001698 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001699 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1700 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1701 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001702 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1703 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1704 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001705 }
1706
1707 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001708 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1709 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1710 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001711 }
1712
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001713 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001714 uint32_t ceiling_width =
1715 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1716 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1717 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1718 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001719 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1720 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1721 "ceiling of device "
1722 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1723 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1724 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001725 }
1726
1727 uint32_t ceiling_height =
1728 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1729 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1730 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1731 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001732 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1733 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1734 "ceiling of device "
1735 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1736 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1737 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001738 }
1739 }
1740
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001741 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001742 VkResult result = VK_SUCCESS;
1743 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1744 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1745 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1746 &format_limits);
1747 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001748 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1749 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1750 if (modifier_list) {
1751 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1752 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1753 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1754 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1755 image_format_info.type = pCreateInfo->imageType;
1756 image_format_info.format = pCreateInfo->format;
1757 image_format_info.tiling = pCreateInfo->tiling;
1758 image_format_info.usage = pCreateInfo->usage;
1759 image_format_info.flags = pCreateInfo->flags;
1760 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1761
1762 result =
1763 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1764 format_limits = image_format_properties.imageFormatProperties;
1765
1766 /* The application gives a list of modifier and the driver
1767 * selects one. If one is wrong, stop there.
1768 */
1769 if (result != VK_SUCCESS) break;
1770 }
1771 } else if (explicit_modifier) {
1772 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1773 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1774 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1775 image_format_info.type = pCreateInfo->imageType;
1776 image_format_info.format = pCreateInfo->format;
1777 image_format_info.tiling = pCreateInfo->tiling;
1778 image_format_info.usage = pCreateInfo->usage;
1779 image_format_info.flags = pCreateInfo->flags;
1780 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1781
1782 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1783 format_limits = image_format_properties.imageFormatProperties;
1784 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001785 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001786
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001787 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1788 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1789 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1790 if (result != VK_SUCCESS) {
1791 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001792#ifdef VK_USE_PLATFORM_ANDROID_KHR
1793 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1794#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001795 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001796 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001797 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1798 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001799 } else {
1800 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1801 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001802 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1803 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1804 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001805 }
Dave Houlton130c0212018-01-29 13:39:56 -07001806
Dave Houltona585d132019-01-18 13:05:42 -07001807 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1808 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1809 (uint64_t)pCreateInfo->samples;
Mark Young0ec6b062020-11-19 15:32:17 -07001810 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count));
Dave Houlton130c0212018-01-29 13:39:56 -07001811
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001812 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001813 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001814 uint64_t ig_mask = imageGranularity - 1;
1815 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001816
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001817 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001818 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1819 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1820 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1821 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001822 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001823
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001824 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001825 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1826 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1827 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001828 }
1829
1830 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001831 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1832 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1833 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001834 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001835
1836 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1837 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1838 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1839 pCreateInfo->extent.width, format_limits.maxExtent.width);
1840 }
1841
1842 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1843 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1844 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1845 pCreateInfo->extent.height, format_limits.maxExtent.height);
1846 }
1847
1848 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1849 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1850 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1851 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1852 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001853 }
1854
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001855 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001856 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1857 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1858 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1859 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001860 skip |= LogError(device, error_vuid,
1861 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1862 "YCbCr Conversion format, arrayLayers must be 1",
1863 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001864 }
1865
1866 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001867 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1868 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1869 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001870 }
1871
1872 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001873 skip |= LogError(
1874 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001875 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1876 string_VkSampleCountFlagBits(pCreateInfo->samples));
1877 }
1878
1879 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001880 skip |= LogError(
1881 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001882 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1883 string_VkImageType(pCreateInfo->imageType));
1884 }
1885 }
1886
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001887 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001888 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001889 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001890 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001891 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1892 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1893 "format must be block, ETC or ASTC compressed, but is %s",
1894 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001895 }
1896 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001897 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1898 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1899 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001900 }
1901 }
1902 }
1903
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001904 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001905 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1906 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1907 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001908 }
1909
unknown2c877272019-07-11 12:56:50 -06001910 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1911 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1912 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001913 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1914 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1915 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001916 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001917
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001918 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1919 if (swapchain_create_info != nullptr) {
1920 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1921 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1922 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1923
1924 // Validate rest of Swapchain Image create check that require swapchain state
1925 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1926 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1927 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1928 skip |= LogError(
1929 device, vuid,
1930 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1931 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1932 }
1933 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1934 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1935 skip |= LogError(device, vuid,
1936 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1937 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1938 }
1939 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1940 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1941 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1942 skip |= LogError(device, vuid,
1943 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1944 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1945 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1946 }
1947 }
1948 }
1949
sfricke-samsungedce77a2020-07-03 22:35:13 -07001950 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1951 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1952 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1953 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1954 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1955 }
1956 const VkImageCreateFlags invalid_flags =
1957 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1958 if ((pCreateInfo->flags & invalid_flags) != 0) {
1959 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1960 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1961 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1962 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1963 }
1964 }
1965
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001966 skip |= ValidateImageFormatFeatures(pCreateInfo);
1967
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07001968 // Check compatibility with VK_KHR_portability_subset
1969 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
1970 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
1971 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
1972 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
1973 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
1974 }
1975 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
1976 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
1977 skip |=
1978 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
1979 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
1980 }
1981 }
1982
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001983 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001984}
1985
John Zulauf7eeb6f72019-06-17 11:56:36 -06001986void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1987 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1988 if (VK_SUCCESS != result) return;
1989
1990 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001991 auto image_state = Get<IMAGE_STATE>(*pImage);
1992 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001993}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001994
Jeff Bolz5c801d12019-10-09 10:38:45 -05001995bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001996 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001997 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001998 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001999 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002000 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002001 }
2002 return skip;
2003}
2004
John Zulauf7eeb6f72019-06-17 11:56:36 -06002005void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2006 // Clean up validation specific data
2007 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002008
locke-lunargcba7d5f2019-12-30 16:59:11 -07002009 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002010
2011 // Clean up generic image state
2012 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002013}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002014
sfricke-samsungcd924d92020-05-20 23:51:17 -07002015bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2016 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002017 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002018 const VkImage image = image_state->image;
2019 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002020
2021 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002022 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2023 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002024 }
2025
sfricke-samsungcd924d92020-05-20 23:51:17 -07002026 if (FormatIsDepthOrStencil(format)) {
2027 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2028 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2029 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2030 } else if (FormatIsCompressed(format)) {
2031 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2032 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2033 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002034 }
2035
2036 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002037 skip |=
2038 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2039 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2040 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002041 }
2042 return skip;
2043}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002044
John Zulauf07288512019-07-05 11:09:50 -06002045bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2046 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2047 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002048 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002049 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2050 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002051 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2052 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2053 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002054 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002055
2056 } else {
2057 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2058 if (!device_extensions.vk_khr_shared_presentable_image) {
2059 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002060 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2061 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2062 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002063 }
2064 } else {
2065 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2066 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002067 skip |= LogError(
2068 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002069 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2070 func_name, string_VkImageLayout(dest_image_layout));
2071 }
2072 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002073 }
2074
John Zulauff660ad62019-03-23 07:16:05 -06002075 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002076 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002077 if (subresource_map) {
2078 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002079 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002080 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002081 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2082 // the next "constant value" range
2083 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002084 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002085 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2086 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2087 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2088 } else {
2089 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002090 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002091 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2092 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2093 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2094 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002095 }
John Zulauf5e617452019-11-19 14:44:16 -07002096 }
John Zulauff660ad62019-03-23 07:16:05 -06002097 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002098 }
2099
2100 return skip;
2101}
2102
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002103bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2104 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002105 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002106 bool skip = false;
2107 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002108 const auto *cb_node = GetCBState(commandBuffer);
2109 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002110 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002111 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002112 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002113 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002114 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002115 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002116 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2117 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002118 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002119 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002120 skip |=
2121 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2122 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2123 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002124 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002125 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002126 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002127 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002128 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002129 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002130 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2131 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2132 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2133 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2134 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2135 string_VkFormat(image_state->createInfo.format));
2136 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002137 }
2138 return skip;
2139}
2140
John Zulaufeabb4462019-07-05 14:13:03 -06002141void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2142 const VkClearColorValue *pColor, uint32_t rangeCount,
2143 const VkImageSubresourceRange *pRanges) {
2144 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2145
2146 auto cb_node = GetCBState(commandBuffer);
2147 auto image_state = GetImageState(image);
2148 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002149 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002150 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002151 }
2152 }
2153}
2154
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002155bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2156 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002157 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002158 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002159
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002160 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002161 const auto *cb_node = GetCBState(commandBuffer);
2162 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002163 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002164 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002165 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002166 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002167 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002168 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002169 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002170 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002171 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002172 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002173 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002174 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002175 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2176 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2177 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2178 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002179
2180 bool any_include_aspect_depth_bit = false;
2181 bool any_include_aspect_stencil_bit = false;
2182
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002183 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002184 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002185 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002186 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002187 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002188 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2189 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002190 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2191 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2192 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2193 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002194 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002195 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2196 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002197 if (FormatHasDepth(image_format) == false) {
2198 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2199 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2200 "doesn't have a depth component.",
2201 i, string_VkFormat(image_format));
2202 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002203 }
2204 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2205 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002206 if (FormatHasStencil(image_format) == false) {
2207 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2208 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2209 "%s doesn't have a stencil component.",
2210 i, string_VkFormat(image_format));
2211 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002212 }
2213 }
2214 if (any_include_aspect_stencil_bit) {
2215 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2216 if (image_stencil_struct != nullptr) {
2217 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2218 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002219 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2220 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2221 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2222 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002223 }
2224 } else {
2225 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002226 skip |= LogError(
2227 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002228 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2229 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2230 "in VkImageCreateInfo::usage used to create image");
2231 }
2232 }
2233 }
2234 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002235 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2236 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2237 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002238 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002239 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002240 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2241 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002242 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002243 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002244 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002245 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2246 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2247 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2248 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002249 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002250 }
2251 return skip;
2252}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002253
John Zulaufeabb4462019-07-05 14:13:03 -06002254void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2255 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2256 const VkImageSubresourceRange *pRanges) {
2257 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2258 auto cb_node = GetCBState(commandBuffer);
2259 auto image_state = GetImageState(image);
2260 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002261 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002262 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002263 }
2264 }
2265}
2266
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002267// Returns true if [x, xoffset] and [y, yoffset] overlap
2268static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2269 bool result = false;
2270 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2271 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2272
2273 if (intersection_max > intersection_min) {
2274 result = true;
2275 }
2276 return result;
2277}
2278
Jeff Leger178b1e52020-10-05 12:22:23 -04002279// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002280// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002281template <typename RegionType>
2282static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002283 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002284
Dave Houltonc991cc92018-03-06 11:08:51 -07002285 // Separate planes within a multiplane image cannot intersect
2286 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002287 return result;
2288 }
2289
Dave Houltonc991cc92018-03-06 11:08:51 -07002290 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2291 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2292 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002293 result = true;
2294 switch (type) {
2295 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002296 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002297 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002298 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002299 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002300 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002301 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002302 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002303 break;
2304 default:
2305 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2306 assert(false);
2307 }
2308 }
2309 return result;
2310}
2311
Dave Houltonfc1a4052017-04-27 14:32:45 -06002312// Returns non-zero if offset and extent exceed image extents
2313static const uint32_t x_bit = 1;
2314static const uint32_t y_bit = 2;
2315static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002316static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002317 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002318 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002319 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2320 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002321 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002322 }
2323 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2324 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002325 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002326 }
2327 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2328 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002329 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002330 }
2331 return result;
2332}
2333
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002334// Test if two VkExtent3D structs are equivalent
2335static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2336 bool result = true;
2337 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2338 (extent->depth != other_extent->depth)) {
2339 result = false;
2340 }
2341 return result;
2342}
2343
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002344// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002345static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002346 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2347}
2348
2349// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002350VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002351 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2352 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002353 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002354 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002355 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002356 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002357 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002358 granularity.width *= block_size.width;
2359 granularity.height *= block_size.height;
2360 }
2361 }
2362 return granularity;
2363}
2364
2365// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2366static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2367 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002368 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2369 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002370 valid = false;
2371 }
2372 return valid;
2373}
2374
2375// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002376bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002377 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002378 bool skip = false;
2379 VkExtent3D offset_extent = {};
2380 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2381 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2382 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002383 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002384 // 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 -07002385 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002386 skip |= LogError(cb_node->commandBuffer, vuid,
2387 "%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 "
2388 "image transfer granularity is (w=0, h=0, d=0).",
2389 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002390 }
2391 } else {
2392 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2393 // integer multiples of the image transfer granularity.
2394 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002395 skip |= LogError(cb_node->commandBuffer, vuid,
2396 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2397 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2398 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2399 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002400 }
2401 }
2402 return skip;
2403}
2404
2405// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002406bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002407 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002408 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002409 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002410 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002411 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2412 // subresource extent.
2413 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002414 skip |= LogError(cb_node->commandBuffer, vuid,
2415 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2416 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2417 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2418 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002419 }
2420 } else {
2421 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2422 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2423 // subresource extent dimensions.
2424 VkExtent3D offset_extent_sum = {};
2425 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2426 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2427 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002428 bool x_ok = true;
2429 bool y_ok = true;
2430 bool z_ok = true;
2431 switch (image_type) {
2432 case VK_IMAGE_TYPE_3D:
2433 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2434 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002435 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002436 case VK_IMAGE_TYPE_2D:
2437 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2438 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002439 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002440 case VK_IMAGE_TYPE_1D:
2441 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2442 (subresource_extent->width == offset_extent_sum.width));
2443 break;
2444 default:
2445 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2446 assert(false);
2447 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002448 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002449 skip |=
2450 LogError(cb_node->commandBuffer, vuid,
2451 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2452 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2453 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2454 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2455 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2456 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002457 }
2458 }
2459 return skip;
2460}
2461
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002462bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002463 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002464 bool skip = false;
2465 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002466 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2467 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002468 }
2469 return skip;
2470}
2471
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002472bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002473 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002474 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002475 bool skip = false;
2476 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2477 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002478 skip |= LogError(cb_node->commandBuffer, vuid,
2479 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2480 "%u, but provided %s has %u array layers.",
2481 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2482 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002483 }
2484 return skip;
2485}
2486
Jeff Leger178b1e52020-10-05 12:22:23 -04002487// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2488template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002489bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002490 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002491 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002492 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002493 VkExtent3D granularity = GetScaledItg(cb_node, img);
2494 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002495 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002496 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002497 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002498 return skip;
2499}
2500
Jeff Leger178b1e52020-10-05 12:22:23 -04002501// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2502template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002503bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002504 const IMAGE_STATE *dst_img, const RegionType *region,
2505 const uint32_t i, const char *function,
2506 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002507 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002508 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2509 const char *vuid;
2510
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002511 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002512 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002513 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2514 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002515 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002516 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002517 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002518 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002519 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002520
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002521 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002522 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002523 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2524 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002525 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002526 const VkExtent3D dest_effective_extent =
2527 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002528 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002529 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002530 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002531 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002532 return skip;
2533}
2534
Jeff Leger178b1e52020-10-05 12:22:23 -04002535// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2536template <typename ImageCopyRegionType>
2537bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2538 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2539 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002540 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002541 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2542 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2543 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002544
2545 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002546 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002547
2548 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002549 const VkExtent3D src_copy_extent = region.extent;
2550 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002551 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2552
Dave Houlton6f9059e2017-05-02 17:15:13 -06002553 bool slice_override = false;
2554 uint32_t depth_slices = 0;
2555
2556 // Special case for copying between a 1D/2D array and a 3D image
2557 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2558 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002559 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002560 slice_override = (depth_slices != 1);
2561 } 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 -07002562 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002563 slice_override = (depth_slices != 1);
2564 }
2565
2566 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002567 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002568 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002569 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2570 skip |= LogError(src_state->image, vuid,
2571 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2572 "be 0 and 1, respectively.",
2573 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002574 }
2575 }
2576
Dave Houlton533be9f2018-03-26 17:08:30 -06002577 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 -04002578 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2579 skip |= LogError(src_state->image, vuid,
2580 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002581 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002582 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002583 }
2584
Dave Houlton533be9f2018-03-26 17:08:30 -06002585 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002586 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2587 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2588 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002589 }
2590
Dave Houltonc991cc92018-03-06 11:08:51 -07002591 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002592 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002593 if (FormatIsCompressed(src_state->createInfo.format) ||
2594 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002595 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002596 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002597 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2598 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2599 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002600 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002601 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002602 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002603 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002604 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002605 }
2606
Dave Houlton94a00372017-12-14 15:08:47 -07002607 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002608 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2609 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002610 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2611 skip |= LogError(src_state->image, vuid,
2612 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2613 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2614 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002615 }
2616
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002617 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002618 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2619 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002620 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2621 skip |= LogError(src_state->image, vuid,
2622 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2623 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2624 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002625 }
2626
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002627 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002628 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2629 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002630 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2631 skip |= LogError(src_state->image, vuid,
2632 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2633 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2634 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002635 }
2636 } // Compressed
2637
2638 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002639 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002640 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002641 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2642 skip |= LogError(dst_state->image, vuid,
2643 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002644 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002645 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002646 }
2647 }
2648
Dave Houlton533be9f2018-03-26 17:08:30 -06002649 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 -04002650 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2651 skip |= LogError(dst_state->image, vuid,
2652 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2653 "and 1, respectively.",
2654 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002655 }
2656
Dave Houlton533be9f2018-03-26 17:08:30 -06002657 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002658 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2659 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2660 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002661 }
2662
sfricke-samsung30b094c2020-05-30 11:42:11 -07002663 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002664 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002665 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2666 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002667 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2668 skip |= LogError(src_state->image, vuid,
2669 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2670 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2671 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002672 }
2673 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002674 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002675 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002676 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2677 skip |= LogError(dst_state->image, vuid,
2678 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2679 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2680 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002681 }
2682 }
2683 } else { // Pre maint 1
2684 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002685 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002686 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2687 skip |= LogError(src_state->image, vuid,
2688 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002689 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2690 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002691 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002692 }
Dave Houltonee281a52017-12-08 13:51:02 -07002693 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002694 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2695 skip |= LogError(dst_state->image, vuid,
2696 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002697 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2698 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002699 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002700 }
2701 }
2702 }
2703
Dave Houltonc991cc92018-03-06 11:08:51 -07002704 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2705 if (FormatIsCompressed(dst_state->createInfo.format) ||
2706 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002707 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002708
2709 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002710 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2711 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2712 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002713 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002714 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002715 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002716 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002717 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002718 }
2719
Dave Houlton94a00372017-12-14 15:08:47 -07002720 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002721 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2722 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002723 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2724 skip |= LogError(dst_state->image, vuid,
2725 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2726 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2727 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002728 }
2729
Dave Houltonee281a52017-12-08 13:51:02 -07002730 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2731 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2732 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002733 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002734 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002735 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002736 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2737 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002738 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002739 }
2740
Dave Houltonee281a52017-12-08 13:51:02 -07002741 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2742 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2743 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002744 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2745 skip |= LogError(dst_state->image, vuid,
2746 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2747 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2748 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002749 }
2750 } // Compressed
2751 }
2752 return skip;
2753}
2754
Jeff Leger178b1e52020-10-05 12:22:23 -04002755// vkCmdCopyImage / vmCmdCopyImage2KHR checks that only apply if the multiplane extension is enabled
2756template <typename RegionType>
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002757bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04002758 const IMAGE_STATE *dst_image_state, const RegionType region,
2759 CopyCommandVersion version) const {
2760 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Dave Houltonc991cc92018-03-06 11:08:51 -07002761 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002762
Jeff Leger178b1e52020-10-05 12:22:23 -04002763 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2764 const char *vuid;
2765
Dave Houltonc991cc92018-03-06 11:08:51 -07002766 // Neither image is multiplane
2767 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2768 // If neither image is multi-plane the aspectMask member of src and dst must match
2769 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2770 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002771 ss << func_name << ": Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002772 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Jeff Leger178b1e52020-10-05 12:22:23 -04002773 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2774 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002775 }
2776 } else {
2777 // Source image multiplane checks
2778 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2779 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2780 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2781 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002782 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2783 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2784 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002785 }
2786 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2787 (aspect != VK_IMAGE_ASPECT_PLANE_2_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 3-plane format";
2790 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2791 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002792 }
2793 // Single-plane to multi-plane
2794 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2795 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2796 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002797 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2798 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2799 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002800 }
2801
2802 // Dest image multiplane checks
2803 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2804 aspect = region.dstSubresource.aspectMask;
2805 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2806 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002807 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2808 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2809 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002810 }
2811 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2812 (aspect != VK_IMAGE_ASPECT_PLANE_2_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 3-plane format";
2815 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2816 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002817 }
2818 // Multi-plane to single-plane
2819 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2820 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2821 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002822 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2823 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2824 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002825 }
2826 }
2827
2828 return skip;
2829}
2830
Jeff Leger178b1e52020-10-05 12:22:23 -04002831template <typename RegionType>
2832bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2833 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2834 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002835 const auto *cb_node = GetCBState(commandBuffer);
2836 const auto *src_image_state = GetImageState(srcImage);
2837 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002838 const VkFormat src_format = src_image_state->createInfo.format;
2839 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002840 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002841 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002842
Jeff Leger178b1e52020-10-05 12:22:23 -04002843 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2844 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2845 const char *vuid;
2846
2847 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002848
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002849 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2850
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002851 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002852 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002853
2854 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2855 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002856 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002857
Dave Houlton6f9059e2017-05-02 17:15:13 -06002858 bool slice_override = false;
2859 uint32_t depth_slices = 0;
2860
2861 // Special case for copying between a 1D/2D array and a 3D image
2862 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2863 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2864 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002865 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002866 slice_override = (depth_slices != 1);
2867 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2868 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002869 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002870 slice_override = (depth_slices != 1);
2871 }
2872
Jeff Leger178b1e52020-10-05 12:22:23 -04002873 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2874 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2875 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2876 skip |=
2877 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2878 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2879 skip |=
2880 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2881 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002882 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002883 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2884 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002885 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002886 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002887
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002888 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002889 // No chance of mismatch if we're overriding depth slice count
2890 if (!slice_override) {
2891 // The number of depth slices in srcSubresource and dstSubresource must match
2892 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2893 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002894 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2895 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002896 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002897 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2898 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002899 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002900 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2901 skip |= LogError(command_buffer, vuid,
2902 "%s: number of depth slices in source and destination subresources for "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002903 "pRegions[%u] do not match.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002904 func_name, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002905 }
2906 }
2907 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002908 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002909 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002910 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
2911 skip |= LogError(command_buffer, vuid,
2912 "%s: number of layers in source and destination subresources for pRegions[%u] do not match",
2913 func_name, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002914 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002915 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002916
Dave Houltonc991cc92018-03-06 11:08:51 -07002917 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002918 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002919 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region, version);
Dave Houltonc991cc92018-03-06 11:08:51 -07002920 }
2921
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002922 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002923 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2924 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002925 std::stringstream ss;
2926 ss << func_name << ": Src and dest aspectMasks for each region must match";
2927 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
2928 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonf5217612018-02-02 16:18:52 -07002929 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002930 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002931
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002932 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002933 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002934 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002935 ss << func_name << ": pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002936 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Jeff Leger178b1e52020-10-05 12:22:23 -04002937 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
2938 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002939 }
2940
2941 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002942 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002943 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002944 ss << func_name << ": pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2945 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
2946 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002947 }
2948
Dave Houltonfc1a4052017-04-27 14:32:45 -06002949 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002950 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2951 if (slice_override) src_copy_extent.depth = depth_slices;
2952 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002953 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002954 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
2955 skip |= LogError(command_buffer, vuid,
2956 "%s: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2957 "width [%1d].",
2958 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002959 }
2960
2961 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002962 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
2963 skip |= LogError(command_buffer, vuid,
2964 "%s: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2965 "height [%1d].",
2966 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002967 }
2968 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002969 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
2970 skip |= LogError(command_buffer, vuid,
2971 "%s: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2972 "depth [%1d].",
2973 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002974 }
2975
Dave Houltonee281a52017-12-08 13:51:02 -07002976 // Adjust dest extent if necessary
2977 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2978 if (slice_override) dst_copy_extent.depth = depth_slices;
2979
2980 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002981 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002982 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
2983 skip |= LogError(command_buffer, vuid,
2984 "%s: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002985 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002986 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002987 }
2988 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002989 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
2990 skip |= LogError(command_buffer, vuid,
2991 "%s): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002992 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002993 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002994 }
2995 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002996 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
2997 skip |= LogError(command_buffer, vuid,
2998 "%s: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002999 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003000 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003001 }
3002
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003003 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3004 // must not overlap in memory
3005 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003006 for (uint32_t j = 0; j < regionCount; j++) {
3007 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003008 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003009 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003010 ss << func_name << ": pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
3011 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
3012 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003013 }
3014 }
3015 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003016
3017 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3018 if (device_extensions.vk_khr_maintenance1) {
3019 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3020 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3021 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003022 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3023 skip |= LogError(command_buffer, vuid,
3024 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3025 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003026 }
3027 } else {
3028 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3029 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3030 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003031 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3032 skip |= LogError(command_buffer, vuid,
3033 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3034 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003035 }
3036 }
3037
3038 // Check if 2D with 3D and depth not equal to 2D layerCount
3039 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3040 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3041 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003042 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3043 skip |= LogError(command_buffer, vuid,
3044 "%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 -08003045 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003046 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003047 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3048 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3049 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003050 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3051 skip |= LogError(command_buffer, vuid,
3052 "%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 -08003053 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003054 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003055 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003056
3057 // Check for multi-plane format compatiblity
3058 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3059 size_t src_format_size = 0;
3060 size_t dst_format_size = 0;
3061 if (FormatIsMultiplane(src_format)) {
3062 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3063 src_format_size = FormatElementSize(planeFormat);
3064 } else {
3065 src_format_size = FormatElementSize(src_format);
3066 }
3067 if (FormatIsMultiplane(dst_format)) {
3068 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3069 dst_format_size = FormatElementSize(planeFormat);
3070 } else {
3071 dst_format_size = FormatElementSize(dst_format);
3072 }
3073 // If size is still zero, then format is invalid and will be caught in another VU
3074 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003075 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3076 skip |= LogError(command_buffer, vuid,
3077 "%s: pRegions[%u] called with non-compatible image formats. "
3078 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3079 func_name, i, string_VkFormat(src_format),
3080 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3081 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003082 }
3083 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003084 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003085
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003086 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3087 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3088 // because because both texels are 4 bytes in size.
3089 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003090 const char *compatible_vuid =
3091 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3092 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3093 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003094 // Depth/stencil formats must match exactly.
3095 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3096 if (src_format != dst_format) {
3097 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003098 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003099 string_VkFormat(src_format), string_VkFormat(dst_format));
3100 }
3101 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003102 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003103 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003104 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003105 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003106 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003107 FormatElementSize(dst_format));
3108 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003109 }
3110 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003111
Dave Houlton33c22b72017-02-28 13:16:02 -07003112 // Source and dest image sample counts must match
3113 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003114 std::stringstream ss;
3115 ss << func_name << " called on image pair with non-identical sample counts.";
3116 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
3117 skip |= LogError(command_buffer, vuid, "%s", ss.str().c_str());
Dave Houlton33c22b72017-02-28 13:16:02 -07003118 }
3119
Jeff Leger178b1e52020-10-05 12:22:23 -04003120 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127";
3121 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3122 vuid = is_2khr ? "" : "";
3123 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003124 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003125 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3126 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3127 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3128 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3129 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3130 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3131 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3132 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3133 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3134 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3135 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3136 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003137
3138 // Validation for VK_EXT_fragment_density_map
3139 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003140 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3141 skip |=
3142 LogError(command_buffer, vuid,
3143 "%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 +02003144 }
3145 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003146 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3147 skip |=
3148 LogError(command_buffer, vuid,
3149 "%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 +02003150 }
3151
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003152 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003153 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3154 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3155 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3156 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003157 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003158 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3159 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3160 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3161 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3162 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003163 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003164
3165 const char *invalid_src_layout_vuid =
3166 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3167 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3168 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3169 const char *invalid_dst_layout_vuid =
3170 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3171 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3172 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3173
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003174 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003175 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003176 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003177 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3178 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003179 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003180 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003181 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003182 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003183 }
3184
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003185 return skip;
3186}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003187
Jeff Leger178b1e52020-10-05 12:22:23 -04003188bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3189 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3190 const VkImageCopy *pRegions) const {
3191 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3192 COPY_COMMAND_VERSION_1);
3193}
3194
3195bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3196 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3197 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3198 COPY_COMMAND_VERSION_2);
3199}
3200
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003201void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3202 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3203 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003204 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3205 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003206 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003207 auto src_image_state = GetImageState(srcImage);
3208 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003209
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003210 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003211 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003212 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3213 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003214 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003215}
3216
Jeff Leger178b1e52020-10-05 12:22:23 -04003217void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3218 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3219 auto cb_node = GetCBState(commandBuffer);
3220 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3221 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3222
3223 // Make sure that all image slices are updated to correct layout
3224 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3225 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3226 pCopyImageInfo->srcImageLayout);
3227 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3228 pCopyImageInfo->dstImageLayout);
3229 }
3230}
3231
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003232// Returns true if sub_rect is entirely contained within rect
3233static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3234 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3235 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3236 return false;
3237 return true;
3238}
3239
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003240bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003241 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003242 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3243 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003244 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003245 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3246 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003247 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003248 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003249
3250 for (uint32_t j = 0; j < rect_count; j++) {
3251 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003252 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3253 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3254 "the current render pass instance.",
3255 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003256 }
3257
3258 if (image_view_state) {
3259 // The layers specified by a given element of pRects must be contained within every attachment that
3260 // pAttachments refers to
3261 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3262 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3263 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003264 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3265 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3266 "of pAttachment[%d].",
3267 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003268 }
3269 }
3270 }
3271 return skip;
3272}
3273
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003274bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3275 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003276 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003277 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003278 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003279 if (!cb_node) return skip;
3280
3281 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3282 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3283 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003284 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003285
3286 // Validate that attachment is in reference list of active subpass
3287 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003288 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003289 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003290 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003291 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003292 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003293
John Zulauf3a548ef2019-02-01 16:14:07 -07003294 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3295 auto clear_desc = &pAttachments[attachment_index];
3296 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003297 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003298
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003299 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3300 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3301 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3302 attachment_index);
3303 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3304 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3305 skip |=
3306 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3307 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3308 attachment_index);
3309 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003310 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3311 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3312 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3313 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003314 skip |= LogError(
3315 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3316 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3317 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3318 attachment_index, clear_desc->colorAttachment,
3319 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3320 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003321
John Zulauff2582972019-02-09 14:53:30 -07003322 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3323 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003324 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003325 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3326 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3327 " subpass %u. colorAttachmentCount=%u",
3328 attachment_index, clear_desc->colorAttachment,
3329 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3330 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003331 }
John Zulauff2582972019-02-09 14:53:30 -07003332 fb_attachment = color_attachment;
3333
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003334 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3335 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3336 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3337 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3338 "of a color attachment.",
3339 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003340 }
3341 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003342 bool subpass_depth = false;
3343 bool subpass_stencil = false;
3344 if (subpass_desc->pDepthStencilAttachment &&
3345 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3346 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3347 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3348 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3349 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003350 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003351 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3352 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003353 skip |= LogError(
3354 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3355 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003356 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003357 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003358 }
3359 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003360 skip |= LogError(
3361 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3362 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003363 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003364 attachment_index);
3365 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003366 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003367 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003368 }
3369 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003370 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003371 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3372 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003373 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003374
3375 // Once the framebuffer attachment is found, can get the image view state
3376 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3377 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3378 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003379 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003380 if (image_view_state != nullptr) {
3381 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3382 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3383 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3384 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3385 }
3386 }
John Zulauf441558b2019-08-12 11:47:39 -06003387 }
3388 }
3389 return skip;
3390}
3391
3392void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3393 const VkClearAttachment *pAttachments, uint32_t rectCount,
3394 const VkClearRect *pRects) {
3395 auto *cb_node = GetCBState(commandBuffer);
3396 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3397 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3398 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3399 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3400 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3401 const auto clear_desc = &pAttachments[attachment_index];
3402 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3403 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3404 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3405 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3406 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3407 subpass_desc->pDepthStencilAttachment) {
3408 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3409 }
3410 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003411 if (!clear_rect_copy) {
3412 // We need a copy of the clear rectangles that will persist until the last lambda executes
3413 // but we want to create it as lazily as possible
3414 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003415 }
John Zulauf441558b2019-08-12 11:47:39 -06003416 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3417 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003418 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003419 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003420 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003421 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3422 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003423 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003424 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003425 return skip;
3426 };
3427 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003428 }
3429 }
3430 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003431}
3432
Jeff Leger178b1e52020-10-05 12:22:23 -04003433template <typename RegionType>
3434bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3435 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3436 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003437 const auto *cb_node = GetCBState(commandBuffer);
3438 const auto *src_image_state = GetImageState(srcImage);
3439 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003440 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3441 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3442 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3443 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003444
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003445 bool skip = false;
3446 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003447 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3448 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3449 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3450 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3451 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3452 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3453 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3454 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3455 skip |= InsideRenderPass(cb_node, func_name, vuid);
3456 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3457 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3458 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3459 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3460 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3461 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3462 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3463 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003464
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003465 // Validation for VK_EXT_fragment_density_map
3466 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003467 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3468 skip |= LogError(cb_node->commandBuffer, vuid,
3469 "%s: srcImage must not have been created with flags containing "
3470 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3471 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003472 }
3473 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003474 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3475 skip |= LogError(cb_node->commandBuffer, vuid,
3476 "%s: dstImage must not have been created with flags containing "
3477 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3478 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003479 }
3480
Cort Stratton7df30962018-05-17 19:45:57 -07003481 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003482 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003483 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3484 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003485 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003486 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3487 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3488 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003489 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003490 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3491 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3492 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3493 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3494 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3495 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003496 // For each region, the number of layers in the image subresource should not be zero
3497 // For each region, src and dest image aspect must be color only
3498 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003499 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003500 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3501 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003502 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3503 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3504 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003505 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003506 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3507 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003508 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003509 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3510 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3511 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3512 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3513 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3514 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003515 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003516 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3517 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003518 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003519 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003520
3521 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003522 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003523 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3524 skip |=
3525 LogError(cb_node->commandBuffer, vuid,
3526 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003527 }
Cort Stratton7df30962018-05-17 19:45:57 -07003528 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003529 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3530 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003531 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3532 skip |= LogError(cb_node->commandBuffer, vuid,
3533 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3534 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003535 }
3536
3537 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3538 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3539
3540 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003541 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003542 LogObjectList objlist(cb_node->commandBuffer);
3543 objlist.add(src_image_state->image);
3544 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003545 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3546 skip |= LogError(objlist, vuid,
3547 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003548 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003549 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003550 }
3551 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3552 LogObjectList objlist(cb_node->commandBuffer);
3553 objlist.add(src_image_state->image);
3554 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003555 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3556 skip |= LogError(objlist, vuid,
3557 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003558 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003559 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003560 }
3561 }
3562
3563 if (VK_IMAGE_TYPE_1D == src_image_type) {
3564 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3565 LogObjectList objlist(cb_node->commandBuffer);
3566 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003567 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3568 skip |= LogError(objlist, vuid,
3569 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003570 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003571 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3572 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003573 }
3574 }
3575 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3576 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3577 LogObjectList objlist(cb_node->commandBuffer);
3578 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003579 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3580 skip |= LogError(objlist, vuid,
3581 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003582 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003583 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3584 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003585 }
3586 }
3587
3588 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3589 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3590 LogObjectList objlist(cb_node->commandBuffer);
3591 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003592 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3593 skip |= LogError(objlist, vuid,
3594 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003595 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003596 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3597 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003598 }
3599 }
3600 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3601 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3602 LogObjectList objlist(cb_node->commandBuffer);
3603 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003604 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3605 skip |= LogError(objlist, vuid,
3606 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003607 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003608 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3609 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003610 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003611 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003612
3613 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3614 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3615 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3616 // developer
3617 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3618 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3619 if ((extent_check & x_bit) != 0) {
3620 LogObjectList objlist(cb_node->commandBuffer);
3621 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003622 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3623 skip |= LogError(objlist, vuid,
3624 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003625 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003626 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003627 region.extent.width, subresource_extent.width);
3628 }
3629
3630 if ((extent_check & y_bit) != 0) {
3631 LogObjectList objlist(cb_node->commandBuffer);
3632 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003633 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3634 skip |= LogError(objlist, vuid,
3635 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003636 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003637 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003638 region.extent.height, subresource_extent.height);
3639 }
3640
3641 if ((extent_check & z_bit) != 0) {
3642 LogObjectList objlist(cb_node->commandBuffer);
3643 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003644 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3645 skip |= LogError(objlist, vuid,
3646 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003647 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003648 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003649 region.extent.depth, subresource_extent.depth);
3650 }
3651 }
3652
3653 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3654 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3655 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3656 // developer
3657 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3658 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3659 if ((extent_check & x_bit) != 0) {
3660 LogObjectList objlist(cb_node->commandBuffer);
3661 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003662 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3663 skip |= LogError(objlist, vuid,
3664 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003665 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003666 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003667 region.extent.width, subresource_extent.width);
3668 }
3669
3670 if ((extent_check & y_bit) != 0) {
3671 LogObjectList objlist(cb_node->commandBuffer);
3672 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003673 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3674 skip |= LogError(objlist, vuid,
3675 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003676 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003677 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003678 region.extent.height, subresource_extent.height);
3679 }
3680
3681 if ((extent_check & z_bit) != 0) {
3682 LogObjectList objlist(cb_node->commandBuffer);
3683 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003684 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3685 skip |= LogError(objlist, vuid,
3686 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003687 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003688 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003689 region.extent.depth, subresource_extent.depth);
3690 }
3691 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003692 }
3693
3694 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003695 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3696 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3697 func_name, string_VkFormat(src_image_state->createInfo.format),
3698 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003699 }
3700 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003701 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003702 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003703 string_VkImageType(src_image_state->createInfo.imageType),
3704 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003705 }
3706 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003707 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3708 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 -07003709 }
3710 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003711 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3712 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3713 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003714 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003715 } else {
3716 assert(0);
3717 }
3718 return skip;
3719}
3720
Jeff Leger178b1e52020-10-05 12:22:23 -04003721bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3722 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3723 const VkImageResolve *pRegions) const {
3724 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3725 COPY_COMMAND_VERSION_1);
3726}
3727
3728bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3729 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3730 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3731 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3732 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3733}
3734
3735template <typename RegionType>
3736bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3737 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3738 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003739 const auto *cb_node = GetCBState(commandBuffer);
3740 const auto *src_image_state = GetImageState(srcImage);
3741 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003742
Jeff Leger178b1e52020-10-05 12:22:23 -04003743 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3744 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3745 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3746
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003747 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003748 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003749 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003750 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003751 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003752 const char *vuid;
3753 const char *location;
3754 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3755 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3756 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3757 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3758 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3759 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3760 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3761 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3762 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3763 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3764 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3765 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3766 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3767 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3768 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3769 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3770 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3771 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3772 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3773 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3774 skip |= InsideRenderPass(cb_node, func_name, vuid);
3775 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3776 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3777 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3778 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3779 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3780 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3781 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3782 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3783 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3784 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003785
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003786 // Validation for VK_EXT_fragment_density_map
3787 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003788 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3789 skip |= LogError(cb_node->commandBuffer, vuid,
3790 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3791 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003792 }
3793 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003794 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3795 skip |= LogError(cb_node->commandBuffer, vuid,
3796 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3797 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003798 }
3799
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003800 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003801
Dave Houlton33c2d252017-06-09 17:08:32 -06003802 VkFormat src_format = src_image_state->createInfo.format;
3803 VkFormat dst_format = dst_image_state->createInfo.format;
3804 VkImageType src_type = src_image_state->createInfo.imageType;
3805 VkImageType dst_type = dst_image_state->createInfo.imageType;
3806
Cort Stratton186b1a22018-05-01 20:18:06 -04003807 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003808 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3809 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3810 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003811 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003812 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003813 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003814 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003815 }
3816
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003817 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003818 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3819 skip |= LogError(device, vuid,
3820 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003821 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003822 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003823 }
3824
3825 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003826 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3827 skip |= LogError(device, vuid,
3828 "%s: dstImage 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(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003831 }
3832
Dave Houlton33c2d252017-06-09 17:08:32 -06003833 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003834 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3835 skip |= LogError(cb_node->commandBuffer, vuid,
3836 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003837 }
3838
Dave Houlton33c2d252017-06-09 17:08:32 -06003839 // Validate consistency for unsigned formats
3840 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3841 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003842 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003843 << "the other one must also have unsigned integer format. "
3844 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003845 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3846 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003847 }
3848
3849 // Validate consistency for signed formats
3850 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3851 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003852 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003853 << "the other one must also have signed integer format. "
3854 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003855 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3856 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003857 }
3858
3859 // Validate filter for Depth/Stencil formats
3860 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3861 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003862 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003863 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003864 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3865 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003866 }
3867
3868 // Validate aspect bits and formats for depth/stencil images
3869 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3870 if (src_format != dst_format) {
3871 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003872 ss << func_name << ": If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003873 << "stencil, the other one must have exactly the same format. "
3874 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3875 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003876 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3877 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003878 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003879 } // Depth or Stencil
3880
3881 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003882 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003883 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3884 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3885 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3886 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3887 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3888 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003889 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003890 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3891 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3892 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3893 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3894 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3895 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003896 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003897 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003898 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003899 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003900 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003901 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3902 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003903 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003904 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3905 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3906 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3907 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3908 skip |=
3909 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3910 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3911 skip |=
3912 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3913 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003914 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003915 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3916 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003917 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003918 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003919 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003920 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3921 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003922 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003923 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003924 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003925 }
Dave Houlton48989f32017-05-26 15:01:46 -06003926 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3927 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003928 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003929 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003930 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003931 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003932
3933 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003934 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003935 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
3936 skip |=
3937 LogError(cb_node->commandBuffer, vuid,
3938 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003939 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003940
Dave Houlton48989f32017-05-26 15:01:46 -06003941 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003942 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
3943 skip |=
3944 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003945 }
Dave Houlton48989f32017-05-26 15:01:46 -06003946
Dave Houlton33c2d252017-06-09 17:08:32 -06003947 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003948 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
3949 skip |= LogError(cb_node->commandBuffer, vuid,
3950 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003951 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003952 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003953 }
3954
3955 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003956 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
3957 skip |= LogError(cb_node->commandBuffer, vuid,
3958 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3959 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003960 }
3961
Dave Houlton48989f32017-05-26 15:01:46 -06003962 // Validate source image offsets
3963 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003964 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003965 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003966 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
3967 skip |= LogError(cb_node->commandBuffer, vuid,
3968 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3969 "of (%1d, %1d). These must be (0, 1).",
3970 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003971 }
3972 }
3973
Dave Houlton33c2d252017-06-09 17:08:32 -06003974 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003975 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003976 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
3977 skip |= LogError(cb_node->commandBuffer, vuid,
3978 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3979 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3980 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003981 }
3982 }
3983
Dave Houlton33c2d252017-06-09 17:08:32 -06003984 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003985 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3986 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003987 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003988 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
3989 skip |= LogError(cb_node->commandBuffer, vuid,
3990 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3991 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003992 }
3993 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3994 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003995 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003996 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
3997 skip |= LogError(cb_node->commandBuffer, vuid,
3998 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
3999 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004000 }
4001 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4002 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004003 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004004 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
4005 skip |= LogError(cb_node->commandBuffer, vuid,
4006 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4007 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004008 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004009 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004010 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4011 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4012 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004013 }
Dave Houlton48989f32017-05-26 15:01:46 -06004014
4015 // Validate dest image offsets
4016 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004017 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004018 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004019 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4020 skip |= LogError(cb_node->commandBuffer, vuid,
4021 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4022 "(%1d, %1d). These must be (0, 1).",
4023 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004024 }
4025 }
4026
Dave Houlton33c2d252017-06-09 17:08:32 -06004027 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004028 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004029 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4030 skip |= LogError(cb_node->commandBuffer, vuid,
4031 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004032 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004033 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004034 }
4035 }
4036
Dave Houlton33c2d252017-06-09 17:08:32 -06004037 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004038 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4039 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004040 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004041 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4042 skip |= LogError(cb_node->commandBuffer, vuid,
4043 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4044 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004045 }
4046 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4047 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004048 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004049 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4050 skip |= LogError(cb_node->commandBuffer, vuid,
4051 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4052 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004053 }
4054 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4055 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004056 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004057 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4058 skip |= LogError(cb_node->commandBuffer, vuid,
4059 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4060 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004061 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004062 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004063 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4064 skip |= LogError(cb_node->commandBuffer, vuid,
4065 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004066 }
4067
Dave Houlton33c2d252017-06-09 17:08:32 -06004068 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4069 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4070 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004071 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4072 skip |= LogError(cb_node->commandBuffer, vuid,
4073 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4074 "layerCount other than 1.",
4075 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004076 }
4077 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004078 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004079 } else {
4080 assert(0);
4081 }
4082 return skip;
4083}
4084
Jeff Leger178b1e52020-10-05 12:22:23 -04004085bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4086 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4087 const VkImageBlit *pRegions, VkFilter filter) const {
4088 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4089 COPY_COMMAND_VERSION_1);
4090}
4091
4092bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4093 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4094 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4095 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4096}
4097
4098template <typename RegionType>
4099void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4100 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4101 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004102 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004103 auto src_image_state = GetImageState(srcImage);
4104 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004105
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004106 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004107 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004108 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4109 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004110 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004111}
4112
Jeff Leger178b1e52020-10-05 12:22:23 -04004113void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4114 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4115 const VkImageBlit *pRegions, VkFilter filter) {
4116 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4117 pRegions, filter);
4118 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4119}
4120
4121void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4122 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4123 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4124 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4125 pBlitImageInfo->filter);
4126}
4127
John Zulauf2076e812020-01-08 14:55:54 -07004128GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4129 assert(map);
4130 // This approach allows for a single hash lookup or/create new
4131 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4132 if (inserted.second) {
4133 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004134 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004135 inserted.first->second.reset(layout_map);
4136 return layout_map;
4137 } else {
4138 assert(nullptr != inserted.first->second.get());
4139 return inserted.first->second.get();
4140 }
4141 return nullptr;
4142}
4143
4144const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4145 auto it = map.find(image);
4146 if (it != map.end()) {
4147 return it->second.get();
4148 }
4149 return nullptr;
4150}
4151
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004152// 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 -07004153bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4154 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004155 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004156 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07004157 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004158 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004159 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004160 for (const auto &layout_map_entry : pCB->image_layout_map) {
4161 const auto image = layout_map_entry.first;
4162 const auto *image_state = GetImageState(image);
4163 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004164 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004165 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004166 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004167 if (initial_layout_map.empty()) continue;
4168
4169 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
4170 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4171 if (global_map == nullptr) {
4172 global_map = &empty_map;
4173 }
4174
4175 // Note: don't know if it would matter
4176 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4177
4178 auto pos = initial_layout_map.begin();
4179 const auto end = initial_layout_map.end();
4180 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4181 pos->first.begin);
4182 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004183 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004184 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004185 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 -07004186 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004187 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004188 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004189 image_layout = current_layout->pos_B->lower_bound->second;
4190 }
4191 const auto intersected_range = pos->first & current_layout->range;
4192 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4193 // TODO: Set memory invalid which is in mem_tracker currently
4194 } else if (image_layout != initial_layout) {
4195 // Need to look up the inital layout *state* to get a bit more information
4196 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4197 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4198 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4199 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004200 // We can report all the errors for the intersected range directly
4201 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004202 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004203 skip |= LogError(
4204 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004205 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004206 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004207 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004208 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004209 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004210 }
4211 }
John Zulauf2076e812020-01-08 14:55:54 -07004212 if (pos->first.includes(intersected_range.end)) {
4213 current_layout.seek(intersected_range.end);
4214 } else {
4215 ++pos;
4216 if (pos != end) {
4217 current_layout.seek(pos->first.begin);
4218 }
4219 }
John Zulauff660ad62019-03-23 07:16:05 -06004220 }
4221
locke-lunargf155ccf2020-02-18 11:34:15 -07004222 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004223 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004224 }
John Zulauff660ad62019-03-23 07:16:05 -06004225
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004226 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004227}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004228
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004229void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004230 for (const auto &layout_map_entry : pCB->image_layout_map) {
4231 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004232 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004233 const auto *image_state = GetImageState(image);
4234 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004235 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4236 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004237 }
4238}
4239
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004240// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004241// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4242// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004243bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4244 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06004245 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004246 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004247 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4248
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004249 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004250 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4251 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004252 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004253 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4254 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4255 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004256 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004257 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004258 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004259 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4260 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4261 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004262 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004263 string_VkImageLayout(first_layout));
4264 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4265 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004266 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004267 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004268 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004269 }
4270 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004271
4272 // Same as above for loadOp, but for stencilLoadOp
4273 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4274 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4275 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4276 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4277 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004278 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004279 string_VkImageLayout(first_layout));
4280 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4281 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4282 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004283 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004284 string_VkImageLayout(first_layout));
4285 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4286 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4287 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004288 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004289 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004290 }
4291 }
4292
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004293 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004294}
4295
Mark Lobodzinski96210742017-02-09 10:33:46 -07004296// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4297// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004298template <typename T1>
4299bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4300 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4301 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004302 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004303 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004304 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004305 if (strict) {
4306 correct_usage = ((actual & desired) == desired);
4307 } else {
4308 correct_usage = ((actual & desired) != 0);
4309 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004310
Mark Lobodzinski96210742017-02-09 10:33:46 -07004311 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004312 // All callers should have a valid VUID
4313 assert(msgCode != kVUIDUndefined);
4314 skip =
4315 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4316 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004317 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004318 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004319}
4320
4321// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4322// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004323bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004324 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004325 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004326 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004327}
4328
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004329bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004330 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004331 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004332 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4333 if ((image_format_features & desired) != desired) {
4334 // Same error, but more details if it was an AHB external format
4335 if (image_state->has_ahb_format == true) {
4336 skip |= LogError(image_state->image, vuid,
4337 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4338 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4339 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004340 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004341 } else {
4342 skip |= LogError(image_state->image, vuid,
4343 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4344 "with tiling %s.",
4345 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4346 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4347 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004348 }
4349 }
4350 return skip;
4351}
4352
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004353bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004354 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004355 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004356 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004357 // layerCount must not be zero
4358 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004359 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4360 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004361 }
4362 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004363 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004364 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4365 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004366 }
4367 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004368 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 -07004369 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4370 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4371 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4372 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004373 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004374 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4375 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4376 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4377 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4378 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4379 member);
4380 }
Cort Strattond619a302018-05-17 19:46:32 -07004381 return skip;
4382}
4383
Mark Lobodzinski96210742017-02-09 10:33:46 -07004384// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4385// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004386bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004387 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004388 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004389 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004390}
4391
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004392bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004393 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004394 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004395
4396 const VkDeviceSize &range = pCreateInfo->range;
4397 if (range != VK_WHOLE_SIZE) {
4398 // Range must be greater than 0
4399 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004400 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004401 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004402 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4403 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004404 }
4405 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004406 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4407 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004408 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
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 a multiple of the element size of the format "
4411 "(%" PRIu32 ").",
4412 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004413 }
4414 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004415 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004416 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
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 divided by the element size of the format (%" PRIu32
4419 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4420 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004421 }
4422 // The sum of range and offset must be less than or equal to the size of buffer
4423 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004424 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
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, the sum of offset (%" PRIuLEAST64
4427 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4428 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004429 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004430 } else {
4431 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4432
4433 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4434 // VkPhysicalDeviceLimits::maxTexelBufferElements
4435 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4436 device_limits->maxTexelBufferElements) {
4437 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4438 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4439 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4440 "), divided by the element size of the format (%" PRIu32
4441 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4442 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4443 device_limits->maxTexelBufferElements);
4444 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004445 }
4446 return skip;
4447}
4448
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004449bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004450 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004451 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004452 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4453 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004454 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004455 "vkCreateBufferView(): If buffer was created with `usage` containing "
4456 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004457 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004458 }
4459 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4460 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004461 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004462 "vkCreateBufferView(): If buffer was created with `usage` containing "
4463 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004464 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004465 }
4466 return skip;
4467}
4468
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004469bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004470 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004471 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004472
Dave Houltond8ed0212018-05-16 17:18:24 -06004473 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004474
Jeff Bolz87697532019-01-11 22:54:00 -06004475 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4476 if (chained_devaddr_struct) {
4477 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4478 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004479 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4480 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4481 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004482 }
4483 }
4484
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004485 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4486 if (chained_opaqueaddr_struct) {
4487 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4488 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004489 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4490 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4491 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004492 }
4493 }
4494
Shannon McPherson4984e642019-12-05 13:04:34 -07004495 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004496 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4497 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004498 skip |= LogError(
4499 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004500 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4501 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4502 }
4503
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004504 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004505 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4506 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4507 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004508 }
4509
sfricke-samsungedce77a2020-07-03 22:35:13 -07004510 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4511 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4512 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4513 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4514 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4515 }
4516 const VkBufferCreateFlags invalid_flags =
4517 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4518 if ((pCreateInfo->flags & invalid_flags) != 0) {
4519 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4520 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4521 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4522 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4523 }
4524 }
4525
Mark Lobodzinski96210742017-02-09 10:33:46 -07004526 return skip;
4527}
4528
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004529bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004530 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004531 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004532 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004533 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4534 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004535 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004536 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4537 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004538 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004539 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4540 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4541 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004542
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004543 // Buffer view offset must be less than the size of buffer
4544 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004545 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004546 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004547 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4548 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004549 }
4550
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004551 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004552 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4553 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4554 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004555 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4556 : "VUID-VkBufferViewCreateInfo-offset-00926";
4557 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004558 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004559 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4560 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004561 }
4562
4563 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4564 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4565 if ((elementSize % 3) == 0) {
4566 elementSize /= 3;
4567 }
4568 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4569 VkDeviceSize alignmentRequirement =
4570 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4571 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4572 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4573 }
4574 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004575 skip |= LogError(
4576 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004577 "vkCreateBufferView(): If buffer was created with usage containing "
4578 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004579 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4580 ") must be a multiple of the lesser of "
4581 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4582 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4583 "(%" PRId32
4584 ") is VK_TRUE, the size of a texel of the requested format. "
4585 "If the size of a texel is a multiple of three bytes, then the size of a "
4586 "single component of format is used instead",
4587 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4588 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4589 }
4590 }
4591 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4592 VkDeviceSize alignmentRequirement =
4593 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4594 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4595 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4596 }
4597 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004598 skip |= LogError(
4599 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004600 "vkCreateBufferView(): If buffer was created with usage containing "
4601 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004602 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4603 ") must be a multiple of the lesser of "
4604 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4605 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4606 "(%" PRId32
4607 ") is VK_TRUE, the size of a texel of the requested format. "
4608 "If the size of a texel is a multiple of three bytes, then the size of a "
4609 "single component of format is used instead",
4610 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4611 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4612 }
4613 }
4614 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004615
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004616 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004617
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004618 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004619 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004620 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004621}
4622
Mark Lobodzinski602de982017-02-09 11:01:33 -07004623// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004624bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004625 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004626 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004627 const IMAGE_STATE *image_state = GetImageState(image);
4628 // checks color format and (single-plane or non-disjoint)
4629 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004630 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004631 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004632 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 -07004633 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004634 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 -07004635 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004636 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004637 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004638 skip |= LogError(image, vuid,
4639 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4640 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4641 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004642 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004643 skip |= LogError(image, vuid,
4644 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4645 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4646 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004647 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004648 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004649 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004650 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 -07004651 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004652 skip |=
4653 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 -07004654 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004655 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004656 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004657 skip |=
4658 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 -07004659 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004660 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4661 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004662 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004663 } else if (FormatIsMultiplane(format)) {
4664 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4665 if (3 == FormatPlaneCount(format)) {
4666 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4667 }
4668 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004669 skip |=
4670 LogError(image, vuid,
4671 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4672 "set, where n = [0, 1, 2].",
4673 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004674 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004675 }
4676 return skip;
4677}
4678
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004679bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4680 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004681 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4682 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004683 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004684
4685 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004686 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004687 skip |= LogError(image, errorCodes.base_mip_err,
4688 "%s: %s.baseMipLevel (= %" PRIu32
4689 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4690 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004691 }
Petr Kraus4d718682017-05-18 03:38:41 +02004692
Petr Krausffa94af2017-08-08 21:46:02 +02004693 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4694 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004695 skip |=
4696 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004697 } else {
4698 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004699
Petr Krausffa94af2017-08-08 21:46:02 +02004700 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004701 skip |= LogError(image, errorCodes.mip_count_err,
4702 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4703 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4704 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4705 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004706 }
Petr Kraus4d718682017-05-18 03:38:41 +02004707 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004708 }
Petr Kraus4d718682017-05-18 03:38:41 +02004709
4710 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004711 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004712 skip |= LogError(image, errorCodes.base_layer_err,
4713 "%s: %s.baseArrayLayer (= %" PRIu32
4714 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4715 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004716 }
Petr Kraus4d718682017-05-18 03:38:41 +02004717
Petr Krausffa94af2017-08-08 21:46:02 +02004718 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4719 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004720 skip |=
4721 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004722 } else {
4723 const uint64_t necessary_layer_count =
4724 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004725
Petr Krausffa94af2017-08-08 21:46:02 +02004726 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004727 skip |= LogError(image, errorCodes.layer_count_err,
4728 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4729 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4730 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4731 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004732 }
Petr Kraus4d718682017-05-18 03:38:41 +02004733 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004734 }
Petr Kraus4d718682017-05-18 03:38:41 +02004735
Mark Lobodzinski602de982017-02-09 11:01:33 -07004736 return skip;
4737}
4738
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004739bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004740 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004741 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004742 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4743 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4744 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4745
David McFarland2853f2f2020-11-30 15:50:39 -04004746 uint32_t image_layer_count;
4747
4748 if (is_3D_to_2D_map) {
4749 const auto layers = LayersFromRange(subresourceRange);
4750 const auto extent = GetImageSubresourceExtent(image_state, &layers);
4751 image_layer_count = extent.depth;
4752 } else {
4753 image_layer_count = image_state->createInfo.arrayLayers;
4754 }
4755
Petr Krausffa94af2017-08-08 21:46:02 +02004756 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4757
4758 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004759 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4760 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004761 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004762 : "VUID-VkImageViewCreateInfo-image-01482")
4763 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4764 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004765 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004766 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4767 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004768
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004769 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004770 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004771 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004772}
4773
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004774bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004775 const VkImageSubresourceRange &subresourceRange,
4776 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004777 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004778 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4779 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4780 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4781 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004782
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004783 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004784 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004785 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004786}
4787
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004788bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004789 const VkImageSubresourceRange &subresourceRange,
4790 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004791 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004792 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4793 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4794 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4795 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004796
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004797 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004798 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4799 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004800}
4801
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004802bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004803 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004804 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004805 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004806 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4807 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4808 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4809 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004810
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004811 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004812 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004813}
4814
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004815bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4816 const VkImageUsageFlags image_usage) const {
4817 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4818 bool skip = false;
4819
4820 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4821 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4822
4823 if (image_state->has_ahb_format == true) {
4824 // AHB image view and image share same feature sets
4825 tiling_features = image_state->format_features;
4826 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4827 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4828 assert(device_extensions.vk_ext_image_drm_format_modifier);
4829 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4830 nullptr};
4831 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4832
4833 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4834 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4835 nullptr};
4836 format_properties_2.pNext = (void *)&drm_properties_list;
4837 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4838
4839 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4840 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4841 0) {
4842 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4843 }
4844 }
4845 } else {
4846 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4847 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4848 : format_properties.optimalTilingFeatures;
4849 }
4850
4851 if (tiling_features == 0) {
4852 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4853 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4854 "physical device.",
4855 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4856 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4857 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4858 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4859 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4860 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4861 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4862 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4863 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4864 "VK_IMAGE_USAGE_STORAGE_BIT.",
4865 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4866 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4867 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4868 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4869 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4870 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4871 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4872 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4873 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4874 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4875 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4876 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4877 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4878 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4879 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4880 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4881 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4882 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00004883 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
4884 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
4885 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
4886 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-04550",
4887 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4888 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
4889 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4890 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004891 }
4892
4893 return skip;
4894}
4895
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004896bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004897 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004898 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004899 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004900 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004901 skip |=
4902 ValidateImageUsageFlags(image_state,
4903 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4904 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004905 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4906 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4907 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004908 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004909 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004910 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004911 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004912 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004913 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004914 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004915 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004916
4917 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4918 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004919 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004920 VkFormat view_format = pCreateInfo->format;
4921 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004922 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004923 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004924
Dave Houltonbd2e2622018-04-10 16:41:14 -06004925 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004926 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004927 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004928 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004929 if (!device_extensions.vk_ext_separate_stencil_usage) {
4930 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004931 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4932 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4933 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004934 }
4935 } else {
4936 const auto image_stencil_struct =
4937 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4938 if (image_stencil_struct == nullptr) {
4939 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |= LogError(
4941 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004942 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4943 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4944 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4945 }
4946 } else {
4947 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4948 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4949 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004950 skip |= LogError(
4951 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004952 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4953 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4954 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4955 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4956 }
4957 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4958 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004959 skip |= LogError(
4960 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
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 bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4964 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4965 }
4966 }
4967 }
4968 }
4969
Dave Houltonbd2e2622018-04-10 16:41:14 -06004970 image_usage = chained_ivuci_struct->usage;
4971 }
4972
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004973 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4974 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004975 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004976 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004977 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004978 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004979 std::stringstream ss;
4980 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004981 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004982 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004983 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004984 }
4985 } else {
Nathaniel Cesario0046c312020-10-07 23:28:28 -06004986 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004987 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4988 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004989 const char *error_vuid;
4990 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4991 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4992 } else if ((device_extensions.vk_khr_maintenance2) &&
4993 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4994 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4995 } else if ((!device_extensions.vk_khr_maintenance2) &&
4996 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4997 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4998 } else {
4999 // both enabled
5000 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5001 }
Dave Houltonc7988072018-04-16 11:46:56 -06005002 std::stringstream ss;
5003 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005004 << " is not in the same format compatibility class as "
5005 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005006 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5007 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005008 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005009 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005010 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005011 }
5012 } else {
5013 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005014 // Unless it is a multi-planar color bit aspect
5015 if ((image_format != view_format) &&
5016 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5017 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5018 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005019 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005020 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005021 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005022 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005023 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005024 }
5025 }
5026
5027 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005028 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005029
5030 switch (image_type) {
5031 case VK_IMAGE_TYPE_1D:
5032 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005033 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5034 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5035 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005036 }
5037 break;
5038 case VK_IMAGE_TYPE_2D:
5039 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5040 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5041 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005042 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
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 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005046 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5047 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5048 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005049 }
5050 }
5051 break;
5052 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005053 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005054 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5055 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5056 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005057 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005058 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5059 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5060 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005061 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5062 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005063 skip |= LogError(
5064 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5065 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5066 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5067 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5068 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005069 }
5070 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005071 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5072 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5073 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005074 }
5075 }
5076 } else {
5077 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005078 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5079 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5080 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005081 }
5082 }
5083 break;
5084 default:
5085 break;
5086 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005087
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005088 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005089 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005090 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005091 }
5092
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005093 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005094
Tobias Hector6663c9b2020-11-05 10:18:02 +00005095 if (enabled_features.shading_rate_image.shadingRateImage) {
5096 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5097 if (view_format != VK_FORMAT_R8_UINT) {
5098 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5099 "vkCreateImageView() If image was created with usage containing "
5100 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5101 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005102 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005103 }
5104
5105 if (enabled_features.shading_rate_image.shadingRateImage ||
5106 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5107 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5108 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5109 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5110 "vkCreateImageView() If image was created with usage containing "
5111 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5112 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5113 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005114 }
5115 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005116
Tobias Hector6663c9b2020-11-05 10:18:02 +00005117 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5118 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5119 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5120 pCreateInfo->subresourceRange.layerCount != 1) {
5121 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5122 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5123 pCreateInfo->subresourceRange.layerCount);
5124 }
5125
Jeff Bolz99e3f632020-03-24 22:59:22 -05005126 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5127 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5128 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5129 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5130 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5131 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5132 }
5133 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5134 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5135 skip |= LogError(
5136 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5137 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5138 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5139 }
5140 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005141
5142 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5143 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005144 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005145 "vkCreateImageView(): If image was created with usage containing "
5146 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5147 pCreateInfo->subresourceRange.levelCount);
5148 }
5149 }
5150 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5151 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005152 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005153 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5154 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5155 }
5156 } else {
5157 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5158 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5159 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005160 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005161 "vkCreateImageView(): If image was created with usage containing "
5162 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5163 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5164 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5165 }
5166 }
5167 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005168
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005169 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5170 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5171 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5172 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5173 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5174 }
5175 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5176 skip |=
5177 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5178 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5179 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5180 }
5181 }
5182 if (device_extensions.vk_ext_fragment_density_map_2) {
5183 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5184 (pCreateInfo->subresourceRange.layerCount >
5185 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5186 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5187 "vkCreateImageView(): If image was created with flags containing "
5188 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5189 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5190 pCreateInfo->subresourceRange.layerCount,
5191 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5192 }
5193 }
5194
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005195 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5196 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5197 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5198 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5199 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5200 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5201 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5202 }
5203 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005204
5205 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5206 // If swizzling is disabled, make sure it isn't used
5207 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5208 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5209 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5210 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5211 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5212 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5213 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5214 }
5215
5216 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5217 // disabled
5218 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5219 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5220 // spec. See Github issue #2361.
5221 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5222 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5223 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5224 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5225 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5226 "vkCreateImageView (portability error): ImageView format must have"
5227 " the same number of components and bits per component as the Image's format");
5228 }
5229 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005230 }
5231 return skip;
5232}
5233
Jeff Leger178b1e52020-10-05 12:22:23 -04005234template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005235bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005236 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005237 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005238 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5239 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5240 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005241
5242 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5243 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5244 VkDeviceSize src_min = UINT64_MAX;
5245 VkDeviceSize src_max = 0;
5246 VkDeviceSize dst_min = UINT64_MAX;
5247 VkDeviceSize dst_max = 0;
5248
5249 for (uint32_t i = 0; i < regionCount; i++) {
5250 src_min = std::min(src_min, pRegions[i].srcOffset);
5251 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5252 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5253 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5254
5255 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5256 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005257 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5258 skip |= LogError(src_buffer_state->buffer, vuid,
5259 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5260 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005261 }
5262
5263 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5264 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005265 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5266 skip |= LogError(dst_buffer_state->buffer, vuid,
5267 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5268 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005269 }
5270
5271 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5272 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005273 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5274 skip |= LogError(src_buffer_state->buffer, vuid,
5275 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005276 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005277 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
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 dstBuffer minus dstOffset
5281 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005282 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5283 skip |= LogError(dst_buffer_state->buffer, vuid,
5284 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005285 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005286 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005287 }
5288 }
5289
5290 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5291 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5292 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005293 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5294 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5295 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005296 }
5297 }
5298
5299 return skip;
5300}
5301
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005302bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005303 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005304 const auto cb_node = GetCBState(commandBuffer);
5305 const auto src_buffer_state = GetBufferState(srcBuffer);
5306 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005307
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005308 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005309 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5310 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005311 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005312 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005313 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5314 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005315 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005316 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5317 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005318 skip |=
5319 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5320 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005321 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5322 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005323 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005324 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5325 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5326 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005327 return skip;
5328}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005329
Jeff Leger178b1e52020-10-05 12:22:23 -04005330bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5331 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5332 const auto cb_node = GetCBState(commandBuffer);
5333 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5334 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5335
5336 bool skip = false;
5337 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5338 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5339 // Validate that SRC & DST buffers have correct usage flags set
5340 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5341 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5342 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5343 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5344 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5345 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5346 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5347 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5348 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5349 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5350 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5351 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5352 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5353 skip |=
5354 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5355 skip |=
5356 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5357 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5358 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5359 return skip;
5360}
5361
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005362bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005363 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005364 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005365 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005366 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005367 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5368 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005369 }
5370 }
5371 return skip;
5372}
5373
Jeff Bolz5c801d12019-10-09 10:38:45 -05005374bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5375 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005376 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005377 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005378
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005379 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005380 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005381 skip |=
5382 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005383 }
5384 return skip;
5385}
5386
Jeff Bolz5c801d12019-10-09 10:38:45 -05005387bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005388 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005389
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005390 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005391 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005392 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005393 }
5394 return skip;
5395}
5396
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005397bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005398 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005399 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005400 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005401 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005402 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005403 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005404 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005405 }
5406 return skip;
5407}
5408
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005409bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005410 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005411 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005412 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005413 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005414 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005415 skip |=
5416 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5417 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005418 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005419 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005420 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5421 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005422 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005423
sfricke-samsung022fa252020-07-24 03:26:16 -07005424 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5425 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5426
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005427 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005428 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5429 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5430 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5431 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005432 }
5433
5434 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005435 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5436 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5437 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5438 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005439 }
5440
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005441 return skip;
5442}
5443
Jeff Leger178b1e52020-10-05 12:22:23 -04005444template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005445bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005446 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005447 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005448 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005449 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5450 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005451
sfricke-samsung125d2b42020-05-28 06:32:43 -07005452 assert(image_state != nullptr);
5453 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005454
5455 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005456 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005457 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5458 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005459 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005460 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5461 "and 1, respectively.",
5462 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005463 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005464 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005465
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005466 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5467 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005468 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005469 "%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 -07005470 "must be 0 and 1, respectively.",
5471 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
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_3D) {
5476 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005477 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005478 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005479 "For 3D images these must be 0 and 1, respectively.",
5480 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005481 }
5482 }
5483
5484 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005485 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005486 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005487
sfricke-samsung125d2b42020-05-28 06:32:43 -07005488 // If not depth/stencil and not multi-plane
5489 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5490 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005491 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5492 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
5493 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005494 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005495 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005496 " must be a multiple of this format's texel size (%" PRIu32 ").",
5497 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005498 }
5499
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005500 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5501 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005502 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005503 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005504 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005505 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005506 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005507 }
5508
5509 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5510 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005511 vuid =
5512 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04005513 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005514 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005515 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5516 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005517 }
5518
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005519 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005520 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005521 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005522 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 -06005523 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5524 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005525 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005526 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005527 "zero or <= image subresource width (%d).",
5528 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005529 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005530 }
5531
5532 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005533 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 -06005534 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5535 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005536 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005537 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005538 "zero or <= image subresource height (%d).",
5539 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005540 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005541 }
5542
5543 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005544 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 -06005545 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5546 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005547 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005548 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005549 "zero or <= image subresource depth (%d).",
5550 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005551 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005552 }
5553
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005554 // subresource aspectMask must have exactly 1 bit set
5555 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005556 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005557 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005558 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5559 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005560 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005561 }
5562
5563 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005564 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005565 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005566 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005567 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5568 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005569 }
5570
5571 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005572 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5573 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005574
5575 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005576 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005577 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005578 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005579 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5580 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005581 }
5582
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005583 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005584 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005585 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005586 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005587 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005588 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005589 }
5590
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005591 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005592 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5593 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5594 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005595 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005596 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005597 "width & height (%d, %d)..",
5598 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5599 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005600 }
5601
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005602 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005603 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005604 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005605 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005606 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005607 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5608 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005609 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005610
5611 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005612 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005613 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005614 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005615 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005616 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005617 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5618 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5619 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005620 }
5621
5622 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005623 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005624 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005625 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005626 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005627 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5628 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5629 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005630 }
5631
5632 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005633 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005634 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005635 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005636 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005637 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5638 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5639 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005640 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005641 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005642
5643 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005644 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005645 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005646 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005647 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005648 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005649 "format has three planes.",
5650 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005651 }
5652
5653 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005654 if (0 ==
5655 (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 -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 for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005658 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5659 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005660 } else {
5661 // Know aspect mask is valid
5662 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5663 const uint32_t compatible_size = FormatElementSize(compatible_format);
5664 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5665 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005666 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005667 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005668 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5669 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5670 string_VkFormat(compatible_format));
5671 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005672 }
5673 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005674 }
5675
5676 return skip;
5677}
5678
Jeff Leger178b1e52020-10-05 12:22:23 -04005679template <typename BufferImageCopyRegionType>
5680bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5681 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005682 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005683 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005684
5685 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005686 VkExtent3D extent = pRegions[i].imageExtent;
5687 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005688
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005689 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5690 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005691 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5692 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5693 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005694 }
5695
5696 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5697
5698 // 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 -06005699 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005700 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005701 if (image_extent.width % block_extent.width) {
5702 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5703 }
5704 if (image_extent.height % block_extent.height) {
5705 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5706 }
5707 if (image_extent.depth % block_extent.depth) {
5708 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5709 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005710 }
5711
Dave Houltonfc1a4052017-04-27 14:32:45 -06005712 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005713 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005714 }
5715 }
5716
5717 return skip;
5718}
5719
Jeff Leger178b1e52020-10-05 12:22:23 -04005720template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005721bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005722 const BufferImageCopyRegionType *pRegions, const char *func_name,
5723 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005724 bool skip = false;
5725
5726 VkDeviceSize buffer_size = buff_state->createInfo.size;
5727
5728 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005729 VkDeviceSize max_buffer_offset =
5730 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5731 if (buffer_size < max_buffer_offset) {
5732 skip |=
5733 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 -07005734 }
5735 }
5736
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005737 return skip;
5738}
5739
Jeff Leger178b1e52020-10-05 12:22:23 -04005740template <typename BufferImageCopyRegionType>
5741bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5742 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5743 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005744 const auto cb_node = GetCBState(commandBuffer);
5745 const auto src_image_state = GetImageState(srcImage);
5746 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005747
Jeff Leger178b1e52020-10-05 12:22:23 -04005748 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5749 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5750 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5751 const char *vuid;
5752
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005753 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005754
5755 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005756 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005757
5758 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005759 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005760
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005761 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005762
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005763 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005764 vuid =
5765 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5766 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5767 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5768 "or transfer capabilities.",
5769 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005770 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005771 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5772 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5773 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5774 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005775
Jeff Leger178b1e52020-10-05 12:22:23 -04005776 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5777 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5778 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5779
5780 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5781 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5782 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5783 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005784
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005785 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005786 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5787 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005788 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005789 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5790 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005791 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005792 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5793 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5794 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5795 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5796 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5797 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005798
5799 // Validation for VK_EXT_fragment_density_map
5800 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005801 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5802 skip |= LogError(cb_node->commandBuffer, vuid,
5803 "%s: srcImage must not have been created with flags containing "
5804 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5805 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005806 }
5807
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005808 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005809 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5810 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005811 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005812 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5813 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005814 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005815
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005816 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 -04005817 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5818 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5819 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5820 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5821
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005822 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005823 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5824 vuid =
5825 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005826 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005827 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5828 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5829 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5830 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5831 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5832 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5833 "imageSubresource", vuid);
5834 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5835 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005836 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005837 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005838 }
5839 return skip;
5840}
5841
Jeff Leger178b1e52020-10-05 12:22:23 -04005842bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5843 VkBuffer dstBuffer, uint32_t regionCount,
5844 const VkBufferImageCopy *pRegions) const {
5845 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5846 COPY_COMMAND_VERSION_1);
5847}
5848
5849bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5850 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5851 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5852 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5853 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5854}
5855
John Zulauf1686f232019-07-09 16:27:11 -06005856void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5857 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5858 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5859
5860 auto cb_node = GetCBState(commandBuffer);
5861 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005862 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005863 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005864 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005865 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005866}
5867
Jeff Leger178b1e52020-10-05 12:22:23 -04005868void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5869 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5870 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5871
5872 auto cb_node = GetCBState(commandBuffer);
5873 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5874 // Make sure that all image slices record referenced layout
5875 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5876 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5877 pCopyImageToBufferInfo->srcImageLayout);
5878 }
5879}
5880
5881template <typename RegionType>
5882bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5883 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5884 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005885 const auto cb_node = GetCBState(commandBuffer);
5886 const auto src_buffer_state = GetBufferState(srcBuffer);
5887 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005888
Jeff Leger178b1e52020-10-05 12:22:23 -04005889 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5890 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5891 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5892 const char *vuid;
5893
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005894 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005895
5896 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005897 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005898
sfricke-samsungea4fd142020-10-17 23:51:59 -07005899 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5900 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5901
Jeff Leger178b1e52020-10-05 12:22:23 -04005902 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5903 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5904 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5905 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5906
5907 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5908 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5909 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5910 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5911 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5912 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5913 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5914 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5915 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005916 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005917 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5918 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005919 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005920 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5921 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5922 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5923 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5924 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5925 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005926
5927 // Validation for VK_EXT_fragment_density_map
5928 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005929 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5930 skip |= LogError(cb_node->commandBuffer, vuid,
5931 "%s: dstImage must not have been created with flags containing "
5932 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5933 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005934 }
5935
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005936 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005937 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
5938 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005939 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005940 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
5941 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005942 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005943
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005944 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 -04005945 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
5946 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
5947 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
5948 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
5949
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005950 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005951 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5952 vuid =
5953 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005954 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005955 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
5956 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
5957 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
5958 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
5959 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
5960 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5961 "imageSubresource", vuid);
5962 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
5963 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005964 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005965 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07005966
5967 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5968 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5969 assert(command_pool != nullptr);
5970 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5971 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5972 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
5973 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
5974 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
5975 LogObjectList objlist(cb_node->commandBuffer);
5976 objlist.add(command_pool->commandPool);
5977 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
5978 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
5979 skip |= LogError(dst_image_state->image, vuid,
5980 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5981 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5982 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5983 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5984 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
5985 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005986 }
5987 return skip;
5988}
5989
Jeff Leger178b1e52020-10-05 12:22:23 -04005990bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5991 VkImageLayout dstImageLayout, uint32_t regionCount,
5992 const VkBufferImageCopy *pRegions) const {
5993 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
5994 COPY_COMMAND_VERSION_1);
5995}
5996
5997bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5998 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
5999 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6000 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6001 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6002}
6003
John Zulauf1686f232019-07-09 16:27:11 -06006004void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6005 VkImageLayout dstImageLayout, uint32_t regionCount,
6006 const VkBufferImageCopy *pRegions) {
6007 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6008
6009 auto cb_node = GetCBState(commandBuffer);
6010 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006011 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006012 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006013 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006014 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006015}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006016
Jeff Leger178b1e52020-10-05 12:22:23 -04006017void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6018 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6019 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6020
6021 auto cb_node = GetCBState(commandBuffer);
6022 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6023 // Make sure that all image slices are record referenced layout
6024 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6025 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6026 pCopyBufferToImageInfo2KHR->dstImageLayout);
6027 }
6028}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006029bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006030 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006031 bool skip = false;
6032 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6033
Dave Houlton1d960ff2018-01-19 12:17:05 -07006034 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006035 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6036 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6037 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006038 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6039 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006040 }
6041
John Zulaufa26d3c82019-08-14 16:09:08 -06006042 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006043 if (!image_entry) {
6044 return skip;
6045 }
6046
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006047 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6048 if (device_extensions.vk_ext_image_drm_format_modifier) {
6049 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6050 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006051 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6052 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6053 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006054 }
6055 } else {
6056 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006057 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6058 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006059 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006060 }
6061
Dave Houlton1d960ff2018-01-19 12:17:05 -07006062 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006063 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006064 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6065 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6066 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006067 }
6068
Dave Houlton1d960ff2018-01-19 12:17:05 -07006069 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006070 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006071 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6072 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6073 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006074 }
6075
Dave Houlton1d960ff2018-01-19 12:17:05 -07006076 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006077 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006078 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6079 if (FormatIsMultiplane(img_format)) {
6080 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
6081 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6082 if (FormatPlaneCount(img_format) > 2u) {
6083 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
6084 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6085 }
6086 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006087 skip |= LogError(image, vuid,
6088 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6089 ") must be a single-plane specifier flag.",
6090 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006091 }
6092 } else if (FormatIsColor(img_format)) {
6093 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006094 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6095 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6096 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006097 }
6098 } else if (FormatIsDepthOrStencil(img_format)) {
6099 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6100 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006101 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006102 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6103 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6104 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6105 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006106 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6107 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6108 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006109 }
6110 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006111
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006112 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006113 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006114 }
6115
Mike Weiblen672b58b2017-02-21 14:32:53 -07006116 return skip;
6117}
sfricke-samsung022fa252020-07-24 03:26:16 -07006118
6119// Validates the image is allowed to be protected
6120bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006121 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006122 bool skip = false;
6123 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6124 LogObjectList objlist(cb_state->commandBuffer);
6125 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006126 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 -07006127 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006128 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006129 }
6130 return skip;
6131}
6132
6133// Validates the image is allowed to be unprotected
6134bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006135 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006136 bool skip = false;
6137 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6138 LogObjectList objlist(cb_state->commandBuffer);
6139 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006140 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 -07006141 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006142 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006143 }
6144 return skip;
6145}
6146
6147// Validates the buffer is allowed to be protected
6148bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006149 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006150 bool skip = false;
6151 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6152 LogObjectList objlist(cb_state->commandBuffer);
6153 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006154 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 -07006155 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006156 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006157 }
6158 return skip;
6159}
6160
6161// Validates the buffer is allowed to be unprotected
6162bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006163 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006164 bool skip = false;
6165 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6166 LogObjectList objlist(cb_state->commandBuffer);
6167 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006168 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 -07006169 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006170 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006171 }
6172 return skip;
6173}