blob: 22a240c908f6e1c60a4d9483033bc4a60670aa01 [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
John Zulauff660ad62019-03-23 07:16:05 -0600164// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
165static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
166 VkImageSubresourceRange subresource_range;
167 subresource_range.aspectMask = subresource_layers.aspectMask;
168 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
169 subresource_range.layerCount = subresource_layers.layerCount;
170 subresource_range.baseMipLevel = subresource_layers.mipLevel;
171 subresource_range.levelCount = 1;
172 return subresource_range;
173}
174
John Zulaufb58415b2019-12-09 15:02:32 -0700175static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
176 const auto format = create_info.format;
177 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200178
179#ifdef VK_USE_PLATFORM_ANDROID_KHR
180 const VkExternalFormatANDROID *pExternalFormatANDROID = lvl_find_in_chain<VkExternalFormatANDROID>(&create_info);
181 bool isExternalFormatConversion = (pExternalFormatANDROID != nullptr && pExternalFormatANDROID->externalFormat != 0);
182#else
183 bool isExternalFormatConversion = false;
184#endif
185
186 if (FormatIsColor(format) || FormatIsMultiplane(format) || isExternalFormatConversion) {
John Zulaufb58415b2019-12-09 15:02:32 -0700187 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
188 } else {
189 init_range.aspectMask =
190 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
191 }
192 return NormalizeSubresourceRange(create_info, init_range);
193}
194
locke-lunarg296a3c92020-03-25 01:04:29 -0600195IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -0600196 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -0700197 safe_create_info(pCreateInfo),
198 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -0600199 valid(false),
200 acquired(false),
201 shared_presentable(false),
202 layout_locked(false),
203 get_sparse_reqs_called(false),
204 sparse_metadata_required(false),
205 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -0600206 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700207 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -0600208 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700209 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -0600210 create_from_swapchain(VK_NULL_HANDLE),
211 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -0600212 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700213 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -0700214 disjoint(false),
215 plane0_memory_requirements_checked(false),
216 plane1_memory_requirements_checked(false),
217 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -0600218 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -0600219 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -0600220 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
unknown08c57af2019-06-21 16:33:35 -0600221 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600222 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
223 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
224 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
225 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
226 }
227 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
228 }
229
230 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
231 sparse = true;
232 }
Locked8af3732019-05-10 09:47:56 -0600233
sfricke-samsunge2441192019-11-06 14:07:57 -0800234 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
235 if (externalMemoryInfo) {
236 external_memory_handle = externalMemoryInfo->handleTypes;
237 }
John Zulauff660ad62019-03-23 07:16:05 -0600238}
239
unknown2c877272019-07-11 12:56:50 -0600240bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
241 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
242 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
243 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
244 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
245 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
246 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600247 return is_equal &&
248 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600249}
250
Jeff Bolz82f854d2019-09-17 14:56:47 -0500251// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
252bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
253 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
254 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
255 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
256 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
257 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600258 is_compatible = is_compatible &&
259 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
260 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500261
262 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
263 createInfo.extent.height <= other_createInfo.extent.height &&
264 createInfo.extent.depth <= other_createInfo.extent.depth &&
265 createInfo.arrayLayers <= other_createInfo.arrayLayers;
266 return is_compatible;
267}
268
unknown2c877272019-07-11 12:56:50 -0600269bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700270 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
271 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
272 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700273 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
274 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600275 IsCreateInfoEqual(other_image_state->createInfo)) {
276 return true;
277 }
unknowne1661522019-07-11 13:04:18 -0600278 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
279 return true;
280 }
unknown2c877272019-07-11 12:56:50 -0600281 return false;
282}
283
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500284IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
285 : image_view(iv),
286 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700287 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600288 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500289 samplerConversion(VK_NULL_HANDLE),
290 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600291 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
292 if (conversionInfo) samplerConversion = conversionInfo->conversion;
293 if (image_state) {
294 // A light normalization of the createInfo range
295 auto &sub_res_range = create_info.subresourceRange;
296 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
297 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
298
299 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700300 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500301 samples = image_state->createInfo.samples;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200302
303 if (image_state->has_ahb_format) {
304 // When the image has a external format the views format must be VK_FORMAT_UNDEFINED and it is required to use a sampler
305 // Ycbcr conversion. Thus we can't extract any meaningful information from the format parameter. As a Sampler Ycbcr
306 // conversion must be used the shader type is always float.
307 descriptor_format_bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
308 } else {
309 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
310 }
John Zulauff660ad62019-03-23 07:16:05 -0600311 }
312}
313
locke-lunarg540b2252020-08-03 13:23:36 -0600314bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600315 if (image_view == compare_view.image_view) {
316 return true;
317 }
locke-lunargdc287022020-08-21 12:03:57 -0600318 if (image_state->image != compare_view.image_state->image) {
319 return false;
320 }
locke-lunarg540b2252020-08-03 13:23:36 -0600321 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
322 return false;
323 }
324
325 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600326 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600327 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600328 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600329 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600330 }
331
332 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600333 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600334 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600335 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600336 }
337
338 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600339 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600340 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600341 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600342 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600343 }
344
345 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600346 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600347 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600348 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600349 }
locke-lunargdc287022020-08-21 12:03:57 -0600350 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600351}
352
Dave Houltond9611312018-11-19 17:03:36 -0700353uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
354 // uint cast applies floor()
355 return 1u + (uint32_t)log2(std::max({height, width, depth}));
356}
357
358uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
359
360uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
361
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500362bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700363 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700364 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700365
John Zulauf2076e812020-01-08 14:55:54 -0700366 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
367 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700368 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
369 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
370
John Zulauf2076e812020-01-08 14:55:54 -0700371 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
372
373 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
374 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700375 return false;
376 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700377
John Zulauf2076e812020-01-08 14:55:54 -0700378 for (auto entry : *layout_range_map) {
379 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700380 }
381 return true;
382}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700383
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600384// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600385void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600386 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
387 VkImageLayout expected_layout) {
388 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
389 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600390 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600391 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700392 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700393 for (const auto &image : image_state.aliasing_images) {
394 auto alias_state = GetImageState(image);
395 // The map state of the aliases should all be in sync, so no need to check the return value
396 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
397 assert(subresource_map);
398 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
399 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700400}
John Zulauff660ad62019-03-23 07:16:05 -0600401
402// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600403void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600404 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500405 return;
406 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500407 IMAGE_STATE *image_state = view_state.image_state.get();
408 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700409 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700410 for (const auto &image : image_state->aliasing_images) {
411 image_state = GetImageState(image);
412 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
413 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
414 }
John Zulauff660ad62019-03-23 07:16:05 -0600415}
416
417// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600418void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600419 const VkImageSubresourceRange &range, VkImageLayout layout) {
420 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
421 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600422 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700423 for (const auto &image : image_state.aliasing_images) {
424 auto alias_state = GetImageState(image);
425 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
426 assert(subresource_map);
427 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
428 }
John Zulauff660ad62019-03-23 07:16:05 -0600429}
430
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600431void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600432 VkImageLayout layout) {
433 const IMAGE_STATE *image_state = GetImageState(image);
434 if (!image_state) return;
435 SetImageInitialLayout(cb_node, *image_state, range, layout);
436};
437
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600438void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600439 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
440 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600441}
Dave Houltonddd65c52018-05-08 14:58:01 -0600442
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600443// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700444void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
445 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500446 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600447
John Zulauff660ad62019-03-23 07:16:05 -0600448 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600449 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
450 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600451 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 -0600452 sub_range.baseArrayLayer = 0;
453 sub_range.layerCount = image_state->createInfo.extent.depth;
454 }
455
Piers Daniell4fde9b72019-11-27 16:19:46 -0700456 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
457 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
458 SetImageLayout(cb_node, *image_state, sub_range, layout);
459 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
460 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
461 } else {
462 SetImageLayout(cb_node, *image_state, sub_range, layout);
463 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600464}
465
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700466bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
467 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700468 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600469 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100470 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700471 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100472 const char *vuid;
473 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700474 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100475
476 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600477 LogObjectList objlist(image);
478 objlist.add(renderpass);
479 objlist.add(framebuffer);
480 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700481 skip |=
482 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
483 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
484 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
485 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100486 return skip;
487 }
488
489 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200490 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
491 if (stencil_usage_info) {
492 image_usage |= stencil_usage_info->stencilUsage;
493 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100494
495 // Check for layouts that mismatch image usages in the framebuffer
496 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800497 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600498 LogObjectList objlist(image);
499 objlist.add(renderpass);
500 objlist.add(framebuffer);
501 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700502 skip |= LogError(objlist, vuid,
503 "%s: Layout/usage mismatch for attachment %u in %s"
504 " - the %s is %s but the image attached to %s via %s"
505 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
506 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
507 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
508 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100509 }
510
511 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
512 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800513 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600514 LogObjectList objlist(image);
515 objlist.add(renderpass);
516 objlist.add(framebuffer);
517 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700518 skip |= LogError(objlist, vuid,
519 "%s: Layout/usage mismatch for attachment %u in %s"
520 " - the %s is %s but the image attached to %s via %s"
521 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
522 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
523 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
524 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100525 }
526
527 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800528 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600529 LogObjectList objlist(image);
530 objlist.add(renderpass);
531 objlist.add(framebuffer);
532 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700533 skip |= LogError(objlist, vuid,
534 "%s: Layout/usage mismatch for attachment %u in %s"
535 " - the %s is %s but the image attached to %s via %s"
536 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
537 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
538 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
539 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100540 }
541
542 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800543 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600544 LogObjectList objlist(image);
545 objlist.add(renderpass);
546 objlist.add(framebuffer);
547 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700548 skip |= LogError(objlist, vuid,
549 "%s: Layout/usage mismatch for attachment %u in %s"
550 " - the %s is %s but the image attached to %s via %s"
551 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
552 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
553 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
554 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100555 }
556
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600557 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100558 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
559 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
560 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
561 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
562 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800563 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600564 LogObjectList objlist(image);
565 objlist.add(renderpass);
566 objlist.add(framebuffer);
567 objlist.add(image_view);
568 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700569 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700570 " - the %s is %s but the image attached to %s via %s"
571 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700572 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700573 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
574 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100575 }
576 } else {
577 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
578 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
579 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
580 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600581 LogObjectList objlist(image);
582 objlist.add(renderpass);
583 objlist.add(framebuffer);
584 objlist.add(image_view);
585 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700586 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700587 " - the %s is %s but the image attached to %s via %s"
588 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700589 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700590 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
591 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100592 }
593 }
594 return skip;
595}
596
John Zulauf17a01bb2019-08-09 16:41:19 -0600597bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700598 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600599 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600600 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700601 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700602 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100603 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100604
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700605 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100606 auto framebuffer = framebuffer_state->framebuffer;
607
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700608 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700609 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
610 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700611 }
John Zulauf8e308292018-09-21 11:34:37 -0600612
Tobias Hectorc9057422019-07-23 12:15:52 +0100613 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
614 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
615 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100616 }
617
Tobias Hectorc9057422019-07-23 12:15:52 +0100618 if (attachments != nullptr) {
619 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
620 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
621 auto image_view = attachments[i];
622 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100623
Tobias Hectorc9057422019-07-23 12:15:52 +0100624 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600625 LogObjectList objlist(pRenderPassBegin->renderPass);
626 objlist.add(framebuffer_state->framebuffer);
627 objlist.add(image_view);
628 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700629 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
630 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
631 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100632 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100633 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100634
635 const VkImage image = view_state->create_info.image;
636 const IMAGE_STATE *image_state = GetImageState(image);
637
638 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600639 LogObjectList objlist(pRenderPassBegin->renderPass);
640 objlist.add(framebuffer_state->framebuffer);
641 objlist.add(image_view);
642 objlist.add(image);
643 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700644 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
645 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
646 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100647 continue;
648 }
649 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
650 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
651
Piers Daniell7f894f62020-01-09 16:33:48 -0700652 // Default to expecting stencil in the same layout.
653 auto attachment_stencil_initial_layout = attachment_initial_layout;
654
655 // If a separate layout is specified, look for that.
656 const auto *attachment_description_stencil_layout =
657 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
658 if (attachment_description_stencil_layout) {
659 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
660 }
661
Tobias Hectorc9057422019-07-23 12:15:52 +0100662 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
663 // in common with the non-const version.)
664 const ImageSubresourceLayoutMap *subresource_map =
665 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
666
667 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
668 LayoutUseCheckAndMessage layout_check(subresource_map);
669 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700670 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700671 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
672 // the next "constant value" range
673 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700674 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700675
John Zulauf5e617452019-11-19 14:44:16 -0700676 // Allow for differing depth and stencil layouts
677 VkImageLayout check_layout = attachment_initial_layout;
678 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
679
680 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700681 subres_skip |= LogError(
682 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700683 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
684 "and the %s layout of the attachment is %s. The layouts must match, or the render "
685 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700686 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100687 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700688 }
John Zulauf5e617452019-11-19 14:44:16 -0700689
Tobias Hectorc9057422019-07-23 12:15:52 +0100690 skip |= subres_skip;
691 }
692
693 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
694 framebuffer, render_pass, i, "initial layout");
695
696 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
697 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100698 }
699
Tobias Hectorc9057422019-07-23 12:15:52 +0100700 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
701 auto &subpass = pRenderPassInfo->pSubpasses[j];
702 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
703 auto &attachment_ref = subpass.pInputAttachments[k];
704 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
705 auto image_view = attachments[attachment_ref.attachment];
706 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100707
Tobias Hectorc9057422019-07-23 12:15:52 +0100708 if (view_state) {
709 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700710 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
711 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100712 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100713 }
714 }
715 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100716
Tobias Hectorc9057422019-07-23 12:15:52 +0100717 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
718 auto &attachment_ref = subpass.pColorAttachments[k];
719 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
720 auto image_view = attachments[attachment_ref.attachment];
721 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100722
Tobias Hectorc9057422019-07-23 12:15:52 +0100723 if (view_state) {
724 auto image = view_state->create_info.image;
725 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
726 framebuffer, render_pass, attachment_ref.attachment,
727 "color attachment layout");
728 if (subpass.pResolveAttachments) {
729 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
730 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
731 attachment_ref.attachment, "resolve attachment layout");
732 }
733 }
734 }
735 }
736
737 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
738 auto &attachment_ref = *subpass.pDepthStencilAttachment;
739 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
740 auto image_view = attachments[attachment_ref.attachment];
741 auto view_state = GetImageViewState(image_view);
742
743 if (view_state) {
744 auto image = view_state->create_info.image;
745 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
746 framebuffer, render_pass, attachment_ref.attachment,
747 "input attachment layout");
748 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100749 }
750 }
751 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700752 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600753 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700754}
755
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600756void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700757 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700758 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinski8d46f802020-12-07 16:33:54 -0700759 IMAGE_VIEW_STATE *image_view = GetActiveAttachmentImageViewState(pCB, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600760 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700761 VkImageLayout stencil_layout = kInvalidLayout;
762 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
763 if (attachment_reference_stencil_layout) {
764 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
765 }
766
767 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600768 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700769 }
770}
771
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600772void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
773 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700774 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700775
776 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700777 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700778 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700779 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700780 }
781 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700782 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700783 }
784 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700785 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700786 }
787 }
788}
789
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700790// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
791// 1. Transition into initialLayout state
792// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600793void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700794 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700795 // First transition into initialLayout
796 auto const rpci = render_pass_state->createInfo.ptr();
797 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -0700798 auto *view_state = GetActiveAttachmentImageViewState(cb_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600799 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700800 VkImageLayout stencil_layout = kInvalidLayout;
801 const auto *attachment_description_stencil_layout =
802 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
803 if (attachment_description_stencil_layout) {
804 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
805 }
806
807 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600808 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700809 }
810 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700811 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700812}
813
Dave Houlton10b39482017-03-16 13:18:15 -0600814bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600815 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600816 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600817 }
818 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600819 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600820 }
821 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600822 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600823 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700824 if (0 !=
825 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
826 if (FormatPlaneCount(format) == 1) return false;
827 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600828 return true;
829}
830
Mike Weiblen62d08a32017-03-07 22:18:27 -0700831// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200832bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
833 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600834 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700835 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200836 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600837 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700838
839 switch (layout) {
840 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
841 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600842 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700843 }
844 break;
845 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
846 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600847 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700848 }
849 break;
850 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
851 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600852 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700853 }
854 break;
855 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
856 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600857 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700858 }
859 break;
860 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
861 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600862 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700863 }
864 break;
865 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
866 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600867 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700868 }
869 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600870 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500871 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
872 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
873 }
874 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700875 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
876 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
877 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
878 }
879 break;
880 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
881 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
882 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
883 }
884 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700885 default:
886 // Other VkImageLayout values do not have VUs defined in this context.
887 break;
888 }
889
Dave Houlton8e9f6542018-05-18 12:18:22 -0600890 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700891 skip |= LogError(img_barrier.image, msg_code,
892 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
893 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
894 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700895 }
896 return skip;
897}
898
899// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600900bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
901 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700902 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700903
Petr Krausad0096a2019-08-09 18:35:04 +0200904 // Scoreboard for checking for duplicate and inconsistent barriers to images
905 struct ImageBarrierScoreboardEntry {
906 uint32_t index;
907 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
908 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
909 const VkImageMemoryBarrier *barrier;
910 };
911 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
912 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
913
John Zulauf463c51e2018-05-31 13:29:20 -0600914 // Scoreboard for duplicate layout transition barriers within the list
915 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
916 ImageBarrierScoreboardImageMap layout_transitions;
917
Mike Weiblen62d08a32017-03-07 22:18:27 -0700918 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200919 const auto &img_barrier = pImageMemoryBarriers[i];
920 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700921
John Zulauf463c51e2018-05-31 13:29:20 -0600922 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
923 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
924 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200925 if (img_barrier.oldLayout != img_barrier.newLayout) {
926 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
927 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600928 if (image_it != layout_transitions.end()) {
929 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200930 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600931 if (subres_it != subres_map.end()) {
932 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200933 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
934 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
935 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700936 skip = LogError(
937 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200938 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600939 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
940 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200941 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
942 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
943 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600944 }
945 entry = new_entry;
946 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200947 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600948 }
949 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200950 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600951 }
952 }
953
Petr Krausad0096a2019-08-09 18:35:04 +0200954 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600955 if (image_state) {
956 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200957 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
958 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600959
960 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
961 if (image_state->layout_locked) {
962 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700963 skip |= LogError(
964 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700965 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600966 " 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 -0700967 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200968 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600969 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600970
John Zulaufa4472282019-08-22 14:44:34 -0600971 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700972 const VkFormat image_format = image_create_info.format;
973 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600974 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700975 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700976 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600977 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
978 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700979 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
980 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
981 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
982 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700983 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600984 }
985 } else {
986 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
987 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700988 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
989 ? "VUID-VkImageMemoryBarrier-image-03320"
990 : "VUID-VkImageMemoryBarrier-image-01207";
991 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700992 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
993 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
994 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700995 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600996 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700997 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700998 }
John Zulauff660ad62019-03-23 07:16:05 -0600999
Petr Krausad0096a2019-08-09 18:35:04 +02001000 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1001 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001002 // TODO: Set memory invalid which is in mem_tracker currently
1003 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1004 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001005 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001006 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001007 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001008 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001009 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1010 // the next "constant value" range
1011 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001012 const auto &value = *pos;
1013 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001014 subres_skip = LogError(
1015 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001016 "%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 -07001017 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001018 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -07001019 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1020 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001021 }
John Zulauf5e617452019-11-19 14:44:16 -07001022 }
John Zulauff660ad62019-03-23 07:16:05 -06001023 skip |= subres_skip;
1024 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001025
1026 // checks color format and (single-plane or non-disjoint)
1027 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1028 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001029 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001030 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1031 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
1032 ? "VUID-VkImageMemoryBarrier-image-01671"
1033 : "VUID-VkImageMemoryBarrier-image-02902";
1034 skip |= LogError(img_barrier.image, vuid,
1035 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1036 "but its aspectMask is 0x%" PRIx32 ".",
1037 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1038 string_VkFormat(image_format), aspect_mask);
1039 }
1040 }
1041
1042 VkImageAspectFlags valid_disjoint_mask =
1043 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 -07001044 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001045 ((aspect_mask & valid_disjoint_mask) == 0)) {
1046 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1047 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1048 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1049 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1050 string_VkFormat(image_format), aspect_mask);
1051 }
1052
1053 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1054 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1055 "%s: Image barrier %s references %s of format %s has only two planes but included "
1056 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1057 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1058 string_VkFormat(image_format), aspect_mask);
1059 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001060 }
1061 }
1062 return skip;
1063}
1064
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001065bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001066 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001067
Jeff Bolz6835fda2019-10-06 00:15:34 -05001068 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001069 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001070}
1071
John Zulauf6b4aae82018-05-09 13:03:36 -06001072template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001073bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1074 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001075 using BarrierRecord = QFOTransferBarrier<Barrier>;
1076 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001077 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001078 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1079 const char *barrier_name = BarrierRecord::BarrierName();
1080 const char *handle_name = BarrierRecord::HandleName();
1081 const char *transfer_type = nullptr;
1082 for (uint32_t b = 0; b < barrier_count; b++) {
1083 if (!IsTransferOp(&barriers[b])) continue;
1084 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001085 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001086 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001087 const auto found = barrier_sets.release.find(barriers[b]);
1088 if (found != barrier_sets.release.cend()) {
1089 barrier_record = &(*found);
1090 transfer_type = "releasing";
1091 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001092 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001093 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001094 const auto found = barrier_sets.acquire.find(barriers[b]);
1095 if (found != barrier_sets.acquire.cend()) {
1096 barrier_record = &(*found);
1097 transfer_type = "acquiring";
1098 }
1099 }
1100 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001101 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1102 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1103 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1104 func_name, barrier_name, b, transfer_type, handle_name,
1105 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1106 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001107 }
1108 }
1109 return skip;
1110}
1111
John Zulaufa4472282019-08-22 14:44:34 -06001112VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1113 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1114}
1115
1116const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1117 return device_state.GetImageState(barrier.image);
1118}
1119
1120VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1121 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1122}
1123
1124const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1125 return device_state.GetBufferState(barrier.buffer);
1126}
1127
1128VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1129
John Zulauf6b4aae82018-05-09 13:03:36 -06001130template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001131void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1132 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001133 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001134 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1135 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001136 auto &barrier = barriers[b];
1137 if (IsTransferOp(&barrier)) {
1138 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001139 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001140 barrier_sets.release.emplace(barrier);
1141 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001142 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001143 barrier_sets.acquire.emplace(barrier);
1144 }
1145 }
1146
1147 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1148 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1149 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1150 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1151 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1152 auto handle_state = BarrierHandleState(*this, barrier);
1153 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1154 if (!mode_concurrent) {
1155 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001156 cb_state->queue_submit_functions.emplace_back(
1157 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1158 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1159 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1160 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001161 });
1162 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001163 }
1164 }
1165}
1166
John Zulaufa4472282019-08-22 14:44:34 -06001167bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001168 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001169 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001170 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001171 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001172 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1173 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001174 return skip;
1175}
1176
John Zulaufa4472282019-08-22 14:44:34 -06001177void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1178 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1179 const VkImageMemoryBarrier *pImageMemBarriers) {
1180 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1181 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001182}
1183
1184template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001185bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001186 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001187 // Record to the scoreboard or report that we have a duplication
1188 bool skip = false;
1189 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1190 if (!inserted.second && inserted.first->second != cb_state) {
1191 // 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 -06001192 LogObjectList objlist(cb_state->commandBuffer);
1193 objlist.add(barrier.handle);
1194 objlist.add(inserted.first->second->commandBuffer);
1195 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001196 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1197 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1198 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1199 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1200 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001201 }
1202 return skip;
1203}
1204
1205template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001206bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1207 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001208 using BarrierRecord = QFOTransferBarrier<Barrier>;
1209 using TypeTag = typename BarrierRecord::Tag;
1210 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001211 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001212 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001213 const char *barrier_name = BarrierRecord::BarrierName();
1214 const char *handle_name = BarrierRecord::HandleName();
1215 // No release should have an extant duplicate (WARNING)
1216 for (const auto &release : cb_barriers.release) {
1217 // Check the global pending release barriers
1218 const auto set_it = global_release_barriers.find(release.handle);
1219 if (set_it != global_release_barriers.cend()) {
1220 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1221 const auto found = set_for_handle.find(release);
1222 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001223 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1224 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1225 " to dstQueueFamilyIndex %" PRIu32
1226 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1227 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1228 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001229 }
1230 }
1231 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1232 }
1233 // Each acquire must have a matching release (ERROR)
1234 for (const auto &acquire : cb_barriers.acquire) {
1235 const auto set_it = global_release_barriers.find(acquire.handle);
1236 bool matching_release_found = false;
1237 if (set_it != global_release_barriers.cend()) {
1238 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1239 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1240 }
1241 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001242 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1243 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1244 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1245 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1246 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001247 }
1248 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1249 }
1250 return skip;
1251}
1252
John Zulauf3b04ebd2019-07-18 14:08:11 -06001253bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001254 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001255 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001256 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001257 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1258 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001259 return skip;
1260}
1261
1262template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001263void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001264 using BarrierRecord = QFOTransferBarrier<Barrier>;
1265 using TypeTag = typename BarrierRecord::Tag;
1266 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001267 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001268
1269 // Add release barriers from this submit to the global map
1270 for (const auto &release : cb_barriers.release) {
1271 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1272 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1273 global_release_barriers[release.handle].insert(release);
1274 }
1275
1276 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1277 for (const auto &acquire : cb_barriers.acquire) {
1278 // NOTE: We're not using [] because we don't want to create entries for missing releases
1279 auto set_it = global_release_barriers.find(acquire.handle);
1280 if (set_it != global_release_barriers.end()) {
1281 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1282 set_for_handle.erase(acquire);
1283 if (set_for_handle.size() == 0) { // Clean up empty sets
1284 global_release_barriers.erase(set_it);
1285 }
1286 }
1287 }
1288}
1289
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001290void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001291 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1292 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001293}
1294
John Zulauf6b4aae82018-05-09 13:03:36 -06001295// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001296void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001297
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001298void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001299 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001300 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001301 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001302
Chris Forbes4de4b132017-08-21 11:27:08 -07001303 // For ownership transfers, the barrier is specified twice; as a release
1304 // operation on the yielding queue family, and as an acquire operation
1305 // on the acquiring queue family. This barrier may also include a layout
1306 // transition, which occurs 'between' the two operations. For validation
1307 // purposes it doesn't seem important which side performs the layout
1308 // transition, but it must not be performed twice. We'll arbitrarily
1309 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001310 //
1311 // However, we still need to record initial layout for the "initial layout" validation
1312 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001313
Petr Krausad0096a2019-08-09 18:35:04 +02001314 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001315 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001316 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001317 }
1318}
1319
unknown86bcb3a2019-07-11 13:05:36 -06001320void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001321 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001322 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1323 const auto &image_create_info = image_state->createInfo;
1324
1325 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1326 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1327 // for all (potential) layer sub_resources.
1328 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1329 normalized_isr.baseArrayLayer = 0;
1330 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1331 }
1332
Michael Spang8af7c102020-05-03 20:50:09 -04001333 VkImageLayout initial_layout = mem_barrier.oldLayout;
1334
1335 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001336 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001337 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1338 }
1339
John Zulauf2be3fe02019-12-30 09:48:02 -07001340 if (is_release_op) {
1341 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1342 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001343 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001344 }
unknown86bcb3a2019-07-11 13:05:36 -06001345}
1346
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001347bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1348 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1349 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1350 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001351 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001352 assert(cb_node);
1353 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001354 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001355 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001356
John Zulauff660ad62019-03-23 07:16:05 -06001357 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1358 if (subresource_map) {
1359 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001360 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001361 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1362 // the next "constant value" range
1363 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001364 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001365 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001366 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1367 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1368 "%s layout %s.",
1369 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1370 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1371 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001372 }
John Zulauf5e617452019-11-19 14:44:16 -07001373 }
John Zulauff660ad62019-03-23 07:16:05 -06001374 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001375 }
John Zulauff660ad62019-03-23 07:16:05 -06001376
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001377 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1378 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1379 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001380 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1381 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001382 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1383 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1384 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001385 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001386 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001387 if (image_state->shared_presentable) {
1388 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001389 skip |=
1390 LogError(device, layout_invalid_msg_code,
1391 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1392 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001393 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001394 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001395 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001396 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001397 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1398 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1399 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1400 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001401 }
1402 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001403 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001404}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001405bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001406 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1407 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001408 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001409 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1410 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1411}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001412
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001413void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001414 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001415 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001416 if (!renderPass) return;
1417
Tobias Hectorbbb12282018-10-22 15:17:59 +01001418 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001419 if (framebuffer_state) {
1420 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001421 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001422 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001423 VkImageLayout stencil_layout = kInvalidLayout;
1424 const auto *attachment_description_stencil_layout =
1425 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1426 if (attachment_description_stencil_layout) {
1427 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1428 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001429 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001430 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001431 }
1432 }
1433}
Dave Houltone19e20d2018-02-02 16:32:41 -07001434
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001435#ifdef VK_USE_PLATFORM_ANDROID_KHR
1436// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1437// This could also move into a seperate core_validation_android.cpp file... ?
1438
1439//
1440// AHB-specific validation within non-AHB APIs
1441//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001442bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001443 bool skip = false;
1444
1445 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1446 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001447 if (0 != ext_fmt_android->externalFormat) {
1448 if (VK_FORMAT_UNDEFINED != create_info->format) {
1449 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001450 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1451 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1452 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001453 }
1454
1455 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001456 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1457 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1458 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001459 }
1460
1461 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001462 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1463 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001464 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1465 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1466 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001467 }
1468
1469 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001470 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1471 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1472 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001473 }
1474 }
1475
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001476 if ((0 != ext_fmt_android->externalFormat) &&
1477 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001478 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001479 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1480 ") which has "
1481 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1482 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001483 }
1484 }
1485
Dave Houltond9611312018-11-19 17:03:36 -07001486 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001487 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001488 skip |=
1489 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1490 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1491 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001492 }
1493 }
1494
1495 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1496 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1497 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001498 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001499 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1500 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1501 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1502 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001503 }
1504
1505 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001506 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1507 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1508 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1509 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1510 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001511 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001512 }
1513
1514 return skip;
1515}
1516
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001517bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001518 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001519 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001520
1521 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001522 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001523 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1524 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001525 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001526 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001527 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001528
Dave Houltond9611312018-11-19 17:03:36 -07001529 // Chain must include a compatible ycbcr conversion
1530 bool conv_found = false;
1531 uint64_t external_format = 0;
1532 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1533 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001534 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001535 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001536 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001537 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001538 }
Dave Houltond9611312018-11-19 17:03:36 -07001539 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001540 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001541 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001542 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1543 "an externalFormat (%" PRIu64
1544 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1545 "with the same external format.",
1546 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001547 }
1548
1549 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001550 if (IsIdentitySwizzle(create_info->components) == false) {
1551 skip |= LogError(
1552 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1553 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1554 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1555 "= %s.",
1556 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1557 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001558 }
1559 }
Dave Houltond9611312018-11-19 17:03:36 -07001560
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001561 return skip;
1562}
1563
John Zulaufa26d3c82019-08-14 16:09:08 -06001564bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001565 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001566
John Zulaufa26d3c82019-08-14 16:09:08 -06001567 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001568 if (image_state != nullptr) {
1569 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1570 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1571 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1572 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1573 "bound to memory.");
1574 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001575 }
1576 return skip;
1577}
1578
1579#else
1580
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001581bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001582 return false;
1583}
1584
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001585bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001586
John Zulaufa26d3c82019-08-14 16:09:08 -06001587bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001588
1589#endif // VK_USE_PLATFORM_ANDROID_KHR
1590
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001591bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1592 bool skip = false;
1593
1594 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1595 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1596 const VkImageTiling image_tiling = pCreateInfo->tiling;
1597 const VkFormat image_format = pCreateInfo->format;
1598
1599 if (image_format == VK_FORMAT_UNDEFINED) {
1600 // VU 01975 states format can't be undefined unless an android externalFormat
1601#ifdef VK_USE_PLATFORM_ANDROID_KHR
1602 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1603 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1604 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1605 if (it != ahb_ext_formats_map.end()) {
1606 tiling_features = it->second;
1607 }
1608 }
1609#endif
1610 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1611 uint64_t drm_format_modifier = 0;
1612 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1613 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1614 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1615 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1616
1617 if (drm_explicit != nullptr) {
1618 drm_format_modifier = drm_explicit->drmFormatModifier;
1619 } else {
1620 // VUID 02261 makes sure its only explict or implict in parameter checking
1621 assert(drm_implicit != nullptr);
1622 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1623 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1624 }
1625 }
1626
1627 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1628 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1629 nullptr};
1630 format_properties_2.pNext = (void *)&drm_properties_list;
1631 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001632 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1633 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1634 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1635 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001636
1637 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1638 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1639 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1640 }
1641 }
1642 } else {
1643 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1644 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1645 : format_properties.optimalTilingFeatures;
1646 }
1647
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001648 // Lack of disjoint format feature support while using the flag
1649 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1650 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1651 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1652 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1653 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1654 string_VkFormat(pCreateInfo->format));
1655 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001656
1657 return skip;
1658}
1659
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001660bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001661 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001662 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001663
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001664 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001665 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001666 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1667 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001668 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1669 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001670 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001671 }
1672
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001673 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1674 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001675 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1676 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1677 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001678 }
1679
1680 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001681 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1682 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1683 "height (%d) and arrayLayers (%d) must be >= 6.",
1684 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001685 }
Dave Houlton130c0212018-01-29 13:39:56 -07001686 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001687
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001688 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001689 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1690 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1691 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001692 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1693 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1694 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001695 }
1696
1697 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001698 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1699 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1700 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001701 }
1702
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001703 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001704 uint32_t ceiling_width =
1705 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1706 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1707 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1708 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001709 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1710 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1711 "ceiling of device "
1712 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1713 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1714 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001715 }
1716
1717 uint32_t ceiling_height =
1718 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1719 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1720 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1721 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001722 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1723 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1724 "ceiling of device "
1725 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1726 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1727 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001728 }
1729 }
1730
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001731 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001732 VkResult result = VK_SUCCESS;
1733 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1734 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1735 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1736 &format_limits);
1737 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001738 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1739 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1740 if (modifier_list) {
1741 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1742 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1743 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1744 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1745 image_format_info.type = pCreateInfo->imageType;
1746 image_format_info.format = pCreateInfo->format;
1747 image_format_info.tiling = pCreateInfo->tiling;
1748 image_format_info.usage = pCreateInfo->usage;
1749 image_format_info.flags = pCreateInfo->flags;
1750 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1751
1752 result =
1753 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1754 format_limits = image_format_properties.imageFormatProperties;
1755
1756 /* The application gives a list of modifier and the driver
1757 * selects one. If one is wrong, stop there.
1758 */
1759 if (result != VK_SUCCESS) break;
1760 }
1761 } else if (explicit_modifier) {
1762 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1763 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1764 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1765 image_format_info.type = pCreateInfo->imageType;
1766 image_format_info.format = pCreateInfo->format;
1767 image_format_info.tiling = pCreateInfo->tiling;
1768 image_format_info.usage = pCreateInfo->usage;
1769 image_format_info.flags = pCreateInfo->flags;
1770 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1771
1772 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1773 format_limits = image_format_properties.imageFormatProperties;
1774 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001775 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001776
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001777 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1778 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1779 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1780 if (result != VK_SUCCESS) {
1781 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001782#ifdef VK_USE_PLATFORM_ANDROID_KHR
1783 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1784#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001785 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001786 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001787 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1788 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001789 } else {
1790 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1791 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001792 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1793 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1794 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001795 }
Dave Houlton130c0212018-01-29 13:39:56 -07001796
Dave Houltona585d132019-01-18 13:05:42 -07001797 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1798 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1799 (uint64_t)pCreateInfo->samples;
Mark Young0ec6b062020-11-19 15:32:17 -07001800 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count));
Dave Houlton130c0212018-01-29 13:39:56 -07001801
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001802 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001803 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001804 uint64_t ig_mask = imageGranularity - 1;
1805 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001806
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001807 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001808 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1809 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1810 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1811 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001812 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001813
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001814 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001815 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1816 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1817 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001818 }
1819
1820 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001821 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1822 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1823 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001824 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001825
1826 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1827 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1828 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1829 pCreateInfo->extent.width, format_limits.maxExtent.width);
1830 }
1831
1832 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1833 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1834 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1835 pCreateInfo->extent.height, format_limits.maxExtent.height);
1836 }
1837
1838 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1839 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1840 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1841 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1842 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001843 }
1844
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001845 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001846 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1847 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1848 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1849 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001850 skip |= LogError(device, error_vuid,
1851 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1852 "YCbCr Conversion format, arrayLayers must be 1",
1853 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001854 }
1855
1856 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001857 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1858 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1859 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001860 }
1861
1862 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001863 skip |= LogError(
1864 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001865 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1866 string_VkSampleCountFlagBits(pCreateInfo->samples));
1867 }
1868
1869 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001870 skip |= LogError(
1871 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001872 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1873 string_VkImageType(pCreateInfo->imageType));
1874 }
1875 }
1876
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001877 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001878 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001879 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001880 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001881 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1882 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1883 "format must be block, ETC or ASTC compressed, but is %s",
1884 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001885 }
1886 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001887 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1888 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1889 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001890 }
1891 }
1892 }
1893
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001894 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001895 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1896 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1897 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001898 }
1899
unknown2c877272019-07-11 12:56:50 -06001900 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1901 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1902 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001903 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1904 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1905 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001906 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001907
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001908 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1909 if (swapchain_create_info != nullptr) {
1910 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1911 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1912 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1913
1914 // Validate rest of Swapchain Image create check that require swapchain state
1915 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1916 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1917 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1918 skip |= LogError(
1919 device, vuid,
1920 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1921 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1922 }
1923 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1924 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1925 skip |= LogError(device, vuid,
1926 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1927 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1928 }
1929 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1930 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1931 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1932 skip |= LogError(device, vuid,
1933 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1934 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1935 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1936 }
1937 }
1938 }
1939
sfricke-samsungedce77a2020-07-03 22:35:13 -07001940 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1941 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1942 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1943 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1944 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1945 }
1946 const VkImageCreateFlags invalid_flags =
1947 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1948 if ((pCreateInfo->flags & invalid_flags) != 0) {
1949 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1950 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1951 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1952 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1953 }
1954 }
1955
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001956 skip |= ValidateImageFormatFeatures(pCreateInfo);
1957
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07001958 // Check compatibility with VK_KHR_portability_subset
1959 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
1960 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
1961 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
1962 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
1963 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
1964 }
1965 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
1966 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
1967 skip |=
1968 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
1969 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
1970 }
1971 }
1972
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001973 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001974}
1975
John Zulauf7eeb6f72019-06-17 11:56:36 -06001976void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1977 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1978 if (VK_SUCCESS != result) return;
1979
1980 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001981 auto image_state = Get<IMAGE_STATE>(*pImage);
1982 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001983}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001984
Jeff Bolz5c801d12019-10-09 10:38:45 -05001985bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001986 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001987 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001988 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001989 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001990 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001991 }
1992 return skip;
1993}
1994
John Zulauf7eeb6f72019-06-17 11:56:36 -06001995void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1996 // Clean up validation specific data
1997 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001998
locke-lunargcba7d5f2019-12-30 16:59:11 -07001999 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002000
2001 // Clean up generic image state
2002 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002003}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002004
sfricke-samsungcd924d92020-05-20 23:51:17 -07002005bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2006 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002007 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002008 const VkImage image = image_state->image;
2009 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002010
2011 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002012 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2013 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002014 }
2015
sfricke-samsungcd924d92020-05-20 23:51:17 -07002016 if (FormatIsDepthOrStencil(format)) {
2017 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2018 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2019 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2020 } else if (FormatIsCompressed(format)) {
2021 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2022 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2023 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002024 }
2025
2026 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002027 skip |=
2028 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2029 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2030 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002031 }
2032 return skip;
2033}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002034
John Zulauf07288512019-07-05 11:09:50 -06002035bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2036 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2037 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002038 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002039 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2040 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002041 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2042 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2043 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002044 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002045
2046 } else {
2047 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2048 if (!device_extensions.vk_khr_shared_presentable_image) {
2049 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002050 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2051 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2052 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002053 }
2054 } else {
2055 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2056 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002057 skip |= LogError(
2058 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002059 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2060 func_name, string_VkImageLayout(dest_image_layout));
2061 }
2062 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002063 }
2064
John Zulauff660ad62019-03-23 07:16:05 -06002065 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002066 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002067 if (subresource_map) {
2068 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002069 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002070 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002071 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2072 // the next "constant value" range
2073 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002074 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002075 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2076 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2077 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2078 } else {
2079 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002080 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002081 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2082 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2083 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2084 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002085 }
John Zulauf5e617452019-11-19 14:44:16 -07002086 }
John Zulauff660ad62019-03-23 07:16:05 -06002087 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002088 }
2089
2090 return skip;
2091}
2092
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002093bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2094 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002095 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002096 bool skip = false;
2097 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002098 const auto *cb_node = GetCBState(commandBuffer);
2099 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002100 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002101 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002102 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002103 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002104 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002105 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002106 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2107 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002108 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002109 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002110 skip |=
2111 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2112 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2113 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002114 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002115 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002116 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002117 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002118 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002119 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002120 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2121 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2122 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2123 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2124 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2125 string_VkFormat(image_state->createInfo.format));
2126 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002127 }
2128 return skip;
2129}
2130
John Zulaufeabb4462019-07-05 14:13:03 -06002131void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2132 const VkClearColorValue *pColor, uint32_t rangeCount,
2133 const VkImageSubresourceRange *pRanges) {
2134 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2135
2136 auto cb_node = GetCBState(commandBuffer);
2137 auto image_state = GetImageState(image);
2138 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002139 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002140 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002141 }
2142 }
2143}
2144
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002145bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2146 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002147 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002148 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002149
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002150 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002151 const auto *cb_node = GetCBState(commandBuffer);
2152 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002153 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002154 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002155 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002156 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002157 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002158 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002159 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002160 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002161 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002162 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002163 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002164 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002165 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2166 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2167 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2168 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002169
2170 bool any_include_aspect_depth_bit = false;
2171 bool any_include_aspect_stencil_bit = false;
2172
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002173 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002174 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002175 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002176 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002177 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002178 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2179 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002180 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2181 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2182 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2183 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002184 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002185 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2186 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002187 if (FormatHasDepth(image_format) == false) {
2188 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2189 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2190 "doesn't have a depth component.",
2191 i, string_VkFormat(image_format));
2192 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002193 }
2194 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2195 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002196 if (FormatHasStencil(image_format) == false) {
2197 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2198 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2199 "%s doesn't have a stencil component.",
2200 i, string_VkFormat(image_format));
2201 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002202 }
2203 }
2204 if (any_include_aspect_stencil_bit) {
2205 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2206 if (image_stencil_struct != nullptr) {
2207 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2208 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002209 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2210 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2211 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2212 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002213 }
2214 } else {
2215 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002216 skip |= LogError(
2217 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002218 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2219 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2220 "in VkImageCreateInfo::usage used to create image");
2221 }
2222 }
2223 }
2224 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002225 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2226 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2227 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002228 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002229 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002230 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2231 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002232 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002233 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002234 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002235 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2236 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2237 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2238 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002239 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002240 }
2241 return skip;
2242}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002243
John Zulaufeabb4462019-07-05 14:13:03 -06002244void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2245 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2246 const VkImageSubresourceRange *pRanges) {
2247 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2248 auto cb_node = GetCBState(commandBuffer);
2249 auto image_state = GetImageState(image);
2250 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002251 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002252 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002253 }
2254 }
2255}
2256
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002257// Returns true if [x, xoffset] and [y, yoffset] overlap
2258static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2259 bool result = false;
2260 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2261 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2262
2263 if (intersection_max > intersection_min) {
2264 result = true;
2265 }
2266 return result;
2267}
2268
Jeff Leger178b1e52020-10-05 12:22:23 -04002269// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002270// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002271template <typename RegionType>
2272static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002273 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002274
Dave Houltonc991cc92018-03-06 11:08:51 -07002275 // Separate planes within a multiplane image cannot intersect
2276 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002277 return result;
2278 }
2279
Dave Houltonc991cc92018-03-06 11:08:51 -07002280 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2281 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2282 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002283 result = true;
2284 switch (type) {
2285 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002286 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002287 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002288 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002289 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002290 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002291 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002292 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002293 break;
2294 default:
2295 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2296 assert(false);
2297 }
2298 }
2299 return result;
2300}
2301
Dave Houltonfc1a4052017-04-27 14:32:45 -06002302// Returns non-zero if offset and extent exceed image extents
2303static const uint32_t x_bit = 1;
2304static const uint32_t y_bit = 2;
2305static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002306static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002307 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002308 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002309 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2310 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002311 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002312 }
2313 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2314 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002315 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002316 }
2317 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2318 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002319 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002320 }
2321 return result;
2322}
2323
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002324// Test if two VkExtent3D structs are equivalent
2325static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2326 bool result = true;
2327 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2328 (extent->depth != other_extent->depth)) {
2329 result = false;
2330 }
2331 return result;
2332}
2333
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002334// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002335static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002336 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2337}
2338
2339// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002340VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002341 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2342 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002343 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002344 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002345 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002346 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002347 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002348 granularity.width *= block_size.width;
2349 granularity.height *= block_size.height;
2350 }
2351 }
2352 return granularity;
2353}
2354
2355// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2356static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2357 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002358 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2359 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002360 valid = false;
2361 }
2362 return valid;
2363}
2364
2365// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002366bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002367 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002368 bool skip = false;
2369 VkExtent3D offset_extent = {};
2370 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2371 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2372 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002373 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002374 // 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 -07002375 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002376 skip |= LogError(cb_node->commandBuffer, vuid,
2377 "%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 "
2378 "image transfer granularity is (w=0, h=0, d=0).",
2379 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002380 }
2381 } else {
2382 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2383 // integer multiples of the image transfer granularity.
2384 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002385 skip |= LogError(cb_node->commandBuffer, vuid,
2386 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2387 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2388 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2389 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002390 }
2391 }
2392 return skip;
2393}
2394
2395// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002396bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002397 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002398 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002399 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002400 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002401 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2402 // subresource extent.
2403 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002404 skip |= LogError(cb_node->commandBuffer, vuid,
2405 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2406 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2407 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2408 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002409 }
2410 } else {
2411 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2412 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2413 // subresource extent dimensions.
2414 VkExtent3D offset_extent_sum = {};
2415 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2416 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2417 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002418 bool x_ok = true;
2419 bool y_ok = true;
2420 bool z_ok = true;
2421 switch (image_type) {
2422 case VK_IMAGE_TYPE_3D:
2423 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2424 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002425 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002426 case VK_IMAGE_TYPE_2D:
2427 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2428 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002429 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002430 case VK_IMAGE_TYPE_1D:
2431 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2432 (subresource_extent->width == offset_extent_sum.width));
2433 break;
2434 default:
2435 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2436 assert(false);
2437 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002438 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002439 skip |=
2440 LogError(cb_node->commandBuffer, vuid,
2441 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2442 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2443 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2444 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2445 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2446 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002447 }
2448 }
2449 return skip;
2450}
2451
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002452bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002453 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002454 bool skip = false;
2455 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002456 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2457 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002458 }
2459 return skip;
2460}
2461
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002462bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002463 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002464 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002465 bool skip = false;
2466 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2467 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002468 skip |= LogError(cb_node->commandBuffer, vuid,
2469 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2470 "%u, but provided %s has %u array layers.",
2471 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2472 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002473 }
2474 return skip;
2475}
2476
Jeff Leger178b1e52020-10-05 12:22:23 -04002477// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2478template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002479bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002480 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002481 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002482 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002483 VkExtent3D granularity = GetScaledItg(cb_node, img);
2484 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002485 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002486 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002487 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002488 return skip;
2489}
2490
Jeff Leger178b1e52020-10-05 12:22:23 -04002491// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2492template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002493bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002494 const IMAGE_STATE *dst_img, const RegionType *region,
2495 const uint32_t i, const char *function,
2496 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002497 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002498 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2499 const char *vuid;
2500
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002501 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002502 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002503 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2504 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002505 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002506 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002507 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002508 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002509 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002510
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002511 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002512 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002513 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2514 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002515 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002516 const VkExtent3D dest_effective_extent =
2517 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002518 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002519 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002520 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002521 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002522 return skip;
2523}
2524
Jeff Leger178b1e52020-10-05 12:22:23 -04002525// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2526template <typename ImageCopyRegionType>
2527bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2528 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2529 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002530 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002531 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2532 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2533 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002534
2535 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002536 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002537
2538 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002539 const VkExtent3D src_copy_extent = region.extent;
2540 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002541 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2542
Dave Houlton6f9059e2017-05-02 17:15:13 -06002543 bool slice_override = false;
2544 uint32_t depth_slices = 0;
2545
2546 // Special case for copying between a 1D/2D array and a 3D image
2547 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2548 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002549 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002550 slice_override = (depth_slices != 1);
2551 } 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 -07002552 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002553 slice_override = (depth_slices != 1);
2554 }
2555
2556 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002557 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002558 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002559 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2560 skip |= LogError(src_state->image, vuid,
2561 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2562 "be 0 and 1, respectively.",
2563 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002564 }
2565 }
2566
Dave Houlton533be9f2018-03-26 17:08:30 -06002567 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 -04002568 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2569 skip |= LogError(src_state->image, vuid,
2570 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002571 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002572 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002573 }
2574
Dave Houlton533be9f2018-03-26 17:08:30 -06002575 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002576 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2577 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2578 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002579 }
2580
Dave Houltonc991cc92018-03-06 11:08:51 -07002581 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002582 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002583 if (FormatIsCompressed(src_state->createInfo.format) ||
2584 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002585 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002586 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002587 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2588 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2589 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002590 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002591 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002592 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002593 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002594 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002595 }
2596
Dave Houlton94a00372017-12-14 15:08:47 -07002597 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002598 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2599 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002600 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2601 skip |= LogError(src_state->image, vuid,
2602 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2603 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2604 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002605 }
2606
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002607 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002608 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2609 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002610 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2611 skip |= LogError(src_state->image, vuid,
2612 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2613 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2614 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002615 }
2616
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002617 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002618 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2619 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002620 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2621 skip |= LogError(src_state->image, vuid,
2622 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2623 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2624 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002625 }
2626 } // Compressed
2627
2628 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002629 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002630 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002631 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2632 skip |= LogError(dst_state->image, vuid,
2633 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002634 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002635 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002636 }
2637 }
2638
Dave Houlton533be9f2018-03-26 17:08:30 -06002639 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 -04002640 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2641 skip |= LogError(dst_state->image, vuid,
2642 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2643 "and 1, respectively.",
2644 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002645 }
2646
Dave Houlton533be9f2018-03-26 17:08:30 -06002647 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002648 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2649 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2650 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002651 }
2652
sfricke-samsung30b094c2020-05-30 11:42:11 -07002653 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002654 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002655 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2656 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002657 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2658 skip |= LogError(src_state->image, vuid,
2659 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2660 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2661 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002662 }
2663 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002664 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002665 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002666 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2667 skip |= LogError(dst_state->image, vuid,
2668 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2669 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2670 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002671 }
2672 }
2673 } else { // Pre maint 1
2674 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002675 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002676 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2677 skip |= LogError(src_state->image, vuid,
2678 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002679 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2680 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002681 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002682 }
Dave Houltonee281a52017-12-08 13:51:02 -07002683 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002684 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2685 skip |= LogError(dst_state->image, vuid,
2686 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002687 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2688 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002689 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002690 }
2691 }
2692 }
2693
Dave Houltonc991cc92018-03-06 11:08:51 -07002694 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2695 if (FormatIsCompressed(dst_state->createInfo.format) ||
2696 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002697 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002698
2699 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002700 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2701 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2702 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002703 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002704 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002705 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002706 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002707 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002708 }
2709
Dave Houlton94a00372017-12-14 15:08:47 -07002710 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002711 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2712 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002713 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2714 skip |= LogError(dst_state->image, vuid,
2715 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2716 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2717 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002718 }
2719
Dave Houltonee281a52017-12-08 13:51:02 -07002720 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2721 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2722 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002723 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002724 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002725 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002726 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2727 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002728 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002729 }
2730
Dave Houltonee281a52017-12-08 13:51:02 -07002731 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2732 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2733 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002734 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2735 skip |= LogError(dst_state->image, vuid,
2736 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2737 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2738 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002739 }
2740 } // Compressed
2741 }
2742 return skip;
2743}
2744
Jeff Leger178b1e52020-10-05 12:22:23 -04002745// vkCmdCopyImage / vmCmdCopyImage2KHR checks that only apply if the multiplane extension is enabled
2746template <typename RegionType>
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002747bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04002748 const IMAGE_STATE *dst_image_state, const RegionType region,
2749 CopyCommandVersion version) const {
2750 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Dave Houltonc991cc92018-03-06 11:08:51 -07002751 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002752
Jeff Leger178b1e52020-10-05 12:22:23 -04002753 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2754 const char *vuid;
2755
Dave Houltonc991cc92018-03-06 11:08:51 -07002756 // Neither image is multiplane
2757 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2758 // If neither image is multi-plane the aspectMask member of src and dst must match
2759 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2760 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002761 ss << func_name << ": Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002762 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Jeff Leger178b1e52020-10-05 12:22:23 -04002763 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2764 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002765 }
2766 } else {
2767 // Source image multiplane checks
2768 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2769 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2770 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2771 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002772 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2773 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2774 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002775 }
2776 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2777 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2778 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002779 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2780 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2781 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002782 }
2783 // Single-plane to multi-plane
2784 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2785 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2786 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002787 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2788 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2789 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002790 }
2791
2792 // Dest image multiplane checks
2793 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2794 aspect = region.dstSubresource.aspectMask;
2795 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2796 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002797 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2798 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2799 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002800 }
2801 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2802 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2803 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002804 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2805 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2806 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002807 }
2808 // Multi-plane to single-plane
2809 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2810 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2811 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002812 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2813 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2814 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002815 }
2816 }
2817
2818 return skip;
2819}
2820
Jeff Leger178b1e52020-10-05 12:22:23 -04002821template <typename RegionType>
2822bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2823 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2824 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002825 const auto *cb_node = GetCBState(commandBuffer);
2826 const auto *src_image_state = GetImageState(srcImage);
2827 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002828 const VkFormat src_format = src_image_state->createInfo.format;
2829 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002830 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002831 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002832
Jeff Leger178b1e52020-10-05 12:22:23 -04002833 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2834 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2835 const char *vuid;
2836
2837 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002838
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002839 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2840
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002841 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002842 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002843
2844 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2845 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002846 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002847
Dave Houlton6f9059e2017-05-02 17:15:13 -06002848 bool slice_override = false;
2849 uint32_t depth_slices = 0;
2850
2851 // Special case for copying between a 1D/2D array and a 3D image
2852 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2853 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2854 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002855 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002856 slice_override = (depth_slices != 1);
2857 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2858 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002859 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002860 slice_override = (depth_slices != 1);
2861 }
2862
Jeff Leger178b1e52020-10-05 12:22:23 -04002863 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2864 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2865 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2866 skip |=
2867 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2868 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2869 skip |=
2870 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2871 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002872 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002873 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2874 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002875 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002876 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002877
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002878 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002879 // No chance of mismatch if we're overriding depth slice count
2880 if (!slice_override) {
2881 // The number of depth slices in srcSubresource and dstSubresource must match
2882 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2883 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002884 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2885 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002886 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002887 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2888 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002889 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002890 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2891 skip |= LogError(command_buffer, vuid,
2892 "%s: number of depth slices in source and destination subresources for "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002893 "pRegions[%u] do not match.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002894 func_name, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002895 }
2896 }
2897 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002898 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002899 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002900 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
2901 skip |= LogError(command_buffer, vuid,
2902 "%s: number of layers in source and destination subresources for pRegions[%u] do not match",
2903 func_name, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002904 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002905 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002906
Dave Houltonc991cc92018-03-06 11:08:51 -07002907 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002908 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002909 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region, version);
Dave Houltonc991cc92018-03-06 11:08:51 -07002910 }
2911
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002912 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002913 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2914 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002915 std::stringstream ss;
2916 ss << func_name << ": Src and dest aspectMasks for each region must match";
2917 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
2918 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonf5217612018-02-02 16:18:52 -07002919 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002920 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002921
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002922 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002923 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002924 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002925 ss << func_name << ": pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002926 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Jeff Leger178b1e52020-10-05 12:22:23 -04002927 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
2928 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002929 }
2930
2931 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002932 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002933 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002934 ss << func_name << ": pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2935 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
2936 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002937 }
2938
Dave Houltonfc1a4052017-04-27 14:32:45 -06002939 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002940 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2941 if (slice_override) src_copy_extent.depth = depth_slices;
2942 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002943 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002944 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
2945 skip |= LogError(command_buffer, vuid,
2946 "%s: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2947 "width [%1d].",
2948 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002949 }
2950
2951 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002952 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
2953 skip |= LogError(command_buffer, vuid,
2954 "%s: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2955 "height [%1d].",
2956 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002957 }
2958 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002959 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
2960 skip |= LogError(command_buffer, vuid,
2961 "%s: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2962 "depth [%1d].",
2963 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002964 }
2965
Dave Houltonee281a52017-12-08 13:51:02 -07002966 // Adjust dest extent if necessary
2967 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2968 if (slice_override) dst_copy_extent.depth = depth_slices;
2969
2970 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002971 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002972 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
2973 skip |= LogError(command_buffer, vuid,
2974 "%s: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002975 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002976 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002977 }
2978 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002979 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
2980 skip |= LogError(command_buffer, vuid,
2981 "%s): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002982 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002983 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002984 }
2985 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002986 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
2987 skip |= LogError(command_buffer, vuid,
2988 "%s: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002989 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002990 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002991 }
2992
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002993 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2994 // must not overlap in memory
2995 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002996 for (uint32_t j = 0; j < regionCount; j++) {
2997 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002998 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002999 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003000 ss << func_name << ": pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
3001 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
3002 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003003 }
3004 }
3005 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003006
3007 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3008 if (device_extensions.vk_khr_maintenance1) {
3009 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3010 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3011 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003012 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3013 skip |= LogError(command_buffer, vuid,
3014 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3015 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003016 }
3017 } else {
3018 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3019 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3020 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003021 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3022 skip |= LogError(command_buffer, vuid,
3023 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3024 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003025 }
3026 }
3027
3028 // Check if 2D with 3D and depth not equal to 2D layerCount
3029 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3030 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3031 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003032 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3033 skip |= LogError(command_buffer, vuid,
3034 "%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 -08003035 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003036 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003037 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3038 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3039 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003040 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3041 skip |= LogError(command_buffer, vuid,
3042 "%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 -08003043 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003044 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003045 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003046
3047 // Check for multi-plane format compatiblity
3048 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3049 size_t src_format_size = 0;
3050 size_t dst_format_size = 0;
3051 if (FormatIsMultiplane(src_format)) {
3052 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3053 src_format_size = FormatElementSize(planeFormat);
3054 } else {
3055 src_format_size = FormatElementSize(src_format);
3056 }
3057 if (FormatIsMultiplane(dst_format)) {
3058 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3059 dst_format_size = FormatElementSize(planeFormat);
3060 } else {
3061 dst_format_size = FormatElementSize(dst_format);
3062 }
3063 // If size is still zero, then format is invalid and will be caught in another VU
3064 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003065 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3066 skip |= LogError(command_buffer, vuid,
3067 "%s: pRegions[%u] called with non-compatible image formats. "
3068 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3069 func_name, i, string_VkFormat(src_format),
3070 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3071 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003072 }
3073 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003074 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003075
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003076 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3077 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3078 // because because both texels are 4 bytes in size.
3079 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003080 const char *compatible_vuid =
3081 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3082 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3083 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003084 // Depth/stencil formats must match exactly.
3085 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3086 if (src_format != dst_format) {
3087 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003088 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003089 string_VkFormat(src_format), string_VkFormat(dst_format));
3090 }
3091 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003092 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003093 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003094 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003095 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003096 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003097 FormatElementSize(dst_format));
3098 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003099 }
3100 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003101
Dave Houlton33c22b72017-02-28 13:16:02 -07003102 // Source and dest image sample counts must match
3103 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003104 std::stringstream ss;
3105 ss << func_name << " called on image pair with non-identical sample counts.";
3106 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
3107 skip |= LogError(command_buffer, vuid, "%s", ss.str().c_str());
Dave Houlton33c22b72017-02-28 13:16:02 -07003108 }
3109
Jeff Leger178b1e52020-10-05 12:22:23 -04003110 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127";
3111 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3112 vuid = is_2khr ? "" : "";
3113 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003114 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003115 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3116 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3117 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3118 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3119 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3120 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3121 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3122 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3123 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3124 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3125 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3126 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003127
3128 // Validation for VK_EXT_fragment_density_map
3129 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003130 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3131 skip |=
3132 LogError(command_buffer, vuid,
3133 "%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 +02003134 }
3135 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003136 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3137 skip |=
3138 LogError(command_buffer, vuid,
3139 "%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 +02003140 }
3141
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003142 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003143 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3144 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3145 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3146 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003147 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003148 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3149 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3150 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3151 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3152 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003153 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003154
3155 const char *invalid_src_layout_vuid =
3156 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3157 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3158 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3159 const char *invalid_dst_layout_vuid =
3160 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3161 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3162 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3163
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003164 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003165 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003166 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003167 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3168 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003169 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003170 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003171 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003172 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003173 }
3174
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003175 return skip;
3176}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003177
Jeff Leger178b1e52020-10-05 12:22:23 -04003178bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3179 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3180 const VkImageCopy *pRegions) const {
3181 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3182 COPY_COMMAND_VERSION_1);
3183}
3184
3185bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3186 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3187 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3188 COPY_COMMAND_VERSION_2);
3189}
3190
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003191void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3192 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3193 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003194 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3195 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003196 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003197 auto src_image_state = GetImageState(srcImage);
3198 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003199
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003200 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003201 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003202 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3203 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003204 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003205}
3206
Jeff Leger178b1e52020-10-05 12:22:23 -04003207void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3208 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3209 auto cb_node = GetCBState(commandBuffer);
3210 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3211 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3212
3213 // Make sure that all image slices are updated to correct layout
3214 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3215 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3216 pCopyImageInfo->srcImageLayout);
3217 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3218 pCopyImageInfo->dstImageLayout);
3219 }
3220}
3221
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003222// Returns true if sub_rect is entirely contained within rect
3223static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3224 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3225 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3226 return false;
3227 return true;
3228}
3229
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003230bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003231 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003232 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3233 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003234 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003235 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3236 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003237 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003238 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003239
3240 for (uint32_t j = 0; j < rect_count; j++) {
3241 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003242 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3243 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3244 "the current render pass instance.",
3245 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003246 }
3247
3248 if (image_view_state) {
3249 // The layers specified by a given element of pRects must be contained within every attachment that
3250 // pAttachments refers to
3251 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3252 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3253 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003254 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3255 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3256 "of pAttachment[%d].",
3257 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003258 }
3259 }
3260 }
3261 return skip;
3262}
3263
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003264bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3265 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003266 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003267 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003268 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003269 if (!cb_node) return skip;
3270
3271 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3272 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3273 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003274 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003275
3276 // Validate that attachment is in reference list of active subpass
3277 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003278 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003279 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003280 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003281 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003282 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003283
John Zulauf3a548ef2019-02-01 16:14:07 -07003284 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3285 auto clear_desc = &pAttachments[attachment_index];
3286 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003287 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003288
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003289 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3290 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3291 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3292 attachment_index);
3293 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3294 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3295 skip |=
3296 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3297 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3298 attachment_index);
3299 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003300 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3301 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3302 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3303 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003304 skip |= LogError(
3305 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3306 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3307 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3308 attachment_index, clear_desc->colorAttachment,
3309 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3310 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003311
John Zulauff2582972019-02-09 14:53:30 -07003312 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3313 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003314 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003315 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3316 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3317 " subpass %u. colorAttachmentCount=%u",
3318 attachment_index, clear_desc->colorAttachment,
3319 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3320 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003321 }
John Zulauff2582972019-02-09 14:53:30 -07003322 fb_attachment = color_attachment;
3323
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003324 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3325 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3326 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3327 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3328 "of a color attachment.",
3329 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003330 }
3331 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003332 bool subpass_depth = false;
3333 bool subpass_stencil = false;
3334 if (subpass_desc->pDepthStencilAttachment &&
3335 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3336 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3337 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3338 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3339 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003340 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003341 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3342 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003343 skip |= LogError(
3344 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3345 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003346 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003347 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003348 }
3349 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003350 skip |= LogError(
3351 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3352 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003353 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003354 attachment_index);
3355 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003356 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003357 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003358 }
3359 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003360 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003361 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3362 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003363 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003364
3365 // Once the framebuffer attachment is found, can get the image view state
3366 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3367 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3368 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003369 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003370 if (image_view_state != nullptr) {
3371 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3372 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3373 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3374 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3375 }
3376 }
John Zulauf441558b2019-08-12 11:47:39 -06003377 }
3378 }
3379 return skip;
3380}
3381
3382void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3383 const VkClearAttachment *pAttachments, uint32_t rectCount,
3384 const VkClearRect *pRects) {
3385 auto *cb_node = GetCBState(commandBuffer);
3386 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3387 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3388 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3389 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3390 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3391 const auto clear_desc = &pAttachments[attachment_index];
3392 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3393 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3394 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3395 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3396 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3397 subpass_desc->pDepthStencilAttachment) {
3398 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3399 }
3400 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003401 if (!clear_rect_copy) {
3402 // We need a copy of the clear rectangles that will persist until the last lambda executes
3403 // but we want to create it as lazily as possible
3404 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003405 }
John Zulauf441558b2019-08-12 11:47:39 -06003406 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3407 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003408 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003409 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003410 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003411 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3412 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003413 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003414 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003415 return skip;
3416 };
3417 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003418 }
3419 }
3420 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003421}
3422
Jeff Leger178b1e52020-10-05 12:22:23 -04003423template <typename RegionType>
3424bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3425 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3426 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003427 const auto *cb_node = GetCBState(commandBuffer);
3428 const auto *src_image_state = GetImageState(srcImage);
3429 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003430 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3431 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3432 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3433 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003434
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003435 bool skip = false;
3436 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003437 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3438 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3439 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3440 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3441 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3442 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3443 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3444 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3445 skip |= InsideRenderPass(cb_node, func_name, vuid);
3446 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3447 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3448 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3449 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3450 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3451 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3452 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3453 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003454
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003455 // Validation for VK_EXT_fragment_density_map
3456 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003457 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3458 skip |= LogError(cb_node->commandBuffer, vuid,
3459 "%s: srcImage must not have been created with flags containing "
3460 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3461 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003462 }
3463 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003464 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3465 skip |= LogError(cb_node->commandBuffer, vuid,
3466 "%s: dstImage must not have been created with flags containing "
3467 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3468 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003469 }
3470
Cort Stratton7df30962018-05-17 19:45:57 -07003471 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003472 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003473 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3474 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003475 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003476 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3477 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3478 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003479 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003480 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3481 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3482 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3483 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3484 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3485 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003486 // For each region, the number of layers in the image subresource should not be zero
3487 // For each region, src and dest image aspect must be color only
3488 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003489 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003490 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3491 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003492 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3493 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3494 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003495 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003496 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3497 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003498 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003499 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3500 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3501 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3502 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3503 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3504 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003505 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003506 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3507 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003508 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003509 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003510
3511 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003512 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003513 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3514 skip |=
3515 LogError(cb_node->commandBuffer, vuid,
3516 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003517 }
Cort Stratton7df30962018-05-17 19:45:57 -07003518 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003519 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3520 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003521 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3522 skip |= LogError(cb_node->commandBuffer, vuid,
3523 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3524 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003525 }
3526
3527 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3528 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3529
3530 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003531 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003532 LogObjectList objlist(cb_node->commandBuffer);
3533 objlist.add(src_image_state->image);
3534 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003535 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3536 skip |= LogError(objlist, vuid,
3537 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003538 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003539 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003540 }
3541 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3542 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-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3546 skip |= LogError(objlist, vuid,
3547 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003548 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003549 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003550 }
3551 }
3552
3553 if (VK_IMAGE_TYPE_1D == src_image_type) {
3554 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3555 LogObjectList objlist(cb_node->commandBuffer);
3556 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003557 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3558 skip |= LogError(objlist, vuid,
3559 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003560 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003561 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3562 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003563 }
3564 }
3565 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3566 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3567 LogObjectList objlist(cb_node->commandBuffer);
3568 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003569 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3570 skip |= LogError(objlist, vuid,
3571 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003572 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003573 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3574 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003575 }
3576 }
3577
3578 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3579 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3580 LogObjectList objlist(cb_node->commandBuffer);
3581 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003582 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3583 skip |= LogError(objlist, vuid,
3584 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003585 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003586 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3587 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003588 }
3589 }
3590 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3591 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3592 LogObjectList objlist(cb_node->commandBuffer);
3593 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003594 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3595 skip |= LogError(objlist, vuid,
3596 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003597 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003598 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3599 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003600 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003601 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003602
3603 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3604 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3605 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3606 // developer
3607 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3608 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3609 if ((extent_check & x_bit) != 0) {
3610 LogObjectList objlist(cb_node->commandBuffer);
3611 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003612 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3613 skip |= LogError(objlist, vuid,
3614 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003615 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003616 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003617 region.extent.width, subresource_extent.width);
3618 }
3619
3620 if ((extent_check & y_bit) != 0) {
3621 LogObjectList objlist(cb_node->commandBuffer);
3622 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003623 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3624 skip |= LogError(objlist, vuid,
3625 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003626 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003627 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003628 region.extent.height, subresource_extent.height);
3629 }
3630
3631 if ((extent_check & z_bit) != 0) {
3632 LogObjectList objlist(cb_node->commandBuffer);
3633 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003634 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3635 skip |= LogError(objlist, vuid,
3636 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003637 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003638 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003639 region.extent.depth, subresource_extent.depth);
3640 }
3641 }
3642
3643 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3644 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3645 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3646 // developer
3647 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3648 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3649 if ((extent_check & x_bit) != 0) {
3650 LogObjectList objlist(cb_node->commandBuffer);
3651 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003652 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3653 skip |= LogError(objlist, vuid,
3654 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003655 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003656 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003657 region.extent.width, subresource_extent.width);
3658 }
3659
3660 if ((extent_check & y_bit) != 0) {
3661 LogObjectList objlist(cb_node->commandBuffer);
3662 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003663 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3664 skip |= LogError(objlist, vuid,
3665 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003666 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003667 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003668 region.extent.height, subresource_extent.height);
3669 }
3670
3671 if ((extent_check & z_bit) != 0) {
3672 LogObjectList objlist(cb_node->commandBuffer);
3673 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003674 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3675 skip |= LogError(objlist, vuid,
3676 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003677 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003678 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003679 region.extent.depth, subresource_extent.depth);
3680 }
3681 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003682 }
3683
3684 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003685 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3686 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3687 func_name, string_VkFormat(src_image_state->createInfo.format),
3688 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003689 }
3690 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003691 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003692 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003693 string_VkImageType(src_image_state->createInfo.imageType),
3694 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003695 }
3696 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003697 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3698 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 -07003699 }
3700 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003701 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3702 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3703 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003704 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003705 } else {
3706 assert(0);
3707 }
3708 return skip;
3709}
3710
Jeff Leger178b1e52020-10-05 12:22:23 -04003711bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3712 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3713 const VkImageResolve *pRegions) const {
3714 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3715 COPY_COMMAND_VERSION_1);
3716}
3717
3718bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3719 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3720 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3721 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3722 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3723}
3724
3725template <typename RegionType>
3726bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3727 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3728 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003729 const auto *cb_node = GetCBState(commandBuffer);
3730 const auto *src_image_state = GetImageState(srcImage);
3731 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003732
Jeff Leger178b1e52020-10-05 12:22:23 -04003733 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3734 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3735 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3736
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003737 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003738 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003739 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003740 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003741 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003742 const char *vuid;
3743 const char *location;
3744 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3745 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3746 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3747 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3748 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3749 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3750 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3751 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3752 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3753 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3754 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3755 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3756 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3757 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3758 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3759 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3760 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3761 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3762 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3763 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3764 skip |= InsideRenderPass(cb_node, func_name, vuid);
3765 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3766 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3767 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3768 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3769 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3770 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3771 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3772 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3773 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3774 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003775
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003776 // Validation for VK_EXT_fragment_density_map
3777 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003778 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3779 skip |= LogError(cb_node->commandBuffer, vuid,
3780 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3781 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003782 }
3783 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003784 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3785 skip |= LogError(cb_node->commandBuffer, vuid,
3786 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3787 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003788 }
3789
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003790 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003791
Dave Houlton33c2d252017-06-09 17:08:32 -06003792 VkFormat src_format = src_image_state->createInfo.format;
3793 VkFormat dst_format = dst_image_state->createInfo.format;
3794 VkImageType src_type = src_image_state->createInfo.imageType;
3795 VkImageType dst_type = dst_image_state->createInfo.imageType;
3796
Cort Stratton186b1a22018-05-01 20:18:06 -04003797 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003798 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3799 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3800 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003801 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003802 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003803 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003804 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003805 }
3806
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003807 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003808 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3809 skip |= LogError(device, vuid,
3810 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003811 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003812 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003813 }
3814
3815 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003816 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3817 skip |= LogError(device, vuid,
3818 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003819 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003820 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003821 }
3822
Dave Houlton33c2d252017-06-09 17:08:32 -06003823 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003824 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3825 skip |= LogError(cb_node->commandBuffer, vuid,
3826 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003827 }
3828
Dave Houlton33c2d252017-06-09 17:08:32 -06003829 // Validate consistency for unsigned formats
3830 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3831 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003832 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003833 << "the other one must also have unsigned integer format. "
3834 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003835 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3836 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003837 }
3838
3839 // Validate consistency for signed formats
3840 if (FormatIsSInt(src_format) != FormatIsSInt(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 signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003843 << "the other one must also have signed 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-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3846 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003847 }
3848
3849 // Validate filter for Depth/Stencil formats
3850 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3851 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003852 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003853 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003854 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3855 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003856 }
3857
3858 // Validate aspect bits and formats for depth/stencil images
3859 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3860 if (src_format != dst_format) {
3861 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003862 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 -06003863 << "stencil, the other one must have exactly the same format. "
3864 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3865 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003866 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3867 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003868 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003869 } // Depth or Stencil
3870
3871 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003872 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003873 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3874 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3875 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3876 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3877 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3878 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003879 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003880 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3881 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3882 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3883 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3884 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3885 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003886 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003887 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003888 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003889 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003890 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003891 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3892 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003893 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003894 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3895 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3896 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3897 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3898 skip |=
3899 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3900 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3901 skip |=
3902 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3903 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003904 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003905 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3906 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003907 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003908 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003909 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003910 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3911 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003912 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003913 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003914 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003915 }
Dave Houlton48989f32017-05-26 15:01:46 -06003916 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3917 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003918 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003919 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003920 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003921 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003922
3923 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003924 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003925 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
3926 skip |=
3927 LogError(cb_node->commandBuffer, vuid,
3928 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003929 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003930
Dave Houlton48989f32017-05-26 15:01:46 -06003931 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003932 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
3933 skip |=
3934 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003935 }
Dave Houlton48989f32017-05-26 15:01:46 -06003936
Dave Houlton33c2d252017-06-09 17:08:32 -06003937 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003938 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
3939 skip |= LogError(cb_node->commandBuffer, vuid,
3940 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003941 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003942 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003943 }
3944
3945 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003946 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
3947 skip |= LogError(cb_node->commandBuffer, vuid,
3948 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3949 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003950 }
3951
Dave Houlton48989f32017-05-26 15:01:46 -06003952 // Validate source image offsets
3953 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003954 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003955 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003956 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
3957 skip |= LogError(cb_node->commandBuffer, vuid,
3958 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3959 "of (%1d, %1d). These must be (0, 1).",
3960 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003961 }
3962 }
3963
Dave Houlton33c2d252017-06-09 17:08:32 -06003964 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003965 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003966 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
3967 skip |= LogError(cb_node->commandBuffer, vuid,
3968 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3969 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3970 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003971 }
3972 }
3973
Dave Houlton33c2d252017-06-09 17:08:32 -06003974 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003975 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3976 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003977 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003978 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
3979 skip |= LogError(cb_node->commandBuffer, vuid,
3980 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3981 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003982 }
3983 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3984 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003985 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003986 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
3987 skip |= LogError(cb_node->commandBuffer, vuid,
3988 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
3989 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003990 }
3991 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3992 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003993 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003994 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
3995 skip |= LogError(cb_node->commandBuffer, vuid,
3996 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3997 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003998 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003999 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004000 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4001 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4002 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004003 }
Dave Houlton48989f32017-05-26 15:01:46 -06004004
4005 // Validate dest image offsets
4006 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004007 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004008 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004009 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4010 skip |= LogError(cb_node->commandBuffer, vuid,
4011 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4012 "(%1d, %1d). These must be (0, 1).",
4013 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004014 }
4015 }
4016
Dave Houlton33c2d252017-06-09 17:08:32 -06004017 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004018 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004019 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4020 skip |= LogError(cb_node->commandBuffer, vuid,
4021 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004022 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004023 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004024 }
4025 }
4026
Dave Houlton33c2d252017-06-09 17:08:32 -06004027 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004028 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4029 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004030 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004031 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4032 skip |= LogError(cb_node->commandBuffer, vuid,
4033 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4034 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004035 }
4036 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4037 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004038 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004039 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4040 skip |= LogError(cb_node->commandBuffer, vuid,
4041 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4042 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004043 }
4044 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4045 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004046 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004047 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4048 skip |= LogError(cb_node->commandBuffer, vuid,
4049 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4050 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004051 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004052 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004053 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4054 skip |= LogError(cb_node->commandBuffer, vuid,
4055 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004056 }
4057
Dave Houlton33c2d252017-06-09 17:08:32 -06004058 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4059 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4060 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004061 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4062 skip |= LogError(cb_node->commandBuffer, vuid,
4063 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4064 "layerCount other than 1.",
4065 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004066 }
4067 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004068 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004069 } else {
4070 assert(0);
4071 }
4072 return skip;
4073}
4074
Jeff Leger178b1e52020-10-05 12:22:23 -04004075bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4076 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4077 const VkImageBlit *pRegions, VkFilter filter) const {
4078 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4079 COPY_COMMAND_VERSION_1);
4080}
4081
4082bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4083 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4084 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4085 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4086}
4087
4088template <typename RegionType>
4089void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4090 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4091 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004092 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004093 auto src_image_state = GetImageState(srcImage);
4094 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004095
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004096 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004097 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004098 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4099 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004100 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004101}
4102
Jeff Leger178b1e52020-10-05 12:22:23 -04004103void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4104 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4105 const VkImageBlit *pRegions, VkFilter filter) {
4106 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4107 pRegions, filter);
4108 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4109}
4110
4111void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4112 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4113 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4114 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4115 pBlitImageInfo->filter);
4116}
4117
John Zulauf2076e812020-01-08 14:55:54 -07004118GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4119 assert(map);
4120 // This approach allows for a single hash lookup or/create new
4121 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4122 if (inserted.second) {
4123 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004124 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004125 inserted.first->second.reset(layout_map);
4126 return layout_map;
4127 } else {
4128 assert(nullptr != inserted.first->second.get());
4129 return inserted.first->second.get();
4130 }
4131 return nullptr;
4132}
4133
4134const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4135 auto it = map.find(image);
4136 if (it != map.end()) {
4137 return it->second.get();
4138 }
4139 return nullptr;
4140}
4141
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004142// 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 -07004143bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4144 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004145 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004146 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07004147 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004148 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004149 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004150 for (const auto &layout_map_entry : pCB->image_layout_map) {
4151 const auto image = layout_map_entry.first;
4152 const auto *image_state = GetImageState(image);
4153 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004154 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004155 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004156 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004157 if (initial_layout_map.empty()) continue;
4158
4159 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
4160 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4161 if (global_map == nullptr) {
4162 global_map = &empty_map;
4163 }
4164
4165 // Note: don't know if it would matter
4166 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4167
4168 auto pos = initial_layout_map.begin();
4169 const auto end = initial_layout_map.end();
4170 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4171 pos->first.begin);
4172 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004173 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004174 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004175 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 -07004176 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004177 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004178 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004179 image_layout = current_layout->pos_B->lower_bound->second;
4180 }
4181 const auto intersected_range = pos->first & current_layout->range;
4182 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4183 // TODO: Set memory invalid which is in mem_tracker currently
4184 } else if (image_layout != initial_layout) {
4185 // Need to look up the inital layout *state* to get a bit more information
4186 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4187 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4188 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4189 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004190 // We can report all the errors for the intersected range directly
4191 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004192 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004193 skip |= LogError(
4194 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004195 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004196 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004197 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004198 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004199 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004200 }
4201 }
John Zulauf2076e812020-01-08 14:55:54 -07004202 if (pos->first.includes(intersected_range.end)) {
4203 current_layout.seek(intersected_range.end);
4204 } else {
4205 ++pos;
4206 if (pos != end) {
4207 current_layout.seek(pos->first.begin);
4208 }
4209 }
John Zulauff660ad62019-03-23 07:16:05 -06004210 }
4211
locke-lunargf155ccf2020-02-18 11:34:15 -07004212 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004213 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004214 }
John Zulauff660ad62019-03-23 07:16:05 -06004215
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004216 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004217}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004218
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004219void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004220 for (const auto &layout_map_entry : pCB->image_layout_map) {
4221 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004222 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004223 const auto *image_state = GetImageState(image);
4224 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004225 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4226 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004227 }
4228}
4229
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004230// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004231// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4232// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004233bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4234 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06004235 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004236 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004237 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4238
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004239 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004240 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4241 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004242 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004243 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4244 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4245 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004246 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004247 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004248 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004249 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4250 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4251 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004252 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004253 string_VkImageLayout(first_layout));
4254 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4255 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004256 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004257 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004258 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004259 }
4260 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004261
4262 // Same as above for loadOp, but for stencilLoadOp
4263 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4264 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4265 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4266 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4267 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004268 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004269 string_VkImageLayout(first_layout));
4270 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4271 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4272 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004273 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004274 string_VkImageLayout(first_layout));
4275 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4276 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4277 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004278 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004279 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004280 }
4281 }
4282
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004283 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004284}
4285
Mark Lobodzinski96210742017-02-09 10:33:46 -07004286// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4287// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004288template <typename T1>
4289bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4290 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4291 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004292 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004293 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004294 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004295 if (strict) {
4296 correct_usage = ((actual & desired) == desired);
4297 } else {
4298 correct_usage = ((actual & desired) != 0);
4299 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004300
Mark Lobodzinski96210742017-02-09 10:33:46 -07004301 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004302 // All callers should have a valid VUID
4303 assert(msgCode != kVUIDUndefined);
4304 skip =
4305 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4306 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004307 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004308 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004309}
4310
4311// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4312// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004313bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004314 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004315 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004316 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004317}
4318
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004319bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004320 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004321 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004322 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4323 if ((image_format_features & desired) != desired) {
4324 // Same error, but more details if it was an AHB external format
4325 if (image_state->has_ahb_format == true) {
4326 skip |= LogError(image_state->image, vuid,
4327 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4328 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4329 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004330 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004331 } else {
4332 skip |= LogError(image_state->image, vuid,
4333 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4334 "with tiling %s.",
4335 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4336 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4337 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004338 }
4339 }
4340 return skip;
4341}
4342
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004343bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004344 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004345 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004346 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004347 // layerCount must not be zero
4348 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004349 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4350 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004351 }
4352 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004353 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004354 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4355 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004356 }
4357 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004358 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 -07004359 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4360 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4361 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4362 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004363 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004364 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4365 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4366 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4367 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4368 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4369 member);
4370 }
Cort Strattond619a302018-05-17 19:46:32 -07004371 return skip;
4372}
4373
Mark Lobodzinski96210742017-02-09 10:33:46 -07004374// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4375// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004376bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004377 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004378 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004379 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004380}
4381
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004382bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004383 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004384 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004385
4386 const VkDeviceSize &range = pCreateInfo->range;
4387 if (range != VK_WHOLE_SIZE) {
4388 // Range must be greater than 0
4389 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004390 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004391 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004392 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4393 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004394 }
4395 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004396 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4397 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004398 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004399 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004400 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4401 "(%" PRIu32 ").",
4402 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004403 }
4404 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004405 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004406 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004407 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004408 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4409 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4410 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004411 }
4412 // The sum of range and offset must be less than or equal to the size of buffer
4413 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004414 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004415 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004416 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4417 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4418 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004419 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004420 } else {
4421 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4422
4423 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4424 // VkPhysicalDeviceLimits::maxTexelBufferElements
4425 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4426 device_limits->maxTexelBufferElements) {
4427 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4428 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4429 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4430 "), divided by the element size of the format (%" PRIu32
4431 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4432 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4433 device_limits->maxTexelBufferElements);
4434 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004435 }
4436 return skip;
4437}
4438
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004439bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004440 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004441 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004442 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4443 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004444 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004445 "vkCreateBufferView(): If buffer was created with `usage` containing "
4446 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004447 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004448 }
4449 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4450 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004451 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004452 "vkCreateBufferView(): If buffer was created with `usage` containing "
4453 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004454 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004455 }
4456 return skip;
4457}
4458
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004459bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004460 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004461 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004462
Dave Houltond8ed0212018-05-16 17:18:24 -06004463 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004464
Jeff Bolz87697532019-01-11 22:54:00 -06004465 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4466 if (chained_devaddr_struct) {
4467 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4468 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004469 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4470 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4471 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004472 }
4473 }
4474
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004475 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4476 if (chained_opaqueaddr_struct) {
4477 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4478 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004479 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4480 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4481 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004482 }
4483 }
4484
Shannon McPherson4984e642019-12-05 13:04:34 -07004485 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004486 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4487 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004488 skip |= LogError(
4489 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004490 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4491 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4492 }
4493
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004494 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004495 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4496 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4497 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004498 }
4499
sfricke-samsungedce77a2020-07-03 22:35:13 -07004500 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4501 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4502 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4503 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4504 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4505 }
4506 const VkBufferCreateFlags invalid_flags =
4507 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4508 if ((pCreateInfo->flags & invalid_flags) != 0) {
4509 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4510 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4511 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4512 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4513 }
4514 }
4515
Mark Lobodzinski96210742017-02-09 10:33:46 -07004516 return skip;
4517}
4518
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004519bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004520 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004521 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004522 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004523 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4524 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004525 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004526 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4527 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004528 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004529 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4530 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4531 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004532
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004533 // Buffer view offset must be less than the size of buffer
4534 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004535 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004536 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004537 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4538 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004539 }
4540
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004541 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004542 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4543 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4544 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004545 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4546 : "VUID-VkBufferViewCreateInfo-offset-00926";
4547 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004548 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004549 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4550 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004551 }
4552
4553 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4554 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4555 if ((elementSize % 3) == 0) {
4556 elementSize /= 3;
4557 }
4558 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4559 VkDeviceSize alignmentRequirement =
4560 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4561 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4562 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4563 }
4564 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004565 skip |= LogError(
4566 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004567 "vkCreateBufferView(): If buffer was created with usage containing "
4568 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004569 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4570 ") must be a multiple of the lesser of "
4571 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4572 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4573 "(%" PRId32
4574 ") is VK_TRUE, the size of a texel of the requested format. "
4575 "If the size of a texel is a multiple of three bytes, then the size of a "
4576 "single component of format is used instead",
4577 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4578 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4579 }
4580 }
4581 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4582 VkDeviceSize alignmentRequirement =
4583 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4584 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4585 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4586 }
4587 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004588 skip |= LogError(
4589 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004590 "vkCreateBufferView(): If buffer was created with usage containing "
4591 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004592 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4593 ") must be a multiple of the lesser of "
4594 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4595 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4596 "(%" PRId32
4597 ") is VK_TRUE, the size of a texel of the requested format. "
4598 "If the size of a texel is a multiple of three bytes, then the size of a "
4599 "single component of format is used instead",
4600 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4601 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4602 }
4603 }
4604 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004605
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004606 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004607
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004608 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004609 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004610 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004611}
4612
Mark Lobodzinski602de982017-02-09 11:01:33 -07004613// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004614bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004615 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004616 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004617 const IMAGE_STATE *image_state = GetImageState(image);
4618 // checks color format and (single-plane or non-disjoint)
4619 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004620 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004621 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004622 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 -07004623 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004624 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 -07004625 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004626 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004627 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004628 skip |= LogError(image, vuid,
4629 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4630 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4631 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004632 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004633 skip |= LogError(image, vuid,
4634 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4635 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4636 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004637 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004638 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004639 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004640 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 -07004641 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004642 skip |=
4643 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 -07004644 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004645 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004646 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004647 skip |=
4648 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 -07004649 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004650 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4651 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004652 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004653 } else if (FormatIsMultiplane(format)) {
4654 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4655 if (3 == FormatPlaneCount(format)) {
4656 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4657 }
4658 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004659 skip |=
4660 LogError(image, vuid,
4661 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4662 "set, where n = [0, 1, 2].",
4663 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004664 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004665 }
4666 return skip;
4667}
4668
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004669bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4670 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004671 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4672 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004673 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004674
4675 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004676 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004677 skip |= LogError(image, errorCodes.base_mip_err,
4678 "%s: %s.baseMipLevel (= %" PRIu32
4679 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4680 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004681 }
Petr Kraus4d718682017-05-18 03:38:41 +02004682
Petr Krausffa94af2017-08-08 21:46:02 +02004683 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4684 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004685 skip |=
4686 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004687 } else {
4688 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004689
Petr Krausffa94af2017-08-08 21:46:02 +02004690 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004691 skip |= LogError(image, errorCodes.mip_count_err,
4692 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4693 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4694 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4695 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004696 }
Petr Kraus4d718682017-05-18 03:38:41 +02004697 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004698 }
Petr Kraus4d718682017-05-18 03:38:41 +02004699
4700 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004701 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004702 skip |= LogError(image, errorCodes.base_layer_err,
4703 "%s: %s.baseArrayLayer (= %" PRIu32
4704 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4705 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004706 }
Petr Kraus4d718682017-05-18 03:38:41 +02004707
Petr Krausffa94af2017-08-08 21:46:02 +02004708 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4709 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004710 skip |=
4711 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004712 } else {
4713 const uint64_t necessary_layer_count =
4714 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004715
Petr Krausffa94af2017-08-08 21:46:02 +02004716 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004717 skip |= LogError(image, errorCodes.layer_count_err,
4718 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4719 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4720 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4721 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004722 }
Petr Kraus4d718682017-05-18 03:38:41 +02004723 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004724 }
Petr Kraus4d718682017-05-18 03:38:41 +02004725
Mark Lobodzinski602de982017-02-09 11:01:33 -07004726 return skip;
4727}
4728
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004729bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004730 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004731 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004732 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4733 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4734 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4735
4736 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4737 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4738
4739 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004740 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4741 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004742 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004743 : "VUID-VkImageViewCreateInfo-image-01482")
4744 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4745 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004746 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004747 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4748 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004749
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004750 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004751 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004752 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004753}
4754
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004755bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004756 const VkImageSubresourceRange &subresourceRange,
4757 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004758 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004759 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4760 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4761 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4762 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004763
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004764 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004765 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004766 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004767}
4768
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004769bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004770 const VkImageSubresourceRange &subresourceRange,
4771 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004772 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004773 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4774 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4775 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4776 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004777
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004778 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004779 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4780 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004781}
4782
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004783bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004784 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004785 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004786 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004787 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4788 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4789 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4790 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004791
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004792 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004793 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004794}
4795
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004796bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4797 const VkImageUsageFlags image_usage) const {
4798 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4799 bool skip = false;
4800
4801 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4802 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4803
4804 if (image_state->has_ahb_format == true) {
4805 // AHB image view and image share same feature sets
4806 tiling_features = image_state->format_features;
4807 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4808 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4809 assert(device_extensions.vk_ext_image_drm_format_modifier);
4810 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4811 nullptr};
4812 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4813
4814 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4815 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4816 nullptr};
4817 format_properties_2.pNext = (void *)&drm_properties_list;
4818 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4819
4820 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4821 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4822 0) {
4823 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4824 }
4825 }
4826 } else {
4827 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4828 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4829 : format_properties.optimalTilingFeatures;
4830 }
4831
4832 if (tiling_features == 0) {
4833 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4834 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4835 "physical device.",
4836 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4837 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4838 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4839 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4840 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4841 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4842 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4843 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4844 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4845 "VK_IMAGE_USAGE_STORAGE_BIT.",
4846 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4847 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4848 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4849 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4850 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4851 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4852 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4853 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4854 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4855 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4856 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4857 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4858 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4859 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4860 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4861 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4862 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4863 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00004864 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
4865 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
4866 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
4867 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-04550",
4868 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4869 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
4870 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4871 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004872 }
4873
4874 return skip;
4875}
4876
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004877bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004878 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004879 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004880 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004881 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004882 skip |=
4883 ValidateImageUsageFlags(image_state,
4884 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4885 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004886 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4887 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4888 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004889 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004890 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004891 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004892 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004893 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004894 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004895 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004896 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004897
4898 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4899 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004900 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004901 VkFormat view_format = pCreateInfo->format;
4902 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004903 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004904 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004905
Dave Houltonbd2e2622018-04-10 16:41:14 -06004906 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004907 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004908 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004909 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004910 if (!device_extensions.vk_ext_separate_stencil_usage) {
4911 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004912 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4913 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4914 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004915 }
4916 } else {
4917 const auto image_stencil_struct =
4918 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4919 if (image_stencil_struct == nullptr) {
4920 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004921 skip |= LogError(
4922 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004923 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4924 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4925 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4926 }
4927 } else {
4928 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4929 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4930 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004931 skip |= LogError(
4932 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004933 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4934 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4935 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4936 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4937 }
4938 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4939 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |= LogError(
4941 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004942 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4943 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4944 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4945 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4946 }
4947 }
4948 }
4949 }
4950
Dave Houltonbd2e2622018-04-10 16:41:14 -06004951 image_usage = chained_ivuci_struct->usage;
4952 }
4953
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004954 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4955 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004956 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004957 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004958 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004959 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004960 std::stringstream ss;
4961 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004962 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004963 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004964 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004965 }
4966 } else {
Nathaniel Cesario0046c312020-10-07 23:28:28 -06004967 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004968 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4969 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004970 const char *error_vuid;
4971 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4972 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4973 } else if ((device_extensions.vk_khr_maintenance2) &&
4974 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4975 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4976 } else if ((!device_extensions.vk_khr_maintenance2) &&
4977 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4978 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4979 } else {
4980 // both enabled
4981 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4982 }
Dave Houltonc7988072018-04-16 11:46:56 -06004983 std::stringstream ss;
4984 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004985 << " is not in the same format compatibility class as "
4986 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004987 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4988 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004989 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004990 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004991 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004992 }
4993 } else {
4994 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004995 // Unless it is a multi-planar color bit aspect
4996 if ((image_format != view_format) &&
4997 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4998 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4999 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005000 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005001 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005002 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005003 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005004 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005005 }
5006 }
5007
5008 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005009 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005010
5011 switch (image_type) {
5012 case VK_IMAGE_TYPE_1D:
5013 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005014 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5015 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5016 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005017 }
5018 break;
5019 case VK_IMAGE_TYPE_2D:
5020 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5021 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5022 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005023 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5024 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5025 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005026 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005027 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5028 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5029 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005030 }
5031 }
5032 break;
5033 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005034 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005035 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5036 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5037 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005038 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005039 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5040 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5041 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005042 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5043 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005044 skip |= LogError(
5045 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5046 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5047 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5048 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5049 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005050 }
5051 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005052 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5053 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5054 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005055 }
5056 }
5057 } else {
5058 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005059 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5060 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5061 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005062 }
5063 }
5064 break;
5065 default:
5066 break;
5067 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005068
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005069 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005070 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005071 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005072 }
5073
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005074 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005075
Tobias Hector6663c9b2020-11-05 10:18:02 +00005076 if (enabled_features.shading_rate_image.shadingRateImage) {
5077 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5078 if (view_format != VK_FORMAT_R8_UINT) {
5079 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5080 "vkCreateImageView() If image was created with usage containing "
5081 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5082 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005083 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005084 }
5085
5086 if (enabled_features.shading_rate_image.shadingRateImage ||
5087 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5088 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5089 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5090 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5091 "vkCreateImageView() If image was created with usage containing "
5092 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5093 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5094 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005095 }
5096 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005097
Tobias Hector6663c9b2020-11-05 10:18:02 +00005098 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5099 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5100 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5101 pCreateInfo->subresourceRange.layerCount != 1) {
5102 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5103 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5104 pCreateInfo->subresourceRange.layerCount);
5105 }
5106
Jeff Bolz99e3f632020-03-24 22:59:22 -05005107 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5108 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5109 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5110 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5111 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5112 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5113 }
5114 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5115 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5116 skip |= LogError(
5117 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5118 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5119 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5120 }
5121 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005122
5123 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5124 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005125 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005126 "vkCreateImageView(): If image was created with usage containing "
5127 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5128 pCreateInfo->subresourceRange.levelCount);
5129 }
5130 }
5131 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5132 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005133 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005134 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5135 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5136 }
5137 } else {
5138 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5139 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5140 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005141 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005142 "vkCreateImageView(): If image was created with usage containing "
5143 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5144 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5145 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5146 }
5147 }
5148 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005149
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005150 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5151 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5152 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5153 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5154 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5155 }
5156 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5157 skip |=
5158 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5159 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5160 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5161 }
5162 }
5163 if (device_extensions.vk_ext_fragment_density_map_2) {
5164 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5165 (pCreateInfo->subresourceRange.layerCount >
5166 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5167 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5168 "vkCreateImageView(): If image was created with flags containing "
5169 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5170 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5171 pCreateInfo->subresourceRange.layerCount,
5172 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5173 }
5174 }
5175
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005176 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5177 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5178 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5179 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5180 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5181 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5182 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5183 }
5184 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005185
5186 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5187 // If swizzling is disabled, make sure it isn't used
5188 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5189 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5190 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5191 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5192 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5193 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5194 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5195 }
5196
5197 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5198 // disabled
5199 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5200 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5201 // spec. See Github issue #2361.
5202 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5203 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5204 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5205 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5206 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5207 "vkCreateImageView (portability error): ImageView format must have"
5208 " the same number of components and bits per component as the Image's format");
5209 }
5210 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005211 }
5212 return skip;
5213}
5214
Jeff Leger178b1e52020-10-05 12:22:23 -04005215template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005216bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005217 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005218 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005219 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5220 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5221 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005222
5223 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5224 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5225 VkDeviceSize src_min = UINT64_MAX;
5226 VkDeviceSize src_max = 0;
5227 VkDeviceSize dst_min = UINT64_MAX;
5228 VkDeviceSize dst_max = 0;
5229
5230 for (uint32_t i = 0; i < regionCount; i++) {
5231 src_min = std::min(src_min, pRegions[i].srcOffset);
5232 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5233 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5234 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5235
5236 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5237 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005238 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5239 skip |= LogError(src_buffer_state->buffer, vuid,
5240 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5241 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005242 }
5243
5244 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5245 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005246 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5247 skip |= LogError(dst_buffer_state->buffer, vuid,
5248 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5249 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005250 }
5251
5252 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5253 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005254 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5255 skip |= LogError(src_buffer_state->buffer, vuid,
5256 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005257 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005258 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005259 }
5260
5261 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5262 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005263 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5264 skip |= LogError(dst_buffer_state->buffer, vuid,
5265 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005266 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005267 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005268 }
5269 }
5270
5271 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5272 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5273 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005274 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5275 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5276 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005277 }
5278 }
5279
5280 return skip;
5281}
5282
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005283bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005284 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005285 const auto cb_node = GetCBState(commandBuffer);
5286 const auto src_buffer_state = GetBufferState(srcBuffer);
5287 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005288
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005289 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005290 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5291 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005292 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005293 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005294 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5295 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005296 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005297 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5298 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005299 skip |=
5300 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5301 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005302 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5303 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005304 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005305 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5306 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5307 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005308 return skip;
5309}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005310
Jeff Leger178b1e52020-10-05 12:22:23 -04005311bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5312 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5313 const auto cb_node = GetCBState(commandBuffer);
5314 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5315 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5316
5317 bool skip = false;
5318 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5319 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5320 // Validate that SRC & DST buffers have correct usage flags set
5321 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5322 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5323 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5324 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5325 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5326 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5327 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5328 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5329 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5330 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5331 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5332 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5333 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5334 skip |=
5335 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5336 skip |=
5337 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5338 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5339 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5340 return skip;
5341}
5342
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005343bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005344 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005345 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005346 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005347 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005348 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5349 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005350 }
5351 }
5352 return skip;
5353}
5354
Jeff Bolz5c801d12019-10-09 10:38:45 -05005355bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5356 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005357 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005358 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005359
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005360 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005361 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005362 skip |=
5363 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005364 }
5365 return skip;
5366}
5367
Jeff Bolz5c801d12019-10-09 10:38:45 -05005368bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005369 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005370
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005371 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005372 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005373 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005374 }
5375 return skip;
5376}
5377
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005378bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005379 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005380 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005381 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005382 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005383 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005384 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005385 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005386 }
5387 return skip;
5388}
5389
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005390bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005391 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005392 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005393 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005394 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005395 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005396 skip |=
5397 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5398 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005399 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005400 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005401 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5402 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005403 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005404
sfricke-samsung022fa252020-07-24 03:26:16 -07005405 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5406 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5407
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005408 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005409 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5410 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5411 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5412 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005413 }
5414
5415 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005416 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5417 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5418 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5419 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005420 }
5421
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005422 return skip;
5423}
5424
Jeff Leger178b1e52020-10-05 12:22:23 -04005425template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005426bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005427 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005428 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005429 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005430 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5431 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005432
sfricke-samsung125d2b42020-05-28 06:32:43 -07005433 assert(image_state != nullptr);
5434 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005435
5436 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005437 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005438 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5439 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005440 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005441 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5442 "and 1, respectively.",
5443 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005444 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005445 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005446
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005447 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5448 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005449 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005450 "%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 -07005451 "must be 0 and 1, respectively.",
5452 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005453 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005454 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005455
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005456 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5457 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005458 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005459 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005460 "For 3D images these must be 0 and 1, respectively.",
5461 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005462 }
5463 }
5464
5465 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005466 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005467 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005468
sfricke-samsung125d2b42020-05-28 06:32:43 -07005469 // If not depth/stencil and not multi-plane
5470 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5471 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005472 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5473 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
5474 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005475 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005476 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005477 " must be a multiple of this format's texel size (%" PRIu32 ").",
5478 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005479 }
5480
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005481 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5482 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005483 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005484 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005485 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005486 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005487 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005488 }
5489
5490 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5491 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005492 vuid =
5493 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04005494 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005495 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005496 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5497 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005498 }
5499
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005500 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005501 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005502 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005503 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 -06005504 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5505 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005506 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005507 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005508 "zero or <= image subresource width (%d).",
5509 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005510 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005511 }
5512
5513 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005514 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 -06005515 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5516 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005517 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005518 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005519 "zero or <= image subresource height (%d).",
5520 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005521 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005522 }
5523
5524 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005525 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 -06005526 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5527 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005528 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005529 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005530 "zero or <= image subresource depth (%d).",
5531 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005532 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005533 }
5534
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005535 // subresource aspectMask must have exactly 1 bit set
5536 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005537 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005538 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005539 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5540 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005541 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005542 }
5543
5544 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005545 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005546 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005547 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005548 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5549 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005550 }
5551
5552 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005553 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5554 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005555
5556 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005557 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005558 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005559 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005560 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5561 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005562 }
5563
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005564 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005565 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005566 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005567 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005568 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005569 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005570 }
5571
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005572 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005573 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5574 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5575 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005576 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005577 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005578 "width & height (%d, %d)..",
5579 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5580 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005581 }
5582
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005583 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005584 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005585 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005586 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005587 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005588 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5589 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005590 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005591
5592 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005593 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005594 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005595 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005596 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005597 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005598 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5599 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5600 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005601 }
5602
5603 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005604 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005605 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005606 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005607 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005608 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5609 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5610 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005611 }
5612
5613 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005614 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005615 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005616 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005617 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005618 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5619 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5620 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005621 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005622 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005623
5624 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005625 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005626 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005627 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005628 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005629 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005630 "format has three planes.",
5631 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005632 }
5633
5634 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005635 if (0 ==
5636 (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 -07005637 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005638 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005639 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5640 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005641 } else {
5642 // Know aspect mask is valid
5643 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5644 const uint32_t compatible_size = FormatElementSize(compatible_format);
5645 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5646 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005647 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005648 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005649 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5650 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5651 string_VkFormat(compatible_format));
5652 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005653 }
5654 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005655 }
5656
5657 return skip;
5658}
5659
Jeff Leger178b1e52020-10-05 12:22:23 -04005660template <typename BufferImageCopyRegionType>
5661bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5662 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005663 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005664 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005665
5666 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005667 VkExtent3D extent = pRegions[i].imageExtent;
5668 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005669
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005670 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5671 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005672 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5673 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5674 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005675 }
5676
5677 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5678
5679 // 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 -06005680 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005681 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005682 if (image_extent.width % block_extent.width) {
5683 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5684 }
5685 if (image_extent.height % block_extent.height) {
5686 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5687 }
5688 if (image_extent.depth % block_extent.depth) {
5689 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5690 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005691 }
5692
Dave Houltonfc1a4052017-04-27 14:32:45 -06005693 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005694 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005695 }
5696 }
5697
5698 return skip;
5699}
5700
Jeff Leger178b1e52020-10-05 12:22:23 -04005701template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005702bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005703 const BufferImageCopyRegionType *pRegions, const char *func_name,
5704 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005705 bool skip = false;
5706
5707 VkDeviceSize buffer_size = buff_state->createInfo.size;
5708
5709 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005710 VkDeviceSize max_buffer_offset =
5711 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5712 if (buffer_size < max_buffer_offset) {
5713 skip |=
5714 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 -07005715 }
5716 }
5717
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005718 return skip;
5719}
5720
Jeff Leger178b1e52020-10-05 12:22:23 -04005721template <typename BufferImageCopyRegionType>
5722bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5723 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5724 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005725 const auto cb_node = GetCBState(commandBuffer);
5726 const auto src_image_state = GetImageState(srcImage);
5727 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005728
Jeff Leger178b1e52020-10-05 12:22:23 -04005729 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5730 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5731 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5732 const char *vuid;
5733
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005734 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005735
5736 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005737 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005738
5739 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005740 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005741
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005742 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005743
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005744 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005745 vuid =
5746 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5747 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5748 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5749 "or transfer capabilities.",
5750 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005751 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005752 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5753 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5754 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5755 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005756
Jeff Leger178b1e52020-10-05 12:22:23 -04005757 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5758 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5759 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5760
5761 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5762 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5763 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5764 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005765
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005766 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005767 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5768 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005769 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005770 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5771 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005772 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005773 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5774 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5775 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5776 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5777 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5778 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005779
5780 // Validation for VK_EXT_fragment_density_map
5781 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005782 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5783 skip |= LogError(cb_node->commandBuffer, vuid,
5784 "%s: srcImage must not have been created with flags containing "
5785 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5786 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005787 }
5788
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005789 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005790 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5791 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005792 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005793 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5794 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005795 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005796
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005797 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 -04005798 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5799 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5800 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5801 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5802
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005803 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005804 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5805 vuid =
5806 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005807 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005808 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5809 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5810 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5811 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5812 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5813 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5814 "imageSubresource", vuid);
5815 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5816 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005817 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005818 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005819 }
5820 return skip;
5821}
5822
Jeff Leger178b1e52020-10-05 12:22:23 -04005823bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5824 VkBuffer dstBuffer, uint32_t regionCount,
5825 const VkBufferImageCopy *pRegions) const {
5826 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5827 COPY_COMMAND_VERSION_1);
5828}
5829
5830bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5831 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5832 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5833 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5834 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5835}
5836
John Zulauf1686f232019-07-09 16:27:11 -06005837void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5838 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5839 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5840
5841 auto cb_node = GetCBState(commandBuffer);
5842 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005843 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005844 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005845 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005846 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005847}
5848
Jeff Leger178b1e52020-10-05 12:22:23 -04005849void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5850 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5851 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5852
5853 auto cb_node = GetCBState(commandBuffer);
5854 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5855 // Make sure that all image slices record referenced layout
5856 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5857 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5858 pCopyImageToBufferInfo->srcImageLayout);
5859 }
5860}
5861
5862template <typename RegionType>
5863bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5864 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5865 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005866 const auto cb_node = GetCBState(commandBuffer);
5867 const auto src_buffer_state = GetBufferState(srcBuffer);
5868 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005869
Jeff Leger178b1e52020-10-05 12:22:23 -04005870 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5871 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5872 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5873 const char *vuid;
5874
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005875 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005876
5877 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005878 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005879
sfricke-samsungea4fd142020-10-17 23:51:59 -07005880 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5881 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5882
Jeff Leger178b1e52020-10-05 12:22:23 -04005883 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5884 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5885 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5886 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5887
5888 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5889 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5890 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5891 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5892 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5893 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5894 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5895 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5896 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005897 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005898 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5899 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005900 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005901 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5902 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5903 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5904 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5905 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5906 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005907
5908 // Validation for VK_EXT_fragment_density_map
5909 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005910 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5911 skip |= LogError(cb_node->commandBuffer, vuid,
5912 "%s: dstImage must not have been created with flags containing "
5913 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5914 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005915 }
5916
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005917 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005918 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
5919 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005920 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005921 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
5922 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005923 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005924
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005925 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 -04005926 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
5927 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
5928 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
5929 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
5930
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005931 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005932 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5933 vuid =
5934 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005935 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005936 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
5937 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
5938 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
5939 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
5940 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
5941 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5942 "imageSubresource", vuid);
5943 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
5944 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005945 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005946 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07005947
5948 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5949 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5950 assert(command_pool != nullptr);
5951 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5952 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5953 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
5954 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
5955 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
5956 LogObjectList objlist(cb_node->commandBuffer);
5957 objlist.add(command_pool->commandPool);
5958 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
5959 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
5960 skip |= LogError(dst_image_state->image, vuid,
5961 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5962 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5963 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5964 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5965 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
5966 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005967 }
5968 return skip;
5969}
5970
Jeff Leger178b1e52020-10-05 12:22:23 -04005971bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5972 VkImageLayout dstImageLayout, uint32_t regionCount,
5973 const VkBufferImageCopy *pRegions) const {
5974 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
5975 COPY_COMMAND_VERSION_1);
5976}
5977
5978bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5979 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
5980 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
5981 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
5982 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
5983}
5984
John Zulauf1686f232019-07-09 16:27:11 -06005985void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5986 VkImageLayout dstImageLayout, uint32_t regionCount,
5987 const VkBufferImageCopy *pRegions) {
5988 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5989
5990 auto cb_node = GetCBState(commandBuffer);
5991 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005992 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005993 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005994 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005995 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005996}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005997
Jeff Leger178b1e52020-10-05 12:22:23 -04005998void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5999 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6000 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6001
6002 auto cb_node = GetCBState(commandBuffer);
6003 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6004 // Make sure that all image slices are record referenced layout
6005 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6006 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6007 pCopyBufferToImageInfo2KHR->dstImageLayout);
6008 }
6009}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006010bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006011 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006012 bool skip = false;
6013 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6014
Dave Houlton1d960ff2018-01-19 12:17:05 -07006015 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006016 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6017 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6018 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006019 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6020 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006021 }
6022
John Zulaufa26d3c82019-08-14 16:09:08 -06006023 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006024 if (!image_entry) {
6025 return skip;
6026 }
6027
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006028 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6029 if (device_extensions.vk_ext_image_drm_format_modifier) {
6030 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6031 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006032 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6033 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6034 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006035 }
6036 } else {
6037 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006038 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6039 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006040 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006041 }
6042
Dave Houlton1d960ff2018-01-19 12:17:05 -07006043 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006044 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006045 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6046 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6047 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006048 }
6049
Dave Houlton1d960ff2018-01-19 12:17:05 -07006050 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006051 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006052 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6053 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6054 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006055 }
6056
Dave Houlton1d960ff2018-01-19 12:17:05 -07006057 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006058 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006059 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6060 if (FormatIsMultiplane(img_format)) {
6061 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
6062 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6063 if (FormatPlaneCount(img_format) > 2u) {
6064 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
6065 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6066 }
6067 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006068 skip |= LogError(image, vuid,
6069 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6070 ") must be a single-plane specifier flag.",
6071 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006072 }
6073 } else if (FormatIsColor(img_format)) {
6074 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006075 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6076 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6077 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006078 }
6079 } else if (FormatIsDepthOrStencil(img_format)) {
6080 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6081 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006082 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006083 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6084 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6085 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6086 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006087 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6088 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6089 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006090 }
6091 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006092
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006093 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006094 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006095 }
6096
Mike Weiblen672b58b2017-02-21 14:32:53 -07006097 return skip;
6098}
sfricke-samsung022fa252020-07-24 03:26:16 -07006099
6100// Validates the image is allowed to be protected
6101bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006102 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006103 bool skip = false;
6104 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6105 LogObjectList objlist(cb_state->commandBuffer);
6106 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006107 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 -07006108 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006109 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006110 }
6111 return skip;
6112}
6113
6114// Validates the image is allowed to be unprotected
6115bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006116 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006117 bool skip = false;
6118 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6119 LogObjectList objlist(cb_state->commandBuffer);
6120 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006121 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 -07006122 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006123 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006124 }
6125 return skip;
6126}
6127
6128// Validates the buffer is allowed to be protected
6129bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006130 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006131 bool skip = false;
6132 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6133 LogObjectList objlist(cb_state->commandBuffer);
6134 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006135 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 -07006136 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006137 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006138 }
6139 return skip;
6140}
6141
6142// Validates the buffer is allowed to be unprotected
6143bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006144 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006145 bool skip = false;
6146 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6147 LogObjectList objlist(cb_state->commandBuffer);
6148 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006149 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 -07006150 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006151 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006152 }
6153 return skip;
6154}