blob: b5a9010e3d49a2be33cb6c20bc86359ecd0ef2d4 [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.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070020 * Shannon McPherson <shannon@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070021 */
22
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060023#include <cmath>
24#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070025#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020026#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027
28#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020029#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030#include "vk_layer_data.h"
31#include "vk_layer_utils.h"
32#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060033#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070034
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070035#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070036#include "core_validation.h"
37#include "shader_validation.h"
38#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070039#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070040
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070041// All VUID from copy_bufferimage_to_imagebuffer_common.txt
42static const char* GetBufferImageCopyCommandVUID(size_t id, bool image_to_buffer, bool copy2) {
43 // clang-format off
44 static const std::map<size_t, std::array<const char *, 4>> copy_imagebuffer_vuid = {
45 {193, {
46 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
47 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
48 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00193", // copy2 & !image_to_buffer
49 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00193", // copy2 & image_to_buffer
50 }},
51 {1558, {
52 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
53 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
54 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01558",
55 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01558",
56 }},
57 {1559, {
58 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
59 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
60 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01559",
61 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01559",
62 }},
63 {197, {
64 "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
65 "VUID-vkCmdCopyImageToBuffer-imageOffset-00197",
66 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00197",
67 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
68 }},
69 {198, {
70 "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
71 "VUID-vkCmdCopyImageToBuffer-imageOffset-00198",
72 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00198",
73 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00198",
74 }},
75 {199, {
76 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
77 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
78 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00199",
79 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00199",
80 }},
81 {200, {
82 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
83 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
84 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00200",
85 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00200",
86 }},
87 {201, {
88 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
89 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
90 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00201",
91 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00201",
92 }},
93 {203, {
94 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
95 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
96 "VUID-VkCopyBufferToImageInfo2KHR-bufferRowLength-00203",
97 "VUID-VkCopyImageToBufferInfo2KHR-bufferRowLength-00203",
98 }},
99 {204, {
100 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
101 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
102 "VUID-VkCopyBufferToImageInfo2KHR-bufferImageHeight-00204",
103 "VUID-VkCopyImageToBufferInfo2KHR-bufferImageHeight-00204",
104 }},
105 {205, {
106 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
107 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
108 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00205",
109 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00205",
110 }},
111 {206, {
112 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
113 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
114 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00206",
115 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00206",
116 }},
117 {207, {
118 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
119 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
120 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00207",
121 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00207",
122 }},
123 {208, {
124 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
125 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
126 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00208",
127 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00208",
128 }},
129 {209, {
130 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
131 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
132 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00209",
133 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00209",
134 }},
135 {211, {
136 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
137 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
138 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-00211",
139 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-00211",
140 }},
141 {1560, {
142 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
143 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
144 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-01560",
145 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-01560",
146 }},
147 {213, {
148 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
149 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
150 "VUID-VkCopyBufferToImageInfo2KHR-baseArrayLayer-00213",
151 "VUID-VkCopyImageToBufferInfo2KHR-baseArrayLayer-00213",
152 }}
153 };
154 // clang-format on
155
156 uint8_t index = 0;
157 index |= (image_to_buffer) ? 0x1 : 0;
158 index |= (copy2) ? 0x2 : 0;
159 return copy_imagebuffer_vuid.at(id).at(index);
160}
161
John Zulauff660ad62019-03-23 07:16:05 -0600162// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
163static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
164 VkImageSubresourceRange subresource_range;
165 subresource_range.aspectMask = subresource_layers.aspectMask;
166 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
167 subresource_range.layerCount = subresource_layers.layerCount;
168 subresource_range.baseMipLevel = subresource_layers.mipLevel;
169 subresource_range.levelCount = 1;
170 return subresource_range;
171}
172
John Zulaufb58415b2019-12-09 15:02:32 -0700173static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
174 const auto format = create_info.format;
175 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200176
177#ifdef VK_USE_PLATFORM_ANDROID_KHR
178 const VkExternalFormatANDROID *pExternalFormatANDROID = lvl_find_in_chain<VkExternalFormatANDROID>(&create_info);
179 bool isExternalFormatConversion = (pExternalFormatANDROID != nullptr && pExternalFormatANDROID->externalFormat != 0);
180#else
181 bool isExternalFormatConversion = false;
182#endif
183
184 if (FormatIsColor(format) || FormatIsMultiplane(format) || isExternalFormatConversion) {
John Zulaufb58415b2019-12-09 15:02:32 -0700185 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
186 } else {
187 init_range.aspectMask =
188 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
189 }
190 return NormalizeSubresourceRange(create_info, init_range);
191}
192
locke-lunargcac25742020-08-25 16:15:40 -0600193std::vector<VkImageView> FRAMEBUFFER_STATE::GetUsedAttachments(
194 const safe_VkSubpassDescription2 &subpasses, const std::vector<IMAGE_VIEW_STATE *> &imagelessFramebufferAttachments) {
locke-lunarg540b2252020-08-03 13:23:36 -0600195 std::vector<VkImageView> attachment_views(createInfo.attachmentCount, VK_NULL_HANDLE);
196
locke-lunargcac25742020-08-25 16:15:40 -0600197 const bool imageless = (createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) ? true : false;
198
locke-lunarg540b2252020-08-03 13:23:36 -0600199 for (uint32_t index = 0; index < subpasses.inputAttachmentCount; ++index) {
locke-lunargcac25742020-08-25 16:15:40 -0600200 const uint32_t attachment_index = subpasses.pInputAttachments[index].attachment;
201 if (attachment_index != VK_ATTACHMENT_UNUSED) {
202 if (imageless) {
203 attachment_views[attachment_index] = imagelessFramebufferAttachments[attachment_index]->image_view;
204 } else {
205 attachment_views[attachment_index] = createInfo.pAttachments[attachment_index];
206 }
locke-lunarg540b2252020-08-03 13:23:36 -0600207 }
208 }
209 for (uint32_t index = 0; index < subpasses.colorAttachmentCount; ++index) {
locke-lunargcac25742020-08-25 16:15:40 -0600210 const uint32_t attachment_index = subpasses.pColorAttachments[index].attachment;
211 if (attachment_index != VK_ATTACHMENT_UNUSED) {
212 if (imageless) {
213 attachment_views[attachment_index] = imagelessFramebufferAttachments[attachment_index]->image_view;
214 } else {
215 attachment_views[attachment_index] = createInfo.pAttachments[attachment_index];
216 }
locke-lunarg540b2252020-08-03 13:23:36 -0600217 }
locke-lunargcac25742020-08-25 16:15:40 -0600218 if (subpasses.pResolveAttachments) {
219 const uint32_t attachment_index2 = subpasses.pResolveAttachments[index].attachment;
220 if (attachment_index2 != VK_ATTACHMENT_UNUSED) {
221 if (imageless) {
222 attachment_views[attachment_index2] = imagelessFramebufferAttachments[attachment_index2]->image_view;
223 } else {
224 attachment_views[attachment_index2] = createInfo.pAttachments[attachment_index2];
225 }
226 }
locke-lunarg540b2252020-08-03 13:23:36 -0600227 }
228 }
locke-lunargcac25742020-08-25 16:15:40 -0600229 if (subpasses.pDepthStencilAttachment) {
230 const uint32_t attachment_index = subpasses.pDepthStencilAttachment->attachment;
231 if (attachment_index != VK_ATTACHMENT_UNUSED) {
232 if (imageless) {
233 attachment_views[attachment_index] = imagelessFramebufferAttachments[attachment_index]->image_view;
234 } else {
235 attachment_views[attachment_index] = createInfo.pAttachments[attachment_index];
236 }
237 }
locke-lunarg540b2252020-08-03 13:23:36 -0600238 }
239 return attachment_views;
240}
241
locke-lunarg296a3c92020-03-25 01:04:29 -0600242IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -0600243 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -0700244 safe_create_info(pCreateInfo),
245 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -0600246 valid(false),
247 acquired(false),
248 shared_presentable(false),
249 layout_locked(false),
250 get_sparse_reqs_called(false),
251 sparse_metadata_required(false),
252 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -0600253 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700254 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -0600255 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700256 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -0600257 create_from_swapchain(VK_NULL_HANDLE),
258 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -0600259 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700260 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -0700261 disjoint(false),
262 plane0_memory_requirements_checked(false),
263 plane1_memory_requirements_checked(false),
264 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -0600265 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -0600266 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -0600267 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
unknown08c57af2019-06-21 16:33:35 -0600268 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600269 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
270 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
271 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
272 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
273 }
274 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
275 }
276
277 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
278 sparse = true;
279 }
Locked8af3732019-05-10 09:47:56 -0600280
sfricke-samsunge2441192019-11-06 14:07:57 -0800281 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
282 if (externalMemoryInfo) {
283 external_memory_handle = externalMemoryInfo->handleTypes;
284 }
John Zulauff660ad62019-03-23 07:16:05 -0600285}
286
unknown2c877272019-07-11 12:56:50 -0600287bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
288 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
289 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
290 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
291 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
292 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
293 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600294 return is_equal &&
295 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600296}
297
Jeff Bolz82f854d2019-09-17 14:56:47 -0500298// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
299bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
300 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
301 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
302 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
303 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
304 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600305 is_compatible = is_compatible &&
306 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
307 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500308
309 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
310 createInfo.extent.height <= other_createInfo.extent.height &&
311 createInfo.extent.depth <= other_createInfo.extent.depth &&
312 createInfo.arrayLayers <= other_createInfo.arrayLayers;
313 return is_compatible;
314}
315
unknown2c877272019-07-11 12:56:50 -0600316bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700317 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
318 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
319 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700320 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
321 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600322 IsCreateInfoEqual(other_image_state->createInfo)) {
323 return true;
324 }
unknowne1661522019-07-11 13:04:18 -0600325 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
326 return true;
327 }
unknown2c877272019-07-11 12:56:50 -0600328 return false;
329}
330
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500331IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
332 : image_view(iv),
333 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700334 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600335 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500336 samplerConversion(VK_NULL_HANDLE),
337 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600338 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
339 if (conversionInfo) samplerConversion = conversionInfo->conversion;
340 if (image_state) {
341 // A light normalization of the createInfo range
342 auto &sub_res_range = create_info.subresourceRange;
343 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
344 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
345
346 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700347 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500348 samples = image_state->createInfo.samples;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200349
350 if (image_state->has_ahb_format) {
351 // When the image has a external format the views format must be VK_FORMAT_UNDEFINED and it is required to use a sampler
352 // Ycbcr conversion. Thus we can't extract any meaningful information from the format parameter. As a Sampler Ycbcr
353 // conversion must be used the shader type is always float.
354 descriptor_format_bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
355 } else {
356 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
357 }
John Zulauff660ad62019-03-23 07:16:05 -0600358 }
359}
360
locke-lunarg540b2252020-08-03 13:23:36 -0600361bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600362 if (image_view == compare_view.image_view) {
363 return true;
364 }
locke-lunargdc287022020-08-21 12:03:57 -0600365 if (image_state->image != compare_view.image_state->image) {
366 return false;
367 }
locke-lunarg540b2252020-08-03 13:23:36 -0600368 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
369 return false;
370 }
371
372 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600373 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600374 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600375 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600376 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600377 }
378
379 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600380 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600381 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600382 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600383 }
384
385 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600386 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600387 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600388 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600389 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600390 }
391
392 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600393 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600394 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600395 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600396 }
locke-lunargdc287022020-08-21 12:03:57 -0600397 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600398}
399
locke-lunarg654a9052020-10-13 16:28:42 -0600400const cvdescriptorset::DescriptorSet *CMD_BUFFER_STATE::GetDescriptorSet(VkPipelineBindPoint bind_point, uint32_t set) const {
401 const auto last_bound_it = lastBound.find(bind_point);
402 if (last_bound_it == lastBound.cend()) {
403 return nullptr;
404 }
405 if (set >= last_bound_it->second.per_set.size()) {
406 return nullptr;
407 }
408 return last_bound_it->second.per_set[set].bound_descriptor_set;
409}
410
locke-lunarg36045992020-08-20 16:54:37 -0600411const cvdescriptorset::Descriptor *CMD_BUFFER_STATE::GetDescriptor(VkShaderStageFlagBits shader_stage, uint32_t set,
412 uint32_t binding, uint32_t index) const {
413 VkPipelineBindPoint bind_point;
414
415 if (shader_stage & VK_SHADER_STAGE_ALL_GRAPHICS) {
416 bind_point = VK_PIPELINE_BIND_POINT_GRAPHICS;
417 } else if (shader_stage & VK_SHADER_STAGE_COMPUTE_BIT) {
418 bind_point = VK_PIPELINE_BIND_POINT_COMPUTE;
419 } else {
420 bind_point = VK_PIPELINE_BIND_POINT_RAY_TRACING_KHR;
421 }
422
423 return GetDescriptor(bind_point, set, binding, index);
424}
425
426const cvdescriptorset::Descriptor *CMD_BUFFER_STATE::GetDescriptor(VkPipelineBindPoint bind_point, uint32_t set, uint32_t binding,
427 uint32_t index) const {
428 const auto last_bound_it = lastBound.find(bind_point);
429 if (last_bound_it == lastBound.cend()) {
430 return nullptr;
431 }
432 if (set >= last_bound_it->second.per_set.size()) {
433 return nullptr;
434 }
435 return last_bound_it->second.per_set[set].bound_descriptor_set->GetDescriptorFromBinding(binding, index);
436}
437
Dave Houltond9611312018-11-19 17:03:36 -0700438uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
439 // uint cast applies floor()
440 return 1u + (uint32_t)log2(std::max({height, width, depth}));
441}
442
443uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
444
445uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
446
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500447bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700448 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700449 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700450
John Zulauf2076e812020-01-08 14:55:54 -0700451 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
452 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700453 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
454 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
455
John Zulauf2076e812020-01-08 14:55:54 -0700456 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
457
458 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
459 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700460 return false;
461 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700462
John Zulauf2076e812020-01-08 14:55:54 -0700463 for (auto entry : *layout_range_map) {
464 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700465 }
466 return true;
467}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700468
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600469// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600470void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600471 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
472 VkImageLayout expected_layout) {
473 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
474 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600475 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600476 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700477 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700478 for (const auto &image : image_state.aliasing_images) {
479 auto alias_state = GetImageState(image);
480 // The map state of the aliases should all be in sync, so no need to check the return value
481 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
482 assert(subresource_map);
483 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
484 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700485}
John Zulauff660ad62019-03-23 07:16:05 -0600486
487// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600488void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600489 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500490 return;
491 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500492 IMAGE_STATE *image_state = view_state.image_state.get();
493 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700494 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700495 for (const auto &image : image_state->aliasing_images) {
496 image_state = GetImageState(image);
497 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
498 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
499 }
John Zulauff660ad62019-03-23 07:16:05 -0600500}
501
502// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600503void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600504 const VkImageSubresourceRange &range, VkImageLayout layout) {
505 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
506 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600507 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700508 for (const auto &image : image_state.aliasing_images) {
509 auto alias_state = GetImageState(image);
510 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
511 assert(subresource_map);
512 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
513 }
John Zulauff660ad62019-03-23 07:16:05 -0600514}
515
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600516void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600517 VkImageLayout layout) {
518 const IMAGE_STATE *image_state = GetImageState(image);
519 if (!image_state) return;
520 SetImageInitialLayout(cb_node, *image_state, range, layout);
521};
522
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600523void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600524 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
525 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600526}
Dave Houltonddd65c52018-05-08 14:58:01 -0600527
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600528// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700529void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
530 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500531 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600532
John Zulauff660ad62019-03-23 07:16:05 -0600533 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600534 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
535 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600536 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 -0600537 sub_range.baseArrayLayer = 0;
538 sub_range.layerCount = image_state->createInfo.extent.depth;
539 }
540
Piers Daniell4fde9b72019-11-27 16:19:46 -0700541 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
542 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
543 SetImageLayout(cb_node, *image_state, sub_range, layout);
544 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
545 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
546 } else {
547 SetImageLayout(cb_node, *image_state, sub_range, layout);
548 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600549}
550
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700551bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
552 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700553 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600554 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100555 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700556 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100557 const char *vuid;
558 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700559 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100560
561 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600562 LogObjectList objlist(image);
563 objlist.add(renderpass);
564 objlist.add(framebuffer);
565 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700566 skip |=
567 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
568 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
569 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
570 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100571 return skip;
572 }
573
574 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200575 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
576 if (stencil_usage_info) {
577 image_usage |= stencil_usage_info->stencilUsage;
578 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100579
580 // Check for layouts that mismatch image usages in the framebuffer
581 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800582 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600583 LogObjectList objlist(image);
584 objlist.add(renderpass);
585 objlist.add(framebuffer);
586 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700587 skip |= LogError(objlist, vuid,
588 "%s: Layout/usage mismatch for attachment %u in %s"
589 " - the %s is %s but the image attached to %s via %s"
590 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
591 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
592 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
593 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100594 }
595
596 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
597 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800598 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600599 LogObjectList objlist(image);
600 objlist.add(renderpass);
601 objlist.add(framebuffer);
602 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700603 skip |= LogError(objlist, vuid,
604 "%s: Layout/usage mismatch for attachment %u in %s"
605 " - the %s is %s but the image attached to %s via %s"
606 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
607 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
608 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
609 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100610 }
611
612 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800613 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600614 LogObjectList objlist(image);
615 objlist.add(renderpass);
616 objlist.add(framebuffer);
617 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700618 skip |= LogError(objlist, vuid,
619 "%s: Layout/usage mismatch for attachment %u in %s"
620 " - the %s is %s but the image attached to %s via %s"
621 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
622 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
623 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
624 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100625 }
626
627 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800628 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600629 LogObjectList objlist(image);
630 objlist.add(renderpass);
631 objlist.add(framebuffer);
632 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700633 skip |= LogError(objlist, vuid,
634 "%s: Layout/usage mismatch for attachment %u in %s"
635 " - the %s is %s but the image attached to %s via %s"
636 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
637 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
638 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
639 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100640 }
641
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600642 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100643 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
644 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
645 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
646 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
647 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800648 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600649 LogObjectList objlist(image);
650 objlist.add(renderpass);
651 objlist.add(framebuffer);
652 objlist.add(image_view);
653 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700654 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700655 " - the %s is %s but the image attached to %s via %s"
656 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700657 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700658 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
659 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100660 }
661 } else {
662 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
663 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
664 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
665 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600666 LogObjectList objlist(image);
667 objlist.add(renderpass);
668 objlist.add(framebuffer);
669 objlist.add(image_view);
670 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700671 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700672 " - the %s is %s but the image attached to %s via %s"
673 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700674 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700675 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
676 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100677 }
678 }
679 return skip;
680}
681
John Zulauf17a01bb2019-08-09 16:41:19 -0600682bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700683 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600684 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600685 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700686 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700687 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100688 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100689
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700690 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100691 auto framebuffer = framebuffer_state->framebuffer;
692
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700693 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700694 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
695 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700696 }
John Zulauf8e308292018-09-21 11:34:37 -0600697
Tobias Hectorc9057422019-07-23 12:15:52 +0100698 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
699 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
700 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100701 }
702
Tobias Hectorc9057422019-07-23 12:15:52 +0100703 if (attachments != nullptr) {
704 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
705 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
706 auto image_view = attachments[i];
707 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100708
Tobias Hectorc9057422019-07-23 12:15:52 +0100709 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600710 LogObjectList objlist(pRenderPassBegin->renderPass);
711 objlist.add(framebuffer_state->framebuffer);
712 objlist.add(image_view);
713 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700714 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
715 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
716 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100717 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100718 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100719
720 const VkImage image = view_state->create_info.image;
721 const IMAGE_STATE *image_state = GetImageState(image);
722
723 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600724 LogObjectList objlist(pRenderPassBegin->renderPass);
725 objlist.add(framebuffer_state->framebuffer);
726 objlist.add(image_view);
727 objlist.add(image);
728 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700729 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
730 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
731 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100732 continue;
733 }
734 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
735 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
736
Piers Daniell7f894f62020-01-09 16:33:48 -0700737 // Default to expecting stencil in the same layout.
738 auto attachment_stencil_initial_layout = attachment_initial_layout;
739
740 // If a separate layout is specified, look for that.
741 const auto *attachment_description_stencil_layout =
742 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
743 if (attachment_description_stencil_layout) {
744 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
745 }
746
Tobias Hectorc9057422019-07-23 12:15:52 +0100747 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
748 // in common with the non-const version.)
749 const ImageSubresourceLayoutMap *subresource_map =
750 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
751
752 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
753 LayoutUseCheckAndMessage layout_check(subresource_map);
754 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700755 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700756 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
757 // the next "constant value" range
758 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700759 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700760
John Zulauf5e617452019-11-19 14:44:16 -0700761 // Allow for differing depth and stencil layouts
762 VkImageLayout check_layout = attachment_initial_layout;
763 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
764
765 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700766 subres_skip |= LogError(
767 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700768 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
769 "and the %s layout of the attachment is %s. The layouts must match, or the render "
770 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700771 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100772 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700773 }
John Zulauf5e617452019-11-19 14:44:16 -0700774
Tobias Hectorc9057422019-07-23 12:15:52 +0100775 skip |= subres_skip;
776 }
777
778 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
779 framebuffer, render_pass, i, "initial layout");
780
781 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
782 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100783 }
784
Tobias Hectorc9057422019-07-23 12:15:52 +0100785 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
786 auto &subpass = pRenderPassInfo->pSubpasses[j];
787 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
788 auto &attachment_ref = subpass.pInputAttachments[k];
789 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
790 auto image_view = attachments[attachment_ref.attachment];
791 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100792
Tobias Hectorc9057422019-07-23 12:15:52 +0100793 if (view_state) {
794 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700795 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
796 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100797 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100798 }
799 }
800 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100801
Tobias Hectorc9057422019-07-23 12:15:52 +0100802 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
803 auto &attachment_ref = subpass.pColorAttachments[k];
804 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
805 auto image_view = attachments[attachment_ref.attachment];
806 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100807
Tobias Hectorc9057422019-07-23 12:15:52 +0100808 if (view_state) {
809 auto image = view_state->create_info.image;
810 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
811 framebuffer, render_pass, attachment_ref.attachment,
812 "color attachment layout");
813 if (subpass.pResolveAttachments) {
814 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
815 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
816 attachment_ref.attachment, "resolve attachment layout");
817 }
818 }
819 }
820 }
821
822 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
823 auto &attachment_ref = *subpass.pDepthStencilAttachment;
824 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
825 auto image_view = attachments[attachment_ref.attachment];
826 auto view_state = GetImageViewState(image_view);
827
828 if (view_state) {
829 auto image = view_state->create_info.image;
830 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
831 framebuffer, render_pass, attachment_ref.attachment,
832 "input attachment layout");
833 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100834 }
835 }
836 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700837 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600838 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700839}
840
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600841void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700842 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700843 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700844 IMAGE_VIEW_STATE *image_view = nullptr;
845 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
846 const auto attachment_info =
847 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
848 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
849 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300850 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700851 }
John Zulauf8e308292018-09-21 11:34:37 -0600852 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700853 VkImageLayout stencil_layout = kInvalidLayout;
854 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
855 if (attachment_reference_stencil_layout) {
856 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
857 }
858
859 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600860 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700861 }
862}
863
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600864void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
865 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700866 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700867
868 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700869 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700870 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700871 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700872 }
873 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700874 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700875 }
876 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700877 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700878 }
879 }
880}
881
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700882// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
883// 1. Transition into initialLayout state
884// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600885void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700886 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700887 // First transition into initialLayout
888 auto const rpci = render_pass_state->createInfo.ptr();
889 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700890 IMAGE_VIEW_STATE *view_state = nullptr;
891 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
892 const auto attachment_info =
893 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
894 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
895 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300896 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700897 }
John Zulauf8e308292018-09-21 11:34:37 -0600898 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700899 VkImageLayout stencil_layout = kInvalidLayout;
900 const auto *attachment_description_stencil_layout =
901 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
902 if (attachment_description_stencil_layout) {
903 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
904 }
905
906 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600907 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700908 }
909 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700910 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700911}
912
Dave Houlton10b39482017-03-16 13:18:15 -0600913bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600914 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600915 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600916 }
917 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600918 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600919 }
920 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600921 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600922 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700923 if (0 !=
924 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
925 if (FormatPlaneCount(format) == 1) return false;
926 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600927 return true;
928}
929
Mike Weiblen62d08a32017-03-07 22:18:27 -0700930// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200931bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
932 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600933 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700934 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200935 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600936 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700937
938 switch (layout) {
939 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
940 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600941 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700942 }
943 break;
944 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
945 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600946 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700947 }
948 break;
949 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
950 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600951 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700952 }
953 break;
954 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
955 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600956 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700957 }
958 break;
959 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
960 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600961 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700962 }
963 break;
964 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
965 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600966 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700967 }
968 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600969 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500970 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
971 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
972 }
973 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700974 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
975 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
976 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
977 }
978 break;
979 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
980 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
981 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
982 }
983 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700984 default:
985 // Other VkImageLayout values do not have VUs defined in this context.
986 break;
987 }
988
Dave Houlton8e9f6542018-05-18 12:18:22 -0600989 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700990 skip |= LogError(img_barrier.image, msg_code,
991 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
992 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
993 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700994 }
995 return skip;
996}
997
998// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600999bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
1000 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001001 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001002
Petr Krausad0096a2019-08-09 18:35:04 +02001003 // Scoreboard for checking for duplicate and inconsistent barriers to images
1004 struct ImageBarrierScoreboardEntry {
1005 uint32_t index;
1006 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
1007 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
1008 const VkImageMemoryBarrier *barrier;
1009 };
1010 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
1011 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
1012
John Zulauf463c51e2018-05-31 13:29:20 -06001013 // Scoreboard for duplicate layout transition barriers within the list
1014 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
1015 ImageBarrierScoreboardImageMap layout_transitions;
1016
Mike Weiblen62d08a32017-03-07 22:18:27 -07001017 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001018 const auto &img_barrier = pImageMemoryBarriers[i];
1019 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -07001020
John Zulauf463c51e2018-05-31 13:29:20 -06001021 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
1022 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
1023 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +02001024 if (img_barrier.oldLayout != img_barrier.newLayout) {
1025 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
1026 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -06001027 if (image_it != layout_transitions.end()) {
1028 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +02001029 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -06001030 if (subres_it != subres_map.end()) {
1031 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +02001032 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
1033 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
1034 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001035 skip = LogError(
1036 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +02001037 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -06001038 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
1039 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +02001040 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
1041 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
1042 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -06001043 }
1044 entry = new_entry;
1045 } else {
Petr Krausad0096a2019-08-09 18:35:04 +02001046 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001047 }
1048 } else {
Petr Krausad0096a2019-08-09 18:35:04 +02001049 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -06001050 }
1051 }
1052
Petr Krausad0096a2019-08-09 18:35:04 +02001053 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001054 if (image_state) {
1055 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +02001056 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
1057 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001058
1059 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
1060 if (image_state->layout_locked) {
1061 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001062 skip |= LogError(
1063 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001064 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001065 " 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 -07001066 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +02001067 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001068 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001069
John Zulaufa4472282019-08-22 14:44:34 -06001070 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -07001071 const VkFormat image_format = image_create_info.format;
1072 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -06001073 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -07001074 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001075 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06001076 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1077 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001078 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
1079 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
1080 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1081 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001082 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001083 }
1084 } else {
1085 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1086 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -07001087 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
1088 ? "VUID-VkImageMemoryBarrier-image-03320"
1089 : "VUID-VkImageMemoryBarrier-image-01207";
1090 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001091 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
1092 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
1093 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001094 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001095 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001096 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001097 }
John Zulauff660ad62019-03-23 07:16:05 -06001098
Petr Krausad0096a2019-08-09 18:35:04 +02001099 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1100 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001101 // TODO: Set memory invalid which is in mem_tracker currently
1102 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1103 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001104 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001105 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001106 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001107 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001108 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1109 // the next "constant value" range
1110 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001111 const auto &value = *pos;
1112 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001113 subres_skip = LogError(
1114 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001115 "%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 -07001116 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001117 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -07001118 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1119 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001120 }
John Zulauf5e617452019-11-19 14:44:16 -07001121 }
John Zulauff660ad62019-03-23 07:16:05 -06001122 skip |= subres_skip;
1123 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001124
1125 // checks color format and (single-plane or non-disjoint)
1126 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1127 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001128 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001129 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1130 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
1131 ? "VUID-VkImageMemoryBarrier-image-01671"
1132 : "VUID-VkImageMemoryBarrier-image-02902";
1133 skip |= LogError(img_barrier.image, vuid,
1134 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1135 "but its aspectMask is 0x%" PRIx32 ".",
1136 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1137 string_VkFormat(image_format), aspect_mask);
1138 }
1139 }
1140
1141 VkImageAspectFlags valid_disjoint_mask =
1142 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 -07001143 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001144 ((aspect_mask & valid_disjoint_mask) == 0)) {
1145 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1146 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1147 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1148 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1149 string_VkFormat(image_format), aspect_mask);
1150 }
1151
1152 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1153 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1154 "%s: Image barrier %s references %s of format %s has only two planes but included "
1155 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1156 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1157 string_VkFormat(image_format), aspect_mask);
1158 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001159 }
1160 }
1161 return skip;
1162}
1163
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001164bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001165 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001166
Jeff Bolz6835fda2019-10-06 00:15:34 -05001167 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001168 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001169}
1170
John Zulauf6b4aae82018-05-09 13:03:36 -06001171template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001172bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1173 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001174 using BarrierRecord = QFOTransferBarrier<Barrier>;
1175 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001176 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001177 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1178 const char *barrier_name = BarrierRecord::BarrierName();
1179 const char *handle_name = BarrierRecord::HandleName();
1180 const char *transfer_type = nullptr;
1181 for (uint32_t b = 0; b < barrier_count; b++) {
1182 if (!IsTransferOp(&barriers[b])) continue;
1183 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001184 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001185 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001186 const auto found = barrier_sets.release.find(barriers[b]);
1187 if (found != barrier_sets.release.cend()) {
1188 barrier_record = &(*found);
1189 transfer_type = "releasing";
1190 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001191 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001192 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001193 const auto found = barrier_sets.acquire.find(barriers[b]);
1194 if (found != barrier_sets.acquire.cend()) {
1195 barrier_record = &(*found);
1196 transfer_type = "acquiring";
1197 }
1198 }
1199 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001200 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1201 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1202 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1203 func_name, barrier_name, b, transfer_type, handle_name,
1204 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1205 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001206 }
1207 }
1208 return skip;
1209}
1210
John Zulaufa4472282019-08-22 14:44:34 -06001211VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1212 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1213}
1214
1215const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1216 return device_state.GetImageState(barrier.image);
1217}
1218
1219VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1220 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1221}
1222
1223const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1224 return device_state.GetBufferState(barrier.buffer);
1225}
1226
1227VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1228
John Zulauf6b4aae82018-05-09 13:03:36 -06001229template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001230void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1231 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001232 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001233 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1234 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001235 auto &barrier = barriers[b];
1236 if (IsTransferOp(&barrier)) {
1237 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001238 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001239 barrier_sets.release.emplace(barrier);
1240 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001241 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001242 barrier_sets.acquire.emplace(barrier);
1243 }
1244 }
1245
1246 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1247 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1248 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1249 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1250 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1251 auto handle_state = BarrierHandleState(*this, barrier);
1252 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1253 if (!mode_concurrent) {
1254 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001255 cb_state->queue_submit_functions.emplace_back(
1256 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1257 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1258 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1259 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001260 });
1261 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001262 }
1263 }
1264}
1265
John Zulaufa4472282019-08-22 14:44:34 -06001266bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001267 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001268 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001269 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001270 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001271 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1272 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001273 return skip;
1274}
1275
John Zulaufa4472282019-08-22 14:44:34 -06001276void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1277 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1278 const VkImageMemoryBarrier *pImageMemBarriers) {
1279 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1280 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001281}
1282
1283template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001284bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001285 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001286 // Record to the scoreboard or report that we have a duplication
1287 bool skip = false;
1288 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1289 if (!inserted.second && inserted.first->second != cb_state) {
1290 // 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 -06001291 LogObjectList objlist(cb_state->commandBuffer);
1292 objlist.add(barrier.handle);
1293 objlist.add(inserted.first->second->commandBuffer);
1294 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001295 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1296 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1297 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1298 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1299 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001300 }
1301 return skip;
1302}
1303
1304template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001305bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1306 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001307 using BarrierRecord = QFOTransferBarrier<Barrier>;
1308 using TypeTag = typename BarrierRecord::Tag;
1309 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001310 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001311 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001312 const char *barrier_name = BarrierRecord::BarrierName();
1313 const char *handle_name = BarrierRecord::HandleName();
1314 // No release should have an extant duplicate (WARNING)
1315 for (const auto &release : cb_barriers.release) {
1316 // Check the global pending release barriers
1317 const auto set_it = global_release_barriers.find(release.handle);
1318 if (set_it != global_release_barriers.cend()) {
1319 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1320 const auto found = set_for_handle.find(release);
1321 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001322 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1323 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1324 " to dstQueueFamilyIndex %" PRIu32
1325 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1326 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1327 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001328 }
1329 }
1330 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1331 }
1332 // Each acquire must have a matching release (ERROR)
1333 for (const auto &acquire : cb_barriers.acquire) {
1334 const auto set_it = global_release_barriers.find(acquire.handle);
1335 bool matching_release_found = false;
1336 if (set_it != global_release_barriers.cend()) {
1337 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1338 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1339 }
1340 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001341 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1342 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1343 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1344 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1345 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001346 }
1347 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1348 }
1349 return skip;
1350}
1351
John Zulauf3b04ebd2019-07-18 14:08:11 -06001352bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001353 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001354 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001355 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001356 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1357 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001358 return skip;
1359}
1360
1361template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001362void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001363 using BarrierRecord = QFOTransferBarrier<Barrier>;
1364 using TypeTag = typename BarrierRecord::Tag;
1365 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001366 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001367
1368 // Add release barriers from this submit to the global map
1369 for (const auto &release : cb_barriers.release) {
1370 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1371 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1372 global_release_barriers[release.handle].insert(release);
1373 }
1374
1375 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1376 for (const auto &acquire : cb_barriers.acquire) {
1377 // NOTE: We're not using [] because we don't want to create entries for missing releases
1378 auto set_it = global_release_barriers.find(acquire.handle);
1379 if (set_it != global_release_barriers.end()) {
1380 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1381 set_for_handle.erase(acquire);
1382 if (set_for_handle.size() == 0) { // Clean up empty sets
1383 global_release_barriers.erase(set_it);
1384 }
1385 }
1386 }
1387}
1388
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001389void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001390 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1391 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001392}
1393
John Zulauf6b4aae82018-05-09 13:03:36 -06001394// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001395void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001396
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001397void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001398 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001399 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001400 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001401
Chris Forbes4de4b132017-08-21 11:27:08 -07001402 // For ownership transfers, the barrier is specified twice; as a release
1403 // operation on the yielding queue family, and as an acquire operation
1404 // on the acquiring queue family. This barrier may also include a layout
1405 // transition, which occurs 'between' the two operations. For validation
1406 // purposes it doesn't seem important which side performs the layout
1407 // transition, but it must not be performed twice. We'll arbitrarily
1408 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001409 //
1410 // However, we still need to record initial layout for the "initial layout" validation
1411 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001412
Petr Krausad0096a2019-08-09 18:35:04 +02001413 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001414 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001415 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001416 }
1417}
1418
unknown86bcb3a2019-07-11 13:05:36 -06001419void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001420 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001421 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1422 const auto &image_create_info = image_state->createInfo;
1423
1424 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1425 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1426 // for all (potential) layer sub_resources.
1427 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1428 normalized_isr.baseArrayLayer = 0;
1429 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1430 }
1431
Michael Spang8af7c102020-05-03 20:50:09 -04001432 VkImageLayout initial_layout = mem_barrier.oldLayout;
1433
1434 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001435 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001436 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1437 }
1438
John Zulauf2be3fe02019-12-30 09:48:02 -07001439 if (is_release_op) {
1440 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1441 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001442 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001443 }
unknown86bcb3a2019-07-11 13:05:36 -06001444}
1445
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001446bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1447 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1448 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1449 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001450 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001451 assert(cb_node);
1452 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001453 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001454 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001455
John Zulauff660ad62019-03-23 07:16:05 -06001456 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1457 if (subresource_map) {
1458 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001459 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001460 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1461 // the next "constant value" range
1462 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001463 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001464 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001465 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1466 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1467 "%s layout %s.",
1468 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1469 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1470 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001471 }
John Zulauf5e617452019-11-19 14:44:16 -07001472 }
John Zulauff660ad62019-03-23 07:16:05 -06001473 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001474 }
John Zulauff660ad62019-03-23 07:16:05 -06001475
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001476 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1477 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1478 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001479 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1480 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001481 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1482 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1483 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001484 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001485 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001486 if (image_state->shared_presentable) {
1487 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001488 skip |=
1489 LogError(device, layout_invalid_msg_code,
1490 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1491 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001492 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001493 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001494 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001495 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001496 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1497 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1498 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1499 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001500 }
1501 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001502 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001503}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001504bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001505 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1506 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001507 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001508 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1509 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1510}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001511
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001512void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001513 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001514 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001515 if (!renderPass) return;
1516
Tobias Hectorbbb12282018-10-22 15:17:59 +01001517 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001518 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001519 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001520 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001521 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1522 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1523 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1524 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001525 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001526 }
John Zulauf8e308292018-09-21 11:34:37 -06001527 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001528 VkImageLayout stencil_layout = kInvalidLayout;
1529 const auto *attachment_description_stencil_layout =
1530 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1531 if (attachment_description_stencil_layout) {
1532 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1533 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001534 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001535 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001536 }
1537 }
1538}
Dave Houltone19e20d2018-02-02 16:32:41 -07001539
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001540#ifdef VK_USE_PLATFORM_ANDROID_KHR
1541// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1542// This could also move into a seperate core_validation_android.cpp file... ?
1543
1544//
1545// AHB-specific validation within non-AHB APIs
1546//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001547bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001548 bool skip = false;
1549
1550 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1551 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001552 if (0 != ext_fmt_android->externalFormat) {
1553 if (VK_FORMAT_UNDEFINED != create_info->format) {
1554 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001555 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1556 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1557 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001558 }
1559
1560 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001561 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1562 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1563 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001564 }
1565
1566 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001567 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1568 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001569 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1570 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1571 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001572 }
1573
1574 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001575 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1576 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1577 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001578 }
1579 }
1580
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001581 if ((0 != ext_fmt_android->externalFormat) &&
1582 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001583 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001584 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1585 ") which has "
1586 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1587 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001588 }
1589 }
1590
Dave Houltond9611312018-11-19 17:03:36 -07001591 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001592 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001593 skip |=
1594 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1595 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1596 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001597 }
1598 }
1599
1600 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1601 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1602 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001603 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001604 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1605 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1606 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1607 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001608 }
1609
1610 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001611 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1612 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1613 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1614 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1615 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001616 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001617 }
1618
1619 return skip;
1620}
1621
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001622bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001623 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001624 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001625
1626 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001627 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001628 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1629 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001630 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001631 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001632 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001633
Dave Houltond9611312018-11-19 17:03:36 -07001634 // Chain must include a compatible ycbcr conversion
1635 bool conv_found = false;
1636 uint64_t external_format = 0;
1637 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1638 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001639 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001640 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001641 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001642 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001643 }
Dave Houltond9611312018-11-19 17:03:36 -07001644 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001645 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001646 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001647 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1648 "an externalFormat (%" PRIu64
1649 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1650 "with the same external format.",
1651 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001652 }
1653
1654 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001655 if (IsIdentitySwizzle(create_info->components) == false) {
1656 skip |= LogError(
1657 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1658 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1659 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1660 "= %s.",
1661 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1662 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001663 }
1664 }
Dave Houltond9611312018-11-19 17:03:36 -07001665
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001666 return skip;
1667}
1668
John Zulaufa26d3c82019-08-14 16:09:08 -06001669bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001670 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001671
John Zulaufa26d3c82019-08-14 16:09:08 -06001672 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001673 if (image_state != nullptr) {
1674 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1675 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1676 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1677 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1678 "bound to memory.");
1679 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001680 }
1681 return skip;
1682}
1683
1684#else
1685
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001686bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001687 return false;
1688}
1689
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001690bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001691
John Zulaufa26d3c82019-08-14 16:09:08 -06001692bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001693
1694#endif // VK_USE_PLATFORM_ANDROID_KHR
1695
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001696bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1697 bool skip = false;
1698
1699 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1700 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1701 const VkImageTiling image_tiling = pCreateInfo->tiling;
1702 const VkFormat image_format = pCreateInfo->format;
1703
1704 if (image_format == VK_FORMAT_UNDEFINED) {
1705 // VU 01975 states format can't be undefined unless an android externalFormat
1706#ifdef VK_USE_PLATFORM_ANDROID_KHR
1707 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1708 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1709 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1710 if (it != ahb_ext_formats_map.end()) {
1711 tiling_features = it->second;
1712 }
1713 }
1714#endif
1715 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1716 uint64_t drm_format_modifier = 0;
1717 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1718 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1719 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1720 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1721
1722 if (drm_explicit != nullptr) {
1723 drm_format_modifier = drm_explicit->drmFormatModifier;
1724 } else {
1725 // VUID 02261 makes sure its only explict or implict in parameter checking
1726 assert(drm_implicit != nullptr);
1727 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1728 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1729 }
1730 }
1731
1732 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1733 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1734 nullptr};
1735 format_properties_2.pNext = (void *)&drm_properties_list;
1736 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001737 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1738 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1739 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1740 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001741
1742 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1743 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1744 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1745 }
1746 }
1747 } else {
1748 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1749 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1750 : format_properties.optimalTilingFeatures;
1751 }
1752
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001753 // Lack of disjoint format feature support while using the flag
1754 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1755 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1756 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1757 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1758 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1759 string_VkFormat(pCreateInfo->format));
1760 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001761
1762 return skip;
1763}
1764
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001765bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001766 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001767 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001768
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001769 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001770 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001771 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1772 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001773 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1774 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001775 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001776 }
1777
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001778 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1779 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001780 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1781 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1782 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001783 }
1784
1785 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001786 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1787 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1788 "height (%d) and arrayLayers (%d) must be >= 6.",
1789 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001790 }
Dave Houlton130c0212018-01-29 13:39:56 -07001791 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001792
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001793 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001794 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1795 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1796 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001797 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1798 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1799 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001800 }
1801
1802 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001803 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1804 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1805 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001806 }
1807
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001808 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001809 uint32_t ceiling_width =
1810 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1811 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1812 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1813 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001814 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1815 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1816 "ceiling of device "
1817 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1818 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1819 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001820 }
1821
1822 uint32_t ceiling_height =
1823 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1824 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1825 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1826 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001827 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1828 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1829 "ceiling of device "
1830 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1831 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1832 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001833 }
1834 }
1835
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001836 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001837 VkResult result = VK_SUCCESS;
1838 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1839 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1840 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1841 &format_limits);
1842 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001843 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1844 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1845 if (modifier_list) {
1846 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1847 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1848 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1849 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1850 image_format_info.type = pCreateInfo->imageType;
1851 image_format_info.format = pCreateInfo->format;
1852 image_format_info.tiling = pCreateInfo->tiling;
1853 image_format_info.usage = pCreateInfo->usage;
1854 image_format_info.flags = pCreateInfo->flags;
1855 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1856
1857 result =
1858 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1859 format_limits = image_format_properties.imageFormatProperties;
1860
1861 /* The application gives a list of modifier and the driver
1862 * selects one. If one is wrong, stop there.
1863 */
1864 if (result != VK_SUCCESS) break;
1865 }
1866 } else if (explicit_modifier) {
1867 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1868 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1869 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1870 image_format_info.type = pCreateInfo->imageType;
1871 image_format_info.format = pCreateInfo->format;
1872 image_format_info.tiling = pCreateInfo->tiling;
1873 image_format_info.usage = pCreateInfo->usage;
1874 image_format_info.flags = pCreateInfo->flags;
1875 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1876
1877 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1878 format_limits = image_format_properties.imageFormatProperties;
1879 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001880 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001881
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001882 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1883 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1884 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1885 if (result != VK_SUCCESS) {
1886 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001887#ifdef VK_USE_PLATFORM_ANDROID_KHR
1888 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1889#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001890 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001891 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001892 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1893 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001894 } else {
1895 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1896 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001897 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1898 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1899 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001900 }
Dave Houlton130c0212018-01-29 13:39:56 -07001901
Dave Houltona585d132019-01-18 13:05:42 -07001902 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1903 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1904 (uint64_t)pCreateInfo->samples;
1905 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001906
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001907 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001908 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001909 uint64_t ig_mask = imageGranularity - 1;
1910 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001911
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001912 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001913 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1914 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1915 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1916 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001917 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001918
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001919 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001920 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1921 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1922 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001923 }
1924
1925 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001926 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1927 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1928 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001929 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001930
1931 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1932 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1933 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1934 pCreateInfo->extent.width, format_limits.maxExtent.width);
1935 }
1936
1937 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1938 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1939 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1940 pCreateInfo->extent.height, format_limits.maxExtent.height);
1941 }
1942
1943 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1944 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1945 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1946 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1947 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001948 }
1949
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001950 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001951 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1952 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1953 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1954 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001955 skip |= LogError(device, error_vuid,
1956 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1957 "YCbCr Conversion format, arrayLayers must be 1",
1958 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001959 }
1960
1961 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001962 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1963 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1964 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001965 }
1966
1967 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001968 skip |= LogError(
1969 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001970 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1971 string_VkSampleCountFlagBits(pCreateInfo->samples));
1972 }
1973
1974 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001975 skip |= LogError(
1976 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001977 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1978 string_VkImageType(pCreateInfo->imageType));
1979 }
1980 }
1981
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001982 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001983 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001984 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001985 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001986 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1987 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1988 "format must be block, ETC or ASTC compressed, but is %s",
1989 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001990 }
1991 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001992 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1993 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1994 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001995 }
1996 }
1997 }
1998
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001999 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002000 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
2001 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
2002 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002003 }
2004
unknown2c877272019-07-11 12:56:50 -06002005 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2006 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2007 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002008 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2009 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2010 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002011 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002012
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002013 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
2014 if (swapchain_create_info != nullptr) {
2015 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2016 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2017 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2018
2019 // Validate rest of Swapchain Image create check that require swapchain state
2020 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2021 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2022 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2023 skip |= LogError(
2024 device, vuid,
2025 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2026 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2027 }
2028 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2029 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2030 skip |= LogError(device, vuid,
2031 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2032 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2033 }
2034 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
2035 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2036 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2037 skip |= LogError(device, vuid,
2038 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2039 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
2040 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
2041 }
2042 }
2043 }
2044
sfricke-samsungedce77a2020-07-03 22:35:13 -07002045 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2046 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2047 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2048 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2049 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2050 }
2051 const VkImageCreateFlags invalid_flags =
2052 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2053 if ((pCreateInfo->flags & invalid_flags) != 0) {
2054 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2055 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2056 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2057 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2058 }
2059 }
2060
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002061 skip |= ValidateImageFormatFeatures(pCreateInfo);
2062
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002063 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002064}
2065
John Zulauf7eeb6f72019-06-17 11:56:36 -06002066void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2067 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2068 if (VK_SUCCESS != result) return;
2069
2070 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002071 auto image_state = Get<IMAGE_STATE>(*pImage);
2072 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002073}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002074
Jeff Bolz5c801d12019-10-09 10:38:45 -05002075bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002076 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06002077 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002078 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002079 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002080 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002081 }
2082 return skip;
2083}
2084
John Zulauf7eeb6f72019-06-17 11:56:36 -06002085void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2086 // Clean up validation specific data
2087 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002088
locke-lunargcba7d5f2019-12-30 16:59:11 -07002089 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002090
2091 // Clean up generic image state
2092 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002093}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002094
sfricke-samsungcd924d92020-05-20 23:51:17 -07002095bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2096 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002097 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002098 const VkImage image = image_state->image;
2099 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002100
2101 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002102 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2103 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002104 }
2105
sfricke-samsungcd924d92020-05-20 23:51:17 -07002106 if (FormatIsDepthOrStencil(format)) {
2107 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2108 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2109 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2110 } else if (FormatIsCompressed(format)) {
2111 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2112 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2113 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002114 }
2115
2116 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002117 skip |=
2118 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2119 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2120 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002121 }
2122 return skip;
2123}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002124
John Zulauf07288512019-07-05 11:09:50 -06002125bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2126 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2127 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002128 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002129 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2130 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002131 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2132 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2133 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002134 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002135
2136 } else {
2137 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2138 if (!device_extensions.vk_khr_shared_presentable_image) {
2139 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002140 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2141 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2142 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002143 }
2144 } else {
2145 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2146 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002147 skip |= LogError(
2148 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002149 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2150 func_name, string_VkImageLayout(dest_image_layout));
2151 }
2152 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002153 }
2154
John Zulauff660ad62019-03-23 07:16:05 -06002155 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002156 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002157 if (subresource_map) {
2158 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002159 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002160 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002161 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2162 // the next "constant value" range
2163 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002164 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002165 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2166 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2167 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2168 } else {
2169 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002170 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002171 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2172 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2173 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2174 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002175 }
John Zulauf5e617452019-11-19 14:44:16 -07002176 }
John Zulauff660ad62019-03-23 07:16:05 -06002177 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002178 }
2179
2180 return skip;
2181}
2182
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002183bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2184 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002185 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002186 bool skip = false;
2187 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002188 const auto *cb_node = GetCBState(commandBuffer);
2189 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002190 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002191 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002192 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002193 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002194 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002195 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002196 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2197 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002198 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002199 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002200 skip |=
2201 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2202 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2203 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002204 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002205 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002206 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002207 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002208 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002209 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002210 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2211 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2212 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2213 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2214 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2215 string_VkFormat(image_state->createInfo.format));
2216 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002217 }
2218 return skip;
2219}
2220
John Zulaufeabb4462019-07-05 14:13:03 -06002221void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2222 const VkClearColorValue *pColor, uint32_t rangeCount,
2223 const VkImageSubresourceRange *pRanges) {
2224 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2225
2226 auto cb_node = GetCBState(commandBuffer);
2227 auto image_state = GetImageState(image);
2228 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002229 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002230 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002231 }
2232 }
2233}
2234
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002235bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2236 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002237 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002238 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002239
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002240 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002241 const auto *cb_node = GetCBState(commandBuffer);
2242 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002243 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002244 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002245 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002246 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002247 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002248 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002249 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002250 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002251 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002252 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002253 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002254 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002255 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2256 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2257 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2258 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002259
2260 bool any_include_aspect_depth_bit = false;
2261 bool any_include_aspect_stencil_bit = false;
2262
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002263 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002264 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002265 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002266 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002267 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002268 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2269 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002270 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2271 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2272 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2273 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002274 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002275 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2276 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002277 if (FormatHasDepth(image_format) == false) {
2278 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2279 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2280 "doesn't have a depth component.",
2281 i, string_VkFormat(image_format));
2282 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002283 }
2284 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2285 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002286 if (FormatHasStencil(image_format) == false) {
2287 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2288 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2289 "%s doesn't have a stencil component.",
2290 i, string_VkFormat(image_format));
2291 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002292 }
2293 }
2294 if (any_include_aspect_stencil_bit) {
2295 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2296 if (image_stencil_struct != nullptr) {
2297 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2298 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002299 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2300 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2301 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2302 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002303 }
2304 } else {
2305 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002306 skip |= LogError(
2307 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002308 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2309 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2310 "in VkImageCreateInfo::usage used to create image");
2311 }
2312 }
2313 }
2314 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002315 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2316 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2317 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002318 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002319 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002320 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2321 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002322 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002323 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002324 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002325 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2326 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2327 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2328 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002329 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002330 }
2331 return skip;
2332}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002333
John Zulaufeabb4462019-07-05 14:13:03 -06002334void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2335 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2336 const VkImageSubresourceRange *pRanges) {
2337 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2338 auto cb_node = GetCBState(commandBuffer);
2339 auto image_state = GetImageState(image);
2340 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002341 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002342 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002343 }
2344 }
2345}
2346
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002347// Returns true if [x, xoffset] and [y, yoffset] overlap
2348static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2349 bool result = false;
2350 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2351 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2352
2353 if (intersection_max > intersection_min) {
2354 result = true;
2355 }
2356 return result;
2357}
2358
Jeff Leger178b1e52020-10-05 12:22:23 -04002359// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002360// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002361template <typename RegionType>
2362static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002363 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002364
Dave Houltonc991cc92018-03-06 11:08:51 -07002365 // Separate planes within a multiplane image cannot intersect
2366 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002367 return result;
2368 }
2369
Dave Houltonc991cc92018-03-06 11:08:51 -07002370 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2371 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2372 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002373 result = true;
2374 switch (type) {
2375 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002376 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002377 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002378 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002379 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002380 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002381 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002382 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002383 break;
2384 default:
2385 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2386 assert(false);
2387 }
2388 }
2389 return result;
2390}
2391
Dave Houltonfc1a4052017-04-27 14:32:45 -06002392// Returns non-zero if offset and extent exceed image extents
2393static const uint32_t x_bit = 1;
2394static const uint32_t y_bit = 2;
2395static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002396static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002397 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002398 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002399 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2400 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002401 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002402 }
2403 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2404 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002405 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002406 }
2407 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2408 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002409 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002410 }
2411 return result;
2412}
2413
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002414// Test if two VkExtent3D structs are equivalent
2415static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2416 bool result = true;
2417 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2418 (extent->depth != other_extent->depth)) {
2419 result = false;
2420 }
2421 return result;
2422}
2423
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002424// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002425static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002426 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2427}
2428
2429// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002430VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002431 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2432 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002433 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002434 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002435 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002436 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002437 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002438 granularity.width *= block_size.width;
2439 granularity.height *= block_size.height;
2440 }
2441 }
2442 return granularity;
2443}
2444
2445// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2446static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2447 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002448 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2449 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002450 valid = false;
2451 }
2452 return valid;
2453}
2454
2455// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002456bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002457 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002458 bool skip = false;
2459 VkExtent3D offset_extent = {};
2460 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2461 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2462 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002463 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002464 // 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 -07002465 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002466 skip |= LogError(cb_node->commandBuffer, vuid,
2467 "%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 "
2468 "image transfer granularity is (w=0, h=0, d=0).",
2469 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002470 }
2471 } else {
2472 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2473 // integer multiples of the image transfer granularity.
2474 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002475 skip |= LogError(cb_node->commandBuffer, vuid,
2476 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2477 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2478 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2479 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002480 }
2481 }
2482 return skip;
2483}
2484
2485// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002486bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002487 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002488 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002489 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002490 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002491 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2492 // subresource extent.
2493 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002494 skip |= LogError(cb_node->commandBuffer, vuid,
2495 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2496 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2497 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2498 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002499 }
2500 } else {
2501 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2502 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2503 // subresource extent dimensions.
2504 VkExtent3D offset_extent_sum = {};
2505 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2506 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2507 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002508 bool x_ok = true;
2509 bool y_ok = true;
2510 bool z_ok = true;
2511 switch (image_type) {
2512 case VK_IMAGE_TYPE_3D:
2513 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2514 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002515 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002516 case VK_IMAGE_TYPE_2D:
2517 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2518 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002519 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002520 case VK_IMAGE_TYPE_1D:
2521 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2522 (subresource_extent->width == offset_extent_sum.width));
2523 break;
2524 default:
2525 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2526 assert(false);
2527 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002528 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002529 skip |=
2530 LogError(cb_node->commandBuffer, vuid,
2531 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2532 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2533 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2534 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2535 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2536 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002537 }
2538 }
2539 return skip;
2540}
2541
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002542bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002543 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002544 bool skip = false;
2545 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002546 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2547 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002548 }
2549 return skip;
2550}
2551
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002552bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002553 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002554 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002555 bool skip = false;
2556 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2557 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002558 skip |= LogError(cb_node->commandBuffer, vuid,
2559 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2560 "%u, but provided %s has %u array layers.",
2561 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2562 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002563 }
2564 return skip;
2565}
2566
Jeff Leger178b1e52020-10-05 12:22:23 -04002567// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2568template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002569bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002570 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002571 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002572 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002573 VkExtent3D granularity = GetScaledItg(cb_node, img);
2574 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002575 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002576 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002577 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002578 return skip;
2579}
2580
Jeff Leger178b1e52020-10-05 12:22:23 -04002581// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2582template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002583bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002584 const IMAGE_STATE *dst_img, const RegionType *region,
2585 const uint32_t i, const char *function,
2586 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002587 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002588 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2589 const char *vuid;
2590
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002591 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002592 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002593 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2594 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002595 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002596 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002597 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002598 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002599 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002600
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002601 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002602 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002603 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2604 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002605 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002606 const VkExtent3D dest_effective_extent =
2607 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002608 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002609 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002610 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002611 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002612 return skip;
2613}
2614
Jeff Leger178b1e52020-10-05 12:22:23 -04002615// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2616template <typename ImageCopyRegionType>
2617bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2618 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2619 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002620 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002621 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2622 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2623 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002624
2625 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002626 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002627
2628 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002629 const VkExtent3D src_copy_extent = region.extent;
2630 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002631 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2632
Dave Houlton6f9059e2017-05-02 17:15:13 -06002633 bool slice_override = false;
2634 uint32_t depth_slices = 0;
2635
2636 // Special case for copying between a 1D/2D array and a 3D image
2637 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2638 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002639 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002640 slice_override = (depth_slices != 1);
2641 } 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 -07002642 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002643 slice_override = (depth_slices != 1);
2644 }
2645
2646 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002647 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002648 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002649 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2650 skip |= LogError(src_state->image, vuid,
2651 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2652 "be 0 and 1, respectively.",
2653 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002654 }
2655 }
2656
Dave Houlton533be9f2018-03-26 17:08:30 -06002657 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 -04002658 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2659 skip |= LogError(src_state->image, vuid,
2660 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002661 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002662 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002663 }
2664
Dave Houlton533be9f2018-03-26 17:08:30 -06002665 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002666 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2667 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2668 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002669 }
2670
Dave Houltonc991cc92018-03-06 11:08:51 -07002671 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002672 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002673 if (FormatIsCompressed(src_state->createInfo.format) ||
2674 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002675 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002676 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002677 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2678 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2679 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002680 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002681 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002682 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002683 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002684 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002685 }
2686
Dave Houlton94a00372017-12-14 15:08:47 -07002687 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002688 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2689 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002690 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2691 skip |= LogError(src_state->image, vuid,
2692 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2693 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2694 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002695 }
2696
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002697 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002698 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2699 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002700 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2701 skip |= LogError(src_state->image, vuid,
2702 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2703 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2704 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002705 }
2706
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002707 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002708 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2709 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002710 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2711 skip |= LogError(src_state->image, vuid,
2712 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2713 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2714 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002715 }
2716 } // Compressed
2717
2718 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002719 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002720 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002721 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2722 skip |= LogError(dst_state->image, vuid,
2723 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002724 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002725 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002726 }
2727 }
2728
Dave Houlton533be9f2018-03-26 17:08:30 -06002729 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 -04002730 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2731 skip |= LogError(dst_state->image, vuid,
2732 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2733 "and 1, respectively.",
2734 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002735 }
2736
Dave Houlton533be9f2018-03-26 17:08:30 -06002737 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002738 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2739 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2740 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002741 }
2742
sfricke-samsung30b094c2020-05-30 11:42:11 -07002743 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002744 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002745 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2746 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002747 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2748 skip |= LogError(src_state->image, vuid,
2749 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2750 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2751 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002752 }
2753 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002754 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002755 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002756 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2757 skip |= LogError(dst_state->image, vuid,
2758 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2759 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2760 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002761 }
2762 }
2763 } else { // Pre maint 1
2764 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002765 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002766 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2767 skip |= LogError(src_state->image, vuid,
2768 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002769 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2770 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002771 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002772 }
Dave Houltonee281a52017-12-08 13:51:02 -07002773 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002774 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2775 skip |= LogError(dst_state->image, vuid,
2776 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002777 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2778 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002779 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002780 }
2781 }
2782 }
2783
Dave Houltonc991cc92018-03-06 11:08:51 -07002784 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2785 if (FormatIsCompressed(dst_state->createInfo.format) ||
2786 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002787 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002788
2789 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002790 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2791 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2792 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002793 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002794 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002795 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002796 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002797 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002798 }
2799
Dave Houlton94a00372017-12-14 15:08:47 -07002800 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002801 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2802 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002803 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2804 skip |= LogError(dst_state->image, vuid,
2805 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2806 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2807 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002808 }
2809
Dave Houltonee281a52017-12-08 13:51:02 -07002810 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2811 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2812 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002813 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002814 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002815 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002816 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2817 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002818 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002819 }
2820
Dave Houltonee281a52017-12-08 13:51:02 -07002821 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2822 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2823 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002824 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2825 skip |= LogError(dst_state->image, vuid,
2826 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2827 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2828 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002829 }
2830 } // Compressed
2831 }
2832 return skip;
2833}
2834
Jeff Leger178b1e52020-10-05 12:22:23 -04002835// vkCmdCopyImage / vmCmdCopyImage2KHR checks that only apply if the multiplane extension is enabled
2836template <typename RegionType>
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002837bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04002838 const IMAGE_STATE *dst_image_state, const RegionType region,
2839 CopyCommandVersion version) const {
2840 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Dave Houltonc991cc92018-03-06 11:08:51 -07002841 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002842
Jeff Leger178b1e52020-10-05 12:22:23 -04002843 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2844 const char *vuid;
2845
Dave Houltonc991cc92018-03-06 11:08:51 -07002846 // Neither image is multiplane
2847 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2848 // If neither image is multi-plane the aspectMask member of src and dst must match
2849 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2850 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002851 ss << func_name << ": Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002852 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Jeff Leger178b1e52020-10-05 12:22:23 -04002853 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2854 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002855 }
2856 } else {
2857 // Source image multiplane checks
2858 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2859 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2860 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2861 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002862 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2863 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2864 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002865 }
2866 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2867 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2868 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002869 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2870 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2871 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002872 }
2873 // Single-plane to multi-plane
2874 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2875 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2876 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002877 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2878 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2879 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002880 }
2881
2882 // Dest image multiplane checks
2883 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2884 aspect = region.dstSubresource.aspectMask;
2885 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2886 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002887 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2888 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2889 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002890 }
2891 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2892 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2893 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002894 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2895 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2896 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002897 }
2898 // Multi-plane to single-plane
2899 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2900 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2901 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002902 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2903 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2904 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002905 }
2906 }
2907
2908 return skip;
2909}
2910
Jeff Leger178b1e52020-10-05 12:22:23 -04002911template <typename RegionType>
2912bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2913 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2914 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002915 const auto *cb_node = GetCBState(commandBuffer);
2916 const auto *src_image_state = GetImageState(srcImage);
2917 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002918 const VkFormat src_format = src_image_state->createInfo.format;
2919 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002920 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002921 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002922
Jeff Leger178b1e52020-10-05 12:22:23 -04002923 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2924 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2925 const char *vuid;
2926
2927 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002928
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002929 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2930
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002931 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002932 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002933
2934 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2935 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002936 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002937
Dave Houlton6f9059e2017-05-02 17:15:13 -06002938 bool slice_override = false;
2939 uint32_t depth_slices = 0;
2940
2941 // Special case for copying between a 1D/2D array and a 3D image
2942 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2943 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2944 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002945 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002946 slice_override = (depth_slices != 1);
2947 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2948 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002949 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002950 slice_override = (depth_slices != 1);
2951 }
2952
Jeff Leger178b1e52020-10-05 12:22:23 -04002953 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2954 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2955 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2956 skip |=
2957 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2958 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2959 skip |=
2960 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2961 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002962 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002963 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2964 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002965 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002966 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002967
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002968 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002969 // No chance of mismatch if we're overriding depth slice count
2970 if (!slice_override) {
2971 // The number of depth slices in srcSubresource and dstSubresource must match
2972 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2973 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002974 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2975 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002976 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002977 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2978 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002979 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002980 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2981 skip |= LogError(command_buffer, vuid,
2982 "%s: number of depth slices in source and destination subresources for "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002983 "pRegions[%u] do not match.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002984 func_name, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002985 }
2986 }
2987 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002988 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002989 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002990 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
2991 skip |= LogError(command_buffer, vuid,
2992 "%s: number of layers in source and destination subresources for pRegions[%u] do not match",
2993 func_name, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002994 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002995 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002996
Dave Houltonc991cc92018-03-06 11:08:51 -07002997 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002998 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002999 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region, version);
Dave Houltonc991cc92018-03-06 11:08:51 -07003000 }
3001
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003002 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07003003 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3004 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003005 std::stringstream ss;
3006 ss << func_name << ": Src and dest aspectMasks for each region must match";
3007 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
3008 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonf5217612018-02-02 16:18:52 -07003009 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003010 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003011
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003012 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003013 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003014 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003015 ss << func_name << ": pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003016 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Jeff Leger178b1e52020-10-05 12:22:23 -04003017 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
3018 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003019 }
3020
3021 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003022 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003023 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003024 ss << func_name << ": pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
3025 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
3026 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003027 }
3028
Dave Houltonfc1a4052017-04-27 14:32:45 -06003029 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07003030 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
3031 if (slice_override) src_copy_extent.depth = depth_slices;
3032 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003033 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003034 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3035 skip |= LogError(command_buffer, vuid,
3036 "%s: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
3037 "width [%1d].",
3038 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003039 }
3040
3041 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003042 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3043 skip |= LogError(command_buffer, vuid,
3044 "%s: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
3045 "height [%1d].",
3046 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003047 }
3048 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003049 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3050 skip |= LogError(command_buffer, vuid,
3051 "%s: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
3052 "depth [%1d].",
3053 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003054 }
3055
Dave Houltonee281a52017-12-08 13:51:02 -07003056 // Adjust dest extent if necessary
3057 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
3058 if (slice_override) dst_copy_extent.depth = depth_slices;
3059
3060 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003061 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003062 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3063 skip |= LogError(command_buffer, vuid,
3064 "%s: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003065 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003066 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003067 }
3068 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003069 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3070 skip |= LogError(command_buffer, vuid,
3071 "%s): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003072 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003073 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003074 }
3075 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003076 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3077 skip |= LogError(command_buffer, vuid,
3078 "%s: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003079 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003080 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003081 }
3082
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003083 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3084 // must not overlap in memory
3085 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003086 for (uint32_t j = 0; j < regionCount; j++) {
3087 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003088 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003089 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003090 ss << func_name << ": pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
3091 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
3092 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003093 }
3094 }
3095 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003096
3097 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3098 if (device_extensions.vk_khr_maintenance1) {
3099 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3100 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3101 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003102 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3103 skip |= LogError(command_buffer, vuid,
3104 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3105 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003106 }
3107 } else {
3108 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3109 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3110 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003111 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3112 skip |= LogError(command_buffer, vuid,
3113 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3114 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003115 }
3116 }
3117
3118 // Check if 2D with 3D and depth not equal to 2D layerCount
3119 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3120 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3121 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003122 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3123 skip |= LogError(command_buffer, vuid,
3124 "%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 -08003125 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003126 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003127 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3128 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3129 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003130 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3131 skip |= LogError(command_buffer, vuid,
3132 "%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 -08003133 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003134 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003135 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003136
3137 // Check for multi-plane format compatiblity
3138 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3139 size_t src_format_size = 0;
3140 size_t dst_format_size = 0;
3141 if (FormatIsMultiplane(src_format)) {
3142 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3143 src_format_size = FormatElementSize(planeFormat);
3144 } else {
3145 src_format_size = FormatElementSize(src_format);
3146 }
3147 if (FormatIsMultiplane(dst_format)) {
3148 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3149 dst_format_size = FormatElementSize(planeFormat);
3150 } else {
3151 dst_format_size = FormatElementSize(dst_format);
3152 }
3153 // If size is still zero, then format is invalid and will be caught in another VU
3154 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003155 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3156 skip |= LogError(command_buffer, vuid,
3157 "%s: pRegions[%u] called with non-compatible image formats. "
3158 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3159 func_name, i, string_VkFormat(src_format),
3160 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3161 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003162 }
3163 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003164 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003165
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003166 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3167 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3168 // because because both texels are 4 bytes in size.
3169 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003170 const char *compatible_vuid =
3171 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3172 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3173 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003174 // Depth/stencil formats must match exactly.
3175 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3176 if (src_format != dst_format) {
3177 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003178 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003179 string_VkFormat(src_format), string_VkFormat(dst_format));
3180 }
3181 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003182 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003183 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003184 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003185 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003186 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003187 FormatElementSize(dst_format));
3188 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003189 }
3190 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003191
Dave Houlton33c22b72017-02-28 13:16:02 -07003192 // Source and dest image sample counts must match
3193 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003194 std::stringstream ss;
3195 ss << func_name << " called on image pair with non-identical sample counts.";
3196 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
3197 skip |= LogError(command_buffer, vuid, "%s", ss.str().c_str());
Dave Houlton33c22b72017-02-28 13:16:02 -07003198 }
3199
Jeff Leger178b1e52020-10-05 12:22:23 -04003200 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127";
3201 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3202 vuid = is_2khr ? "" : "";
3203 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003204 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003205 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3206 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3207 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3208 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3209 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3210 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3211 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3212 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3213 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3214 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3215 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3216 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003217
3218 // Validation for VK_EXT_fragment_density_map
3219 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003220 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3221 skip |=
3222 LogError(command_buffer, vuid,
3223 "%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 +02003224 }
3225 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003226 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3227 skip |=
3228 LogError(command_buffer, vuid,
3229 "%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 +02003230 }
3231
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003232 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003233 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3234 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3235 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3236 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003237 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003238 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3239 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3240 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3241 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3242 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003243 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003244
3245 const char *invalid_src_layout_vuid =
3246 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3247 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3248 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3249 const char *invalid_dst_layout_vuid =
3250 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3251 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3252 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3253
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003254 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003255 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003256 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003257 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3258 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003259 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003260 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003261 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003262 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003263 }
3264
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003265 return skip;
3266}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003267
Jeff Leger178b1e52020-10-05 12:22:23 -04003268bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3269 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3270 const VkImageCopy *pRegions) const {
3271 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3272 COPY_COMMAND_VERSION_1);
3273}
3274
3275bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3276 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3277 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3278 COPY_COMMAND_VERSION_2);
3279}
3280
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003281void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3282 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3283 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003284 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3285 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003286 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003287 auto src_image_state = GetImageState(srcImage);
3288 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003289
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003290 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003291 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003292 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3293 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003294 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003295}
3296
Jeff Leger178b1e52020-10-05 12:22:23 -04003297void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3298 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3299 auto cb_node = GetCBState(commandBuffer);
3300 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3301 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3302
3303 // Make sure that all image slices are updated to correct layout
3304 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3305 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3306 pCopyImageInfo->srcImageLayout);
3307 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3308 pCopyImageInfo->dstImageLayout);
3309 }
3310}
3311
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003312// Returns true if sub_rect is entirely contained within rect
3313static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3314 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3315 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3316 return false;
3317 return true;
3318}
3319
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003320bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003321 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
3322 const VkRect2D &render_area, uint32_t rect_count,
3323 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003324 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003325 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3326 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06003327 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07003328 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003329
3330 for (uint32_t j = 0; j < rect_count; j++) {
3331 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003332 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3333 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3334 "the current render pass instance.",
3335 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003336 }
3337
3338 if (image_view_state) {
3339 // The layers specified by a given element of pRects must be contained within every attachment that
3340 // pAttachments refers to
3341 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3342 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3343 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003344 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3345 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3346 "of pAttachment[%d].",
3347 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003348 }
3349 }
3350 }
3351 return skip;
3352}
3353
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003354bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3355 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003356 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003357 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003358 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003359 if (!cb_node) return skip;
3360
3361 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3362 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3363 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003364 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003365
3366 // Validate that attachment is in reference list of active subpass
3367 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003368 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003369 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003370 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003371 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003372 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003373
John Zulauf3a548ef2019-02-01 16:14:07 -07003374 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3375 auto clear_desc = &pAttachments[attachment_index];
3376 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003377 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003378
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003379 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3380 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3381 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3382 attachment_index);
3383 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3384 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3385 skip |=
3386 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3387 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3388 attachment_index);
3389 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003390 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3391 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3392 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3393 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003394 skip |= LogError(
3395 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3396 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3397 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3398 attachment_index, clear_desc->colorAttachment,
3399 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3400 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003401
John Zulauff2582972019-02-09 14:53:30 -07003402 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3403 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003404 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003405 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3406 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3407 " subpass %u. colorAttachmentCount=%u",
3408 attachment_index, clear_desc->colorAttachment,
3409 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3410 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003411 }
John Zulauff2582972019-02-09 14:53:30 -07003412 fb_attachment = color_attachment;
3413
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003414 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3415 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3416 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3417 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3418 "of a color attachment.",
3419 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003420 }
3421 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003422 bool subpass_depth = false;
3423 bool subpass_stencil = false;
3424 if (subpass_desc->pDepthStencilAttachment &&
3425 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3426 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3427 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3428 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3429 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003430 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003431 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3432 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003433 skip |= LogError(
3434 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3435 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003436 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003437 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003438 }
3439 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003440 skip |= LogError(
3441 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3442 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003443 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003444 attachment_index);
3445 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003446 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003447 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003448 }
3449 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003450 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003451 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3452 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003453 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003454
3455 // Once the framebuffer attachment is found, can get the image view state
3456 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3457 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3458 const IMAGE_VIEW_STATE *image_view_state =
3459 GetAttachmentImageViewState(GetCBState(commandBuffer), framebuffer, fb_attachment);
3460 if (image_view_state != nullptr) {
3461 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3462 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3463 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3464 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3465 }
3466 }
John Zulauf441558b2019-08-12 11:47:39 -06003467 }
3468 }
3469 return skip;
3470}
3471
3472void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3473 const VkClearAttachment *pAttachments, uint32_t rectCount,
3474 const VkClearRect *pRects) {
3475 auto *cb_node = GetCBState(commandBuffer);
3476 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3477 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3478 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3479 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3480 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3481 const auto clear_desc = &pAttachments[attachment_index];
3482 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3483 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3484 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3485 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3486 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3487 subpass_desc->pDepthStencilAttachment) {
3488 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3489 }
3490 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003491 if (!clear_rect_copy) {
3492 // We need a copy of the clear rectangles that will persist until the last lambda executes
3493 // but we want to create it as lazily as possible
3494 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003495 }
John Zulauf441558b2019-08-12 11:47:39 -06003496 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3497 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003498 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003499 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003500 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003501 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3502 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003503 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
3504 clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003505 return skip;
3506 };
3507 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003508 }
3509 }
3510 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003511}
3512
Jeff Leger178b1e52020-10-05 12:22:23 -04003513template <typename RegionType>
3514bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3515 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3516 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003517 const auto *cb_node = GetCBState(commandBuffer);
3518 const auto *src_image_state = GetImageState(srcImage);
3519 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003520 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3521 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3522 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3523 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003524
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003525 bool skip = false;
3526 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003527 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3528 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3529 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3530 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3531 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3532 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3533 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3534 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3535 skip |= InsideRenderPass(cb_node, func_name, vuid);
3536 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3537 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3538 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3539 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3540 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3541 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3542 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3543 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003544
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003545 // Validation for VK_EXT_fragment_density_map
3546 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003547 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3548 skip |= LogError(cb_node->commandBuffer, vuid,
3549 "%s: srcImage must not have been created with flags containing "
3550 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3551 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003552 }
3553 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003554 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3555 skip |= LogError(cb_node->commandBuffer, vuid,
3556 "%s: dstImage must not have been created with flags containing "
3557 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3558 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003559 }
3560
Cort Stratton7df30962018-05-17 19:45:57 -07003561 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003562 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003563 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3564 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003565 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003566 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3567 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3568 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003569 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003570 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3571 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3572 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3573 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3574 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3575 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003576 // For each region, the number of layers in the image subresource should not be zero
3577 // For each region, src and dest image aspect must be color only
3578 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003579 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003580 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3581 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003582 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3583 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3584 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003585 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003586 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3587 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003588 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003589 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3590 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3591 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3592 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3593 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3594 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003595 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003596 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3597 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003598 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003599 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003600
3601 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003602 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003603 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3604 skip |=
3605 LogError(cb_node->commandBuffer, vuid,
3606 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003607 }
Cort Stratton7df30962018-05-17 19:45:57 -07003608 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003609 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3610 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003611 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3612 skip |= LogError(cb_node->commandBuffer, vuid,
3613 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3614 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003615 }
3616
3617 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3618 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3619
3620 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003621 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003622 LogObjectList objlist(cb_node->commandBuffer);
3623 objlist.add(src_image_state->image);
3624 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003625 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3626 skip |= LogError(objlist, vuid,
3627 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003628 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003629 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003630 }
3631 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3632 LogObjectList objlist(cb_node->commandBuffer);
3633 objlist.add(src_image_state->image);
3634 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003635 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3636 skip |= LogError(objlist, vuid,
3637 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003638 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003639 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003640 }
3641 }
3642
3643 if (VK_IMAGE_TYPE_1D == src_image_type) {
3644 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3645 LogObjectList objlist(cb_node->commandBuffer);
3646 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003647 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3648 skip |= LogError(objlist, vuid,
3649 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003650 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003651 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3652 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003653 }
3654 }
3655 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3656 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3657 LogObjectList objlist(cb_node->commandBuffer);
3658 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003659 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3660 skip |= LogError(objlist, vuid,
3661 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003662 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003663 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3664 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003665 }
3666 }
3667
3668 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3669 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3670 LogObjectList objlist(cb_node->commandBuffer);
3671 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003672 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3673 skip |= LogError(objlist, vuid,
3674 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003675 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003676 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3677 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003678 }
3679 }
3680 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3681 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3682 LogObjectList objlist(cb_node->commandBuffer);
3683 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003684 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3685 skip |= LogError(objlist, vuid,
3686 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003687 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003688 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3689 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003690 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003691 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003692
3693 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3694 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3695 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3696 // developer
3697 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3698 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3699 if ((extent_check & x_bit) != 0) {
3700 LogObjectList objlist(cb_node->commandBuffer);
3701 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003702 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3703 skip |= LogError(objlist, vuid,
3704 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003705 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003706 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003707 region.extent.width, subresource_extent.width);
3708 }
3709
3710 if ((extent_check & y_bit) != 0) {
3711 LogObjectList objlist(cb_node->commandBuffer);
3712 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003713 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3714 skip |= LogError(objlist, vuid,
3715 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003716 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003717 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003718 region.extent.height, subresource_extent.height);
3719 }
3720
3721 if ((extent_check & z_bit) != 0) {
3722 LogObjectList objlist(cb_node->commandBuffer);
3723 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003724 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3725 skip |= LogError(objlist, vuid,
3726 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003727 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003728 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003729 region.extent.depth, subresource_extent.depth);
3730 }
3731 }
3732
3733 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3734 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3735 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3736 // developer
3737 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3738 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3739 if ((extent_check & x_bit) != 0) {
3740 LogObjectList objlist(cb_node->commandBuffer);
3741 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003742 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3743 skip |= LogError(objlist, vuid,
3744 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003745 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003746 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003747 region.extent.width, subresource_extent.width);
3748 }
3749
3750 if ((extent_check & y_bit) != 0) {
3751 LogObjectList objlist(cb_node->commandBuffer);
3752 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003753 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3754 skip |= LogError(objlist, vuid,
3755 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003756 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003757 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003758 region.extent.height, subresource_extent.height);
3759 }
3760
3761 if ((extent_check & z_bit) != 0) {
3762 LogObjectList objlist(cb_node->commandBuffer);
3763 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003764 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3765 skip |= LogError(objlist, vuid,
3766 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003767 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003768 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003769 region.extent.depth, subresource_extent.depth);
3770 }
3771 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003772 }
3773
3774 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003775 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3776 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3777 func_name, string_VkFormat(src_image_state->createInfo.format),
3778 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003779 }
3780 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003781 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003782 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003783 string_VkImageType(src_image_state->createInfo.imageType),
3784 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003785 }
3786 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003787 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3788 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 -07003789 }
3790 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003791 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3792 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3793 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003794 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003795 } else {
3796 assert(0);
3797 }
3798 return skip;
3799}
3800
Jeff Leger178b1e52020-10-05 12:22:23 -04003801bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3802 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3803 const VkImageResolve *pRegions) const {
3804 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3805 COPY_COMMAND_VERSION_1);
3806}
3807
3808bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3809 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3810 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3811 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3812 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3813}
3814
3815template <typename RegionType>
3816bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3817 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3818 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003819 const auto *cb_node = GetCBState(commandBuffer);
3820 const auto *src_image_state = GetImageState(srcImage);
3821 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003822
Jeff Leger178b1e52020-10-05 12:22:23 -04003823 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3824 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3825 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3826
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003827 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003828 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003829 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003830 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003831 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003832 const char *vuid;
3833 const char *location;
3834 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3835 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3836 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3837 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3838 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3839 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3840 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3841 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3842 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3843 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3844 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3845 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3846 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3847 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3848 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3849 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3850 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3851 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3852 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3853 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3854 skip |= InsideRenderPass(cb_node, func_name, vuid);
3855 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3856 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3857 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3858 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3859 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3860 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3861 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3862 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3863 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3864 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003865
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003866 // Validation for VK_EXT_fragment_density_map
3867 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003868 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3869 skip |= LogError(cb_node->commandBuffer, vuid,
3870 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3871 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003872 }
3873 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003874 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3875 skip |= LogError(cb_node->commandBuffer, vuid,
3876 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3877 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003878 }
3879
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003880 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003881
Dave Houlton33c2d252017-06-09 17:08:32 -06003882 VkFormat src_format = src_image_state->createInfo.format;
3883 VkFormat dst_format = dst_image_state->createInfo.format;
3884 VkImageType src_type = src_image_state->createInfo.imageType;
3885 VkImageType dst_type = dst_image_state->createInfo.imageType;
3886
Cort Stratton186b1a22018-05-01 20:18:06 -04003887 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003888 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3889 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3890 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003891 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003892 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003893 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003894 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003895 }
3896
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003897 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003898 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3899 skip |= LogError(device, vuid,
3900 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003901 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003902 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003903 }
3904
3905 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003906 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3907 skip |= LogError(device, vuid,
3908 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003909 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003910 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003911 }
3912
Dave Houlton33c2d252017-06-09 17:08:32 -06003913 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003914 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3915 skip |= LogError(cb_node->commandBuffer, vuid,
3916 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003917 }
3918
Dave Houlton33c2d252017-06-09 17:08:32 -06003919 // Validate consistency for unsigned formats
3920 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3921 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003922 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003923 << "the other one must also have unsigned integer format. "
3924 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003925 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3926 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003927 }
3928
3929 // Validate consistency for signed formats
3930 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3931 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003932 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003933 << "the other one must also have signed integer format. "
3934 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003935 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3936 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003937 }
3938
3939 // Validate filter for Depth/Stencil formats
3940 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3941 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003942 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003943 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003944 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3945 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003946 }
3947
3948 // Validate aspect bits and formats for depth/stencil images
3949 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3950 if (src_format != dst_format) {
3951 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003952 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 -06003953 << "stencil, the other one must have exactly the same format. "
3954 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3955 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003956 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3957 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003958 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003959 } // Depth or Stencil
3960
3961 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003962 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003963 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3964 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3965 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3966 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3967 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3968 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003969 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003970 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3971 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3972 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3973 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3974 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3975 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003976 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003977 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003978 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003979 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003980 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003981 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3982 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003983 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003984 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3985 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3986 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3987 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3988 skip |=
3989 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3990 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3991 skip |=
3992 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3993 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003994 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003995 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3996 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003997 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003998 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003999 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004000 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4001 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004002 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004003 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004004 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004005 }
Dave Houlton48989f32017-05-26 15:01:46 -06004006 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4007 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004008 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004009 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004010 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004011 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004012
4013 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004014 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004015 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4016 skip |=
4017 LogError(cb_node->commandBuffer, vuid,
4018 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004019 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004020
Dave Houlton48989f32017-05-26 15:01:46 -06004021 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004022 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4023 skip |=
4024 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004025 }
Dave Houlton48989f32017-05-26 15:01:46 -06004026
Dave Houlton33c2d252017-06-09 17:08:32 -06004027 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004028 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
4029 skip |= LogError(cb_node->commandBuffer, vuid,
4030 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004031 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004032 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004033 }
4034
4035 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004036 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
4037 skip |= LogError(cb_node->commandBuffer, vuid,
4038 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4039 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004040 }
4041
Dave Houlton48989f32017-05-26 15:01:46 -06004042 // Validate source image offsets
4043 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004044 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004045 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004046 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
4047 skip |= LogError(cb_node->commandBuffer, vuid,
4048 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4049 "of (%1d, %1d). These must be (0, 1).",
4050 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004051 }
4052 }
4053
Dave Houlton33c2d252017-06-09 17:08:32 -06004054 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004055 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004056 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
4057 skip |= LogError(cb_node->commandBuffer, vuid,
4058 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4059 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4060 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004061 }
4062 }
4063
Dave Houlton33c2d252017-06-09 17:08:32 -06004064 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004065 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4066 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004067 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004068 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
4069 skip |= LogError(cb_node->commandBuffer, vuid,
4070 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4071 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004072 }
4073 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4074 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004075 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004076 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
4077 skip |= LogError(cb_node->commandBuffer, vuid,
4078 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4079 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004080 }
4081 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4082 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004083 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004084 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
4085 skip |= LogError(cb_node->commandBuffer, vuid,
4086 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4087 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004088 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004089 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004090 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4091 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4092 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004093 }
Dave Houlton48989f32017-05-26 15:01:46 -06004094
4095 // Validate dest image offsets
4096 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004097 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004098 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004099 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4100 skip |= LogError(cb_node->commandBuffer, vuid,
4101 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4102 "(%1d, %1d). These must be (0, 1).",
4103 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004104 }
4105 }
4106
Dave Houlton33c2d252017-06-09 17:08:32 -06004107 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004108 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004109 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4110 skip |= LogError(cb_node->commandBuffer, vuid,
4111 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004112 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004113 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004114 }
4115 }
4116
Dave Houlton33c2d252017-06-09 17:08:32 -06004117 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004118 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4119 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004120 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004121 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4122 skip |= LogError(cb_node->commandBuffer, vuid,
4123 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4124 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004125 }
4126 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4127 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004128 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004129 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4130 skip |= LogError(cb_node->commandBuffer, vuid,
4131 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4132 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004133 }
4134 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4135 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004136 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004137 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4138 skip |= LogError(cb_node->commandBuffer, vuid,
4139 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4140 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004141 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004142 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004143 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4144 skip |= LogError(cb_node->commandBuffer, vuid,
4145 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004146 }
4147
Dave Houlton33c2d252017-06-09 17:08:32 -06004148 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4149 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4150 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004151 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4152 skip |= LogError(cb_node->commandBuffer, vuid,
4153 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4154 "layerCount other than 1.",
4155 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004156 }
4157 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004158 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004159 } else {
4160 assert(0);
4161 }
4162 return skip;
4163}
4164
Jeff Leger178b1e52020-10-05 12:22:23 -04004165bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4166 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4167 const VkImageBlit *pRegions, VkFilter filter) const {
4168 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4169 COPY_COMMAND_VERSION_1);
4170}
4171
4172bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4173 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4174 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4175 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4176}
4177
4178template <typename RegionType>
4179void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4180 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4181 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004182 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004183 auto src_image_state = GetImageState(srcImage);
4184 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004185
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004186 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004187 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004188 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4189 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004190 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004191}
4192
Jeff Leger178b1e52020-10-05 12:22:23 -04004193void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4194 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4195 const VkImageBlit *pRegions, VkFilter filter) {
4196 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4197 pRegions, filter);
4198 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4199}
4200
4201void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4202 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4203 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4204 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4205 pBlitImageInfo->filter);
4206}
4207
John Zulauf2076e812020-01-08 14:55:54 -07004208GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4209 assert(map);
4210 // This approach allows for a single hash lookup or/create new
4211 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4212 if (inserted.second) {
4213 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004214 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004215 inserted.first->second.reset(layout_map);
4216 return layout_map;
4217 } else {
4218 assert(nullptr != inserted.first->second.get());
4219 return inserted.first->second.get();
4220 }
4221 return nullptr;
4222}
4223
4224const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4225 auto it = map.find(image);
4226 if (it != map.end()) {
4227 return it->second.get();
4228 }
4229 return nullptr;
4230}
4231
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004232// 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 -07004233bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4234 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004235 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004236 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07004237 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004238 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004239 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004240 for (const auto &layout_map_entry : pCB->image_layout_map) {
4241 const auto image = layout_map_entry.first;
4242 const auto *image_state = GetImageState(image);
4243 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004244 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004245 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004246 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004247 if (initial_layout_map.empty()) continue;
4248
4249 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
4250 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4251 if (global_map == nullptr) {
4252 global_map = &empty_map;
4253 }
4254
4255 // Note: don't know if it would matter
4256 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4257
4258 auto pos = initial_layout_map.begin();
4259 const auto end = initial_layout_map.end();
4260 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4261 pos->first.begin);
4262 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004263 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004264 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004265 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 -07004266 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004267 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004268 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004269 image_layout = current_layout->pos_B->lower_bound->second;
4270 }
4271 const auto intersected_range = pos->first & current_layout->range;
4272 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4273 // TODO: Set memory invalid which is in mem_tracker currently
4274 } else if (image_layout != initial_layout) {
4275 // Need to look up the inital layout *state* to get a bit more information
4276 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4277 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4278 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4279 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004280 // We can report all the errors for the intersected range directly
4281 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004282 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004283 skip |= LogError(
4284 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004285 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004286 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004287 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004288 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004289 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004290 }
4291 }
John Zulauf2076e812020-01-08 14:55:54 -07004292 if (pos->first.includes(intersected_range.end)) {
4293 current_layout.seek(intersected_range.end);
4294 } else {
4295 ++pos;
4296 if (pos != end) {
4297 current_layout.seek(pos->first.begin);
4298 }
4299 }
John Zulauff660ad62019-03-23 07:16:05 -06004300 }
4301
locke-lunargf155ccf2020-02-18 11:34:15 -07004302 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004303 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004304 }
John Zulauff660ad62019-03-23 07:16:05 -06004305
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004306 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004307}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004308
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004309void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004310 for (const auto &layout_map_entry : pCB->image_layout_map) {
4311 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004312 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004313 const auto *image_state = GetImageState(image);
4314 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004315 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4316 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004317 }
4318}
4319
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004320// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004321// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4322// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004323bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4324 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06004325 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004326 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004327 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4328
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004329 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004330 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4331 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004332 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004333 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4334 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4335 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004336 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004337 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004338 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004339 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4340 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4341 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004342 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004343 string_VkImageLayout(first_layout));
4344 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4345 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004346 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004347 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004348 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004349 }
4350 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004351
4352 // Same as above for loadOp, but for stencilLoadOp
4353 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4354 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4355 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4356 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4357 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004358 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004359 string_VkImageLayout(first_layout));
4360 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4361 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4362 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004363 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004364 string_VkImageLayout(first_layout));
4365 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4366 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4367 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004368 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004369 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004370 }
4371 }
4372
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004373 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004374}
4375
Mark Lobodzinski96210742017-02-09 10:33:46 -07004376// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4377// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004378template <typename T1>
4379bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4380 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4381 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004382 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004383 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004384 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004385 if (strict) {
4386 correct_usage = ((actual & desired) == desired);
4387 } else {
4388 correct_usage = ((actual & desired) != 0);
4389 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004390
Mark Lobodzinski96210742017-02-09 10:33:46 -07004391 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004392 // All callers should have a valid VUID
4393 assert(msgCode != kVUIDUndefined);
4394 skip =
4395 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4396 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004397 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004398 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004399}
4400
4401// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4402// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004403bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004404 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004405 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004406 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004407}
4408
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004409bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004410 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004411 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004412 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4413 if ((image_format_features & desired) != desired) {
4414 // Same error, but more details if it was an AHB external format
4415 if (image_state->has_ahb_format == true) {
4416 skip |= LogError(image_state->image, vuid,
4417 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4418 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4419 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004420 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004421 } else {
4422 skip |= LogError(image_state->image, vuid,
4423 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4424 "with tiling %s.",
4425 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4426 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4427 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004428 }
4429 }
4430 return skip;
4431}
4432
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004433bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004434 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004435 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004436 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004437 // layerCount must not be zero
4438 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004439 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4440 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004441 }
4442 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004443 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004444 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4445 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004446 }
4447 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004448 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 -07004449 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4450 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4451 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4452 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004453 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004454 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4455 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4456 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4457 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4458 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4459 member);
4460 }
Cort Strattond619a302018-05-17 19:46:32 -07004461 return skip;
4462}
4463
Mark Lobodzinski96210742017-02-09 10:33:46 -07004464// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4465// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004466bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004467 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004468 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004469 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004470}
4471
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004472bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004473 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004474 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004475
4476 const VkDeviceSize &range = pCreateInfo->range;
4477 if (range != VK_WHOLE_SIZE) {
4478 // Range must be greater than 0
4479 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004480 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004481 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004482 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4483 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004484 }
4485 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004486 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4487 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004488 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004489 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004490 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4491 "(%" PRIu32 ").",
4492 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004493 }
4494 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004495 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004496 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004497 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004498 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4499 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4500 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004501 }
4502 // The sum of range and offset must be less than or equal to the size of buffer
4503 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004504 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004505 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004506 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4507 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4508 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004509 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004510 } else {
4511 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4512
4513 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4514 // VkPhysicalDeviceLimits::maxTexelBufferElements
4515 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4516 device_limits->maxTexelBufferElements) {
4517 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4518 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4519 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4520 "), divided by the element size of the format (%" PRIu32
4521 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4522 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4523 device_limits->maxTexelBufferElements);
4524 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004525 }
4526 return skip;
4527}
4528
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004529bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004530 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004531 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004532 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4533 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004534 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004535 "vkCreateBufferView(): If buffer was created with `usage` containing "
4536 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004537 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004538 }
4539 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4540 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004541 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004542 "vkCreateBufferView(): If buffer was created with `usage` containing "
4543 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004544 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004545 }
4546 return skip;
4547}
4548
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004549bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004550 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004551 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004552
Dave Houltond8ed0212018-05-16 17:18:24 -06004553 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004554
Jeff Bolz87697532019-01-11 22:54:00 -06004555 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4556 if (chained_devaddr_struct) {
4557 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4558 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004559 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4560 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4561 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004562 }
4563 }
4564
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004565 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4566 if (chained_opaqueaddr_struct) {
4567 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4568 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004569 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4570 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4571 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004572 }
4573 }
4574
Shannon McPherson4984e642019-12-05 13:04:34 -07004575 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004576 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4577 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004578 skip |= LogError(
4579 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004580 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4581 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4582 }
4583
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004584 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004585 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4586 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4587 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004588 }
4589
sfricke-samsungedce77a2020-07-03 22:35:13 -07004590 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4591 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4592 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4593 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4594 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4595 }
4596 const VkBufferCreateFlags invalid_flags =
4597 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4598 if ((pCreateInfo->flags & invalid_flags) != 0) {
4599 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4600 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4601 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4602 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4603 }
4604 }
4605
Mark Lobodzinski96210742017-02-09 10:33:46 -07004606 return skip;
4607}
4608
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004609bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004610 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004611 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004612 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004613 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4614 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004615 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004616 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4617 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004618 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004619 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4620 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4621 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004622
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004623 // Buffer view offset must be less than the size of buffer
4624 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004625 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004626 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004627 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4628 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004629 }
4630
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004631 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004632 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4633 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4634 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004635 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4636 : "VUID-VkBufferViewCreateInfo-offset-00926";
4637 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004638 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004639 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4640 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004641 }
4642
4643 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4644 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4645 if ((elementSize % 3) == 0) {
4646 elementSize /= 3;
4647 }
4648 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4649 VkDeviceSize alignmentRequirement =
4650 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4651 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4652 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4653 }
4654 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004655 skip |= LogError(
4656 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004657 "vkCreateBufferView(): If buffer was created with usage containing "
4658 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004659 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4660 ") must be a multiple of the lesser of "
4661 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4662 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4663 "(%" PRId32
4664 ") is VK_TRUE, the size of a texel of the requested format. "
4665 "If the size of a texel is a multiple of three bytes, then the size of a "
4666 "single component of format is used instead",
4667 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4668 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4669 }
4670 }
4671 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4672 VkDeviceSize alignmentRequirement =
4673 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4674 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4675 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4676 }
4677 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004678 skip |= LogError(
4679 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004680 "vkCreateBufferView(): If buffer was created with usage containing "
4681 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004682 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4683 ") must be a multiple of the lesser of "
4684 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4685 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4686 "(%" PRId32
4687 ") is VK_TRUE, the size of a texel of the requested format. "
4688 "If the size of a texel is a multiple of three bytes, then the size of a "
4689 "single component of format is used instead",
4690 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4691 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4692 }
4693 }
4694 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004695
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004696 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004697
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004698 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004699 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004700 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004701}
4702
Mark Lobodzinski602de982017-02-09 11:01:33 -07004703// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004704bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004705 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004706 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004707 const IMAGE_STATE *image_state = GetImageState(image);
4708 // checks color format and (single-plane or non-disjoint)
4709 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004710 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004711 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004712 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 -07004713 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004714 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 -07004715 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004716 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004717 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004718 skip |= LogError(image, vuid,
4719 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4720 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4721 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004722 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004723 skip |= LogError(image, vuid,
4724 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4725 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4726 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004727 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004728 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004729 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004730 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 -07004731 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004732 skip |=
4733 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 -07004734 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004735 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004736 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004737 skip |=
4738 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 -07004739 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004740 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4741 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004742 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004743 } else if (FormatIsMultiplane(format)) {
4744 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4745 if (3 == FormatPlaneCount(format)) {
4746 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4747 }
4748 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004749 skip |=
4750 LogError(image, vuid,
4751 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4752 "set, where n = [0, 1, 2].",
4753 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004754 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004755 }
4756 return skip;
4757}
4758
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004759bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4760 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004761 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4762 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004763 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004764
4765 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004766 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004767 skip |= LogError(image, errorCodes.base_mip_err,
4768 "%s: %s.baseMipLevel (= %" PRIu32
4769 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4770 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004771 }
Petr Kraus4d718682017-05-18 03:38:41 +02004772
Petr Krausffa94af2017-08-08 21:46:02 +02004773 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4774 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004775 skip |=
4776 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004777 } else {
4778 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004779
Petr Krausffa94af2017-08-08 21:46:02 +02004780 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004781 skip |= LogError(image, errorCodes.mip_count_err,
4782 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4783 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4784 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4785 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004786 }
Petr Kraus4d718682017-05-18 03:38:41 +02004787 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004788 }
Petr Kraus4d718682017-05-18 03:38:41 +02004789
4790 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004791 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004792 skip |= LogError(image, errorCodes.base_layer_err,
4793 "%s: %s.baseArrayLayer (= %" PRIu32
4794 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4795 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004796 }
Petr Kraus4d718682017-05-18 03:38:41 +02004797
Petr Krausffa94af2017-08-08 21:46:02 +02004798 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4799 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004800 skip |=
4801 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004802 } else {
4803 const uint64_t necessary_layer_count =
4804 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004805
Petr Krausffa94af2017-08-08 21:46:02 +02004806 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004807 skip |= LogError(image, errorCodes.layer_count_err,
4808 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4809 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4810 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4811 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004812 }
Petr Kraus4d718682017-05-18 03:38:41 +02004813 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004814 }
Petr Kraus4d718682017-05-18 03:38:41 +02004815
Mark Lobodzinski602de982017-02-09 11:01:33 -07004816 return skip;
4817}
4818
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004819bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004820 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004821 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004822 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4823 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4824 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4825
4826 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4827 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4828
4829 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004830 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4831 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004832 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004833 : "VUID-VkImageViewCreateInfo-image-01482")
4834 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4835 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004836 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004837 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4838 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004839
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004840 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004841 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004842 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004843}
4844
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004845bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004846 const VkImageSubresourceRange &subresourceRange,
4847 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004848 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004849 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4850 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4851 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4852 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004853
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004854 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004855 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004856 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004857}
4858
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004859bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004860 const VkImageSubresourceRange &subresourceRange,
4861 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004862 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004863 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4864 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4865 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4866 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004867
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004868 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004869 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4870 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004871}
4872
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004873bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004874 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004875 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004876 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004877 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4878 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4879 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4880 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004881
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004882 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004883 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004884}
4885
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004886bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4887 const VkImageUsageFlags image_usage) const {
4888 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4889 bool skip = false;
4890
4891 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4892 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4893
4894 if (image_state->has_ahb_format == true) {
4895 // AHB image view and image share same feature sets
4896 tiling_features = image_state->format_features;
4897 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4898 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4899 assert(device_extensions.vk_ext_image_drm_format_modifier);
4900 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4901 nullptr};
4902 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4903
4904 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4905 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4906 nullptr};
4907 format_properties_2.pNext = (void *)&drm_properties_list;
4908 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4909
4910 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4911 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4912 0) {
4913 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4914 }
4915 }
4916 } else {
4917 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4918 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4919 : format_properties.optimalTilingFeatures;
4920 }
4921
4922 if (tiling_features == 0) {
4923 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4924 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4925 "physical device.",
4926 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4927 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4928 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4929 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4930 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4931 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4932 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4933 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4934 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4935 "VK_IMAGE_USAGE_STORAGE_BIT.",
4936 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4937 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4938 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4939 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4940 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4941 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4942 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4943 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4944 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4945 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4946 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4947 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4948 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4949 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4950 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4951 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4952 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4953 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4954 }
4955
4956 return skip;
4957}
4958
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004959bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004960 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004961 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004962 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004963 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004964 skip |=
4965 ValidateImageUsageFlags(image_state,
4966 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4967 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004968 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4969 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4970 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004971 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004972 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004973 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004974 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004975 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004976 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004977 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004978 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004979
4980 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4981 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004982 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004983 VkFormat view_format = pCreateInfo->format;
4984 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004985 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004986 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004987
Dave Houltonbd2e2622018-04-10 16:41:14 -06004988 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004989 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004990 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004991 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004992 if (!device_extensions.vk_ext_separate_stencil_usage) {
4993 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004994 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4995 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4996 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004997 }
4998 } else {
4999 const auto image_stencil_struct =
5000 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
5001 if (image_stencil_struct == nullptr) {
5002 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005003 skip |= LogError(
5004 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005005 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5006 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5007 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5008 }
5009 } else {
5010 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5011 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5012 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005013 skip |= LogError(
5014 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005015 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5016 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5017 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5018 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5019 }
5020 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5021 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005022 skip |= LogError(
5023 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005024 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5025 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5026 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5027 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5028 }
5029 }
5030 }
5031 }
5032
Dave Houltonbd2e2622018-04-10 16:41:14 -06005033 image_usage = chained_ivuci_struct->usage;
5034 }
5035
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005036 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5037 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005038 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005039 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005040 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005041 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005042 std::stringstream ss;
5043 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005044 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005045 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005046 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005047 }
5048 } else {
Nathaniel Cesario0046c312020-10-07 23:28:28 -06005049 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005050 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5051 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005052 const char *error_vuid;
5053 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5054 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5055 } else if ((device_extensions.vk_khr_maintenance2) &&
5056 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5057 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5058 } else if ((!device_extensions.vk_khr_maintenance2) &&
5059 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5060 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5061 } else {
5062 // both enabled
5063 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5064 }
Dave Houltonc7988072018-04-16 11:46:56 -06005065 std::stringstream ss;
5066 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005067 << " is not in the same format compatibility class as "
5068 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005069 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5070 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005071 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005072 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005073 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005074 }
5075 } else {
5076 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005077 // Unless it is a multi-planar color bit aspect
5078 if ((image_format != view_format) &&
5079 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5080 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5081 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005082 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005083 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005084 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005085 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005086 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005087 }
5088 }
5089
5090 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005091 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005092
5093 switch (image_type) {
5094 case VK_IMAGE_TYPE_1D:
5095 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005096 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5097 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5098 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005099 }
5100 break;
5101 case VK_IMAGE_TYPE_2D:
5102 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5103 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5104 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005105 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5106 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5107 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005108 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005109 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5110 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5111 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005112 }
5113 }
5114 break;
5115 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005116 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005117 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5118 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5119 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005120 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005121 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5122 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5123 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005124 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5125 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005126 skip |= LogError(
5127 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5128 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5129 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5130 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5131 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005132 }
5133 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005134 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5135 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5136 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005137 }
5138 }
5139 } else {
5140 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005141 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5142 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5143 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005144 }
5145 }
5146 break;
5147 default:
5148 break;
5149 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005150
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005151 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005152 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005153 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005154 }
5155
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005156 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005157
Jeff Bolz9af91c52018-09-01 21:53:57 -05005158 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5159 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005160 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5161 "vkCreateImageView() If image was created with usage containing "
5162 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
5163 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005164 }
5165 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005166 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5167 "vkCreateImageView() If image was created with usage containing "
5168 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005169 }
5170 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005171
5172 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5173 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5174 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5175 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5176 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5177 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5178 }
5179 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5180 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5181 skip |= LogError(
5182 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5183 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5184 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5185 }
5186 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005187
5188 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5189 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005190 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005191 "vkCreateImageView(): If image was created with usage containing "
5192 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5193 pCreateInfo->subresourceRange.levelCount);
5194 }
5195 }
5196 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5197 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005198 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005199 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5200 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5201 }
5202 } else {
5203 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5204 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5205 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005206 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005207 "vkCreateImageView(): If image was created with usage containing "
5208 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5209 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5210 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5211 }
5212 }
5213 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005214
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005215 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5216 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5217 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5218 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5219 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5220 }
5221 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5222 skip |=
5223 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5224 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5225 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5226 }
5227 }
5228 if (device_extensions.vk_ext_fragment_density_map_2) {
5229 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5230 (pCreateInfo->subresourceRange.layerCount >
5231 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5232 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5233 "vkCreateImageView(): If image was created with flags containing "
5234 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5235 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5236 pCreateInfo->subresourceRange.layerCount,
5237 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5238 }
5239 }
5240
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005241 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5242 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5243 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5244 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5245 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5246 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5247 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5248 }
5249 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005250 }
5251 return skip;
5252}
5253
Jeff Leger178b1e52020-10-05 12:22:23 -04005254template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005255bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005256 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005257 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005258 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5259 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5260 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005261
5262 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5263 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5264 VkDeviceSize src_min = UINT64_MAX;
5265 VkDeviceSize src_max = 0;
5266 VkDeviceSize dst_min = UINT64_MAX;
5267 VkDeviceSize dst_max = 0;
5268
5269 for (uint32_t i = 0; i < regionCount; i++) {
5270 src_min = std::min(src_min, pRegions[i].srcOffset);
5271 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5272 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5273 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5274
5275 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5276 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005277 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5278 skip |= LogError(src_buffer_state->buffer, vuid,
5279 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5280 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005281 }
5282
5283 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5284 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005285 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5286 skip |= LogError(dst_buffer_state->buffer, vuid,
5287 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5288 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005289 }
5290
5291 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5292 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005293 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5294 skip |= LogError(src_buffer_state->buffer, vuid,
5295 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005296 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005297 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005298 }
5299
5300 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5301 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005302 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5303 skip |= LogError(dst_buffer_state->buffer, vuid,
5304 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005305 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005306 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005307 }
5308 }
5309
5310 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5311 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5312 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005313 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5314 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5315 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005316 }
5317 }
5318
5319 return skip;
5320}
5321
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005322bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005323 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005324 const auto cb_node = GetCBState(commandBuffer);
5325 const auto src_buffer_state = GetBufferState(srcBuffer);
5326 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005327
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005328 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005329 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5330 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005331 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005332 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005333 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5334 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005335 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005336 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5337 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005338 skip |=
5339 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5340 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005341 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5342 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005343 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005344 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5345 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5346 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005347 return skip;
5348}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005349
Jeff Leger178b1e52020-10-05 12:22:23 -04005350bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5351 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5352 const auto cb_node = GetCBState(commandBuffer);
5353 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5354 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5355
5356 bool skip = false;
5357 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5358 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5359 // Validate that SRC & DST buffers have correct usage flags set
5360 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5361 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5362 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5363 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5364 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5365 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5366 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5367 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5368 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5369 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5370 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5371 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5372 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5373 skip |=
5374 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5375 skip |=
5376 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5377 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5378 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5379 return skip;
5380}
5381
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005382bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005383 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005384 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005385 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005386 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005387 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5388 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005389 }
5390 }
5391 return skip;
5392}
5393
Jeff Bolz5c801d12019-10-09 10:38:45 -05005394bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5395 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005396 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005397 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005398
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005399 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005400 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005401 skip |=
5402 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005403 }
5404 return skip;
5405}
5406
Jeff Bolz5c801d12019-10-09 10:38:45 -05005407bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005408 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005409
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005410 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005411 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005412 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005413 }
5414 return skip;
5415}
5416
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005417bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005418 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005419 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005420 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005421 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005422 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005423 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005424 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005425 }
5426 return skip;
5427}
5428
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005429bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005430 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005431 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005432 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005433 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005434 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005435 skip |=
5436 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5437 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005438 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005439 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005440 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5441 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005442 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005443
sfricke-samsung022fa252020-07-24 03:26:16 -07005444 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5445 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5446
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005447 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005448 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5449 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5450 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5451 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005452 }
5453
5454 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005455 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5456 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5457 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5458 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005459 }
5460
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005461 return skip;
5462}
5463
Jeff Leger178b1e52020-10-05 12:22:23 -04005464template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005465bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005466 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005467 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005468 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005469 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5470 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005471
sfricke-samsung125d2b42020-05-28 06:32:43 -07005472 assert(image_state != nullptr);
5473 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005474
5475 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005476 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005477 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5478 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005479 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(199, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005480 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5481 "and 1, respectively.",
5482 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005483 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005484 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005485
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005486 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5487 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005488 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(201, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005489 "%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 -07005490 "must be 0 and 1, respectively.",
5491 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005492 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005493 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005494
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005495 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5496 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005497 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(213, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005498 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005499 "For 3D images these must be 0 and 1, respectively.",
5500 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005501 }
5502 }
5503
5504 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005505 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005506 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005507
sfricke-samsung125d2b42020-05-28 06:32:43 -07005508 // If not depth/stencil and not multi-plane
5509 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5510 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005511 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? GetBufferImageCopyCommandVUID(1558, image_to_buffer, is_2khr)
5512 : GetBufferImageCopyCommandVUID(193, image_to_buffer, is_2khr);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005513 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005514 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005515 " must be a multiple of this format's texel size (%" PRIu32 ").",
5516 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005517 }
5518
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005519 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5520 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005521 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005522 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005523 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005524 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005525 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005526 }
5527
5528 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5529 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005530 vuid =
5531 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04005532 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005533 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005534 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5535 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005536 }
5537
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005538 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005539 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005540 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005541 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 -06005542 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5543 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005544 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(197, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005545 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005546 "zero or <= image subresource width (%d).",
5547 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005548 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005549 }
5550
5551 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005552 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 -06005553 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5554 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005555 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(198, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005556 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005557 "zero or <= image subresource height (%d).",
5558 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005559 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005560 }
5561
5562 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005563 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 -06005564 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5565 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005566 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(200, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005567 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005568 "zero or <= image subresource depth (%d).",
5569 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005570 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005571 }
5572
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005573 // subresource aspectMask must have exactly 1 bit set
5574 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005575 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005576 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005577 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5578 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005579 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005580 }
5581
5582 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005583 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005584 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005585 LogError(image_state->image, GetBufferImageCopyCommandVUID(211, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005586 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5587 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005588 }
5589
5590 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005591 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5592 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005593
5594 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005595 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005596 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005597 LogError(image_state->image, GetBufferImageCopyCommandVUID(203, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005598 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5599 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005600 }
5601
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005602 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005603 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005604 skip |= LogError(
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005605 image_state->image, GetBufferImageCopyCommandVUID(204, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005606 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005607 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005608 }
5609
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005610 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005611 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5612 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5613 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005614 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(205, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005615 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005616 "width & height (%d, %d)..",
5617 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5618 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005619 }
5620
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005621 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005622 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005623 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005624 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(206, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005625 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005626 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5627 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005628 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005629
5630 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005631 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005632 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005633 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005634 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(207, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005635 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005636 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5637 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5638 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005639 }
5640
5641 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005642 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005643 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005644 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(208, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005645 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005646 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5647 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5648 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005649 }
5650
5651 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005652 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005653 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005654 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(209, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005655 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005656 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5657 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5658 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005659 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005660 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005661
5662 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005663 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005664 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005665 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005666 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(1560, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005667 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005668 "format has three planes.",
5669 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005670 }
5671
5672 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005673 if (0 ==
5674 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005675 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID(1560, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005676 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005677 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5678 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005679 } else {
5680 // Know aspect mask is valid
5681 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5682 const uint32_t compatible_size = FormatElementSize(compatible_format);
5683 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5684 skip |= LogError(
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005685 image_state->image, GetBufferImageCopyCommandVUID(1559, image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005686 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005687 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5688 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5689 string_VkFormat(compatible_format));
5690 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005691 }
5692 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005693 }
5694
5695 return skip;
5696}
5697
Jeff Leger178b1e52020-10-05 12:22:23 -04005698template <typename BufferImageCopyRegionType>
5699bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5700 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005701 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005702 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005703
5704 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005705 VkExtent3D extent = pRegions[i].imageExtent;
5706 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005707
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005708 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5709 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005710 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5711 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5712 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005713 }
5714
5715 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5716
5717 // 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 -06005718 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005719 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005720 if (image_extent.width % block_extent.width) {
5721 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5722 }
5723 if (image_extent.height % block_extent.height) {
5724 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5725 }
5726 if (image_extent.depth % block_extent.depth) {
5727 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5728 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005729 }
5730
Dave Houltonfc1a4052017-04-27 14:32:45 -06005731 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005732 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005733 }
5734 }
5735
5736 return skip;
5737}
5738
Jeff Leger178b1e52020-10-05 12:22:23 -04005739template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005740bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005741 const BufferImageCopyRegionType *pRegions, const char *func_name,
5742 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005743 bool skip = false;
5744
5745 VkDeviceSize buffer_size = buff_state->createInfo.size;
5746
5747 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005748 VkDeviceSize max_buffer_offset =
5749 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5750 if (buffer_size < max_buffer_offset) {
5751 skip |=
5752 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 -07005753 }
5754 }
5755
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005756 return skip;
5757}
5758
Jeff Leger178b1e52020-10-05 12:22:23 -04005759template <typename BufferImageCopyRegionType>
5760bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5761 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5762 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005763 const auto cb_node = GetCBState(commandBuffer);
5764 const auto src_image_state = GetImageState(srcImage);
5765 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005766
Jeff Leger178b1e52020-10-05 12:22:23 -04005767 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5768 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5769 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5770 const char *vuid;
5771
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005772 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005773
5774 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005775 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005776
5777 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005778 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005779
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005780 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005781
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005782 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005783 vuid =
5784 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5785 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5786 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5787 "or transfer capabilities.",
5788 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005789 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005790 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5791 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5792 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5793 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005794
Jeff Leger178b1e52020-10-05 12:22:23 -04005795 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5796 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5797 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5798
5799 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5800 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5801 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5802 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005803
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005804 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005805 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5806 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005807 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005808 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5809 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005810 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005811 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5812 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5813 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5814 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5815 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5816 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005817
5818 // Validation for VK_EXT_fragment_density_map
5819 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005820 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5821 skip |= LogError(cb_node->commandBuffer, vuid,
5822 "%s: srcImage must not have been created with flags containing "
5823 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5824 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005825 }
5826
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005827 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005828 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5829 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005830 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005831 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5832 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005833 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005834
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005835 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 -04005836 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5837 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5838 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5839 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5840
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005841 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005842 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5843 vuid =
5844 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005845 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005846 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5847 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5848 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5849 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5850 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5851 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5852 "imageSubresource", vuid);
5853 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5854 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005855 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005856 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005857 }
5858 return skip;
5859}
5860
Jeff Leger178b1e52020-10-05 12:22:23 -04005861bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5862 VkBuffer dstBuffer, uint32_t regionCount,
5863 const VkBufferImageCopy *pRegions) const {
5864 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5865 COPY_COMMAND_VERSION_1);
5866}
5867
5868bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5869 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5870 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5871 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5872 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5873}
5874
John Zulauf1686f232019-07-09 16:27:11 -06005875void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5876 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5877 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5878
5879 auto cb_node = GetCBState(commandBuffer);
5880 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005881 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005882 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005883 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005884 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005885}
5886
Jeff Leger178b1e52020-10-05 12:22:23 -04005887void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5888 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5889 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5890
5891 auto cb_node = GetCBState(commandBuffer);
5892 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5893 // Make sure that all image slices record referenced layout
5894 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5895 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5896 pCopyImageToBufferInfo->srcImageLayout);
5897 }
5898}
5899
5900template <typename RegionType>
5901bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5902 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5903 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005904 const auto cb_node = GetCBState(commandBuffer);
5905 const auto src_buffer_state = GetBufferState(srcBuffer);
5906 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005907
Jeff Leger178b1e52020-10-05 12:22:23 -04005908 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5909 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5910 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5911 const char *vuid;
5912
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005913 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005914
5915 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005916 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005917
sfricke-samsungea4fd142020-10-17 23:51:59 -07005918 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5919 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5920
Jeff Leger178b1e52020-10-05 12:22:23 -04005921 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5922 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5923 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5924 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5925
5926 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5927 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5928 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5929 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5930 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5931 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5932 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5933 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5934 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005935 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005936 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5937 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005938 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005939 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5940 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5941 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5942 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5943 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5944 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005945
5946 // Validation for VK_EXT_fragment_density_map
5947 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005948 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5949 skip |= LogError(cb_node->commandBuffer, vuid,
5950 "%s: dstImage must not have been created with flags containing "
5951 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5952 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005953 }
5954
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005955 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005956 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
5957 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005958 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005959 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
5960 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005961 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005962
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005963 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 -04005964 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
5965 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
5966 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
5967 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
5968
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005969 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005970 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5971 vuid =
5972 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005973 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005974 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
5975 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
5976 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
5977 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
5978 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
5979 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5980 "imageSubresource", vuid);
5981 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
5982 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005983 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005984 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07005985
5986 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5987 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5988 assert(command_pool != nullptr);
5989 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5990 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5991 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
5992 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
5993 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
5994 LogObjectList objlist(cb_node->commandBuffer);
5995 objlist.add(command_pool->commandPool);
5996 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
5997 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
5998 skip |= LogError(dst_image_state->image, vuid,
5999 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6000 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6001 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
6002 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
6003 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
6004 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006005 }
6006 return skip;
6007}
6008
Jeff Leger178b1e52020-10-05 12:22:23 -04006009bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6010 VkImageLayout dstImageLayout, uint32_t regionCount,
6011 const VkBufferImageCopy *pRegions) const {
6012 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6013 COPY_COMMAND_VERSION_1);
6014}
6015
6016bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6017 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6018 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6019 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6020 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6021}
6022
John Zulauf1686f232019-07-09 16:27:11 -06006023void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6024 VkImageLayout dstImageLayout, uint32_t regionCount,
6025 const VkBufferImageCopy *pRegions) {
6026 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6027
6028 auto cb_node = GetCBState(commandBuffer);
6029 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006030 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006031 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006032 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006033 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006034}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006035
Jeff Leger178b1e52020-10-05 12:22:23 -04006036void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6037 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6038 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6039
6040 auto cb_node = GetCBState(commandBuffer);
6041 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6042 // Make sure that all image slices are record referenced layout
6043 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6044 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6045 pCopyBufferToImageInfo2KHR->dstImageLayout);
6046 }
6047}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006048bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006049 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006050 bool skip = false;
6051 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6052
Dave Houlton1d960ff2018-01-19 12:17:05 -07006053 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006054 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6055 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6056 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006057 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6058 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006059 }
6060
John Zulaufa26d3c82019-08-14 16:09:08 -06006061 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006062 if (!image_entry) {
6063 return skip;
6064 }
6065
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006066 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6067 if (device_extensions.vk_ext_image_drm_format_modifier) {
6068 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6069 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006070 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6071 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6072 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006073 }
6074 } else {
6075 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006076 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6077 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006078 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006079 }
6080
Dave Houlton1d960ff2018-01-19 12:17:05 -07006081 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006082 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006083 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6084 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6085 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006086 }
6087
Dave Houlton1d960ff2018-01-19 12:17:05 -07006088 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006089 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006090 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6091 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6092 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006093 }
6094
Dave Houlton1d960ff2018-01-19 12:17:05 -07006095 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006096 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006097 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6098 if (FormatIsMultiplane(img_format)) {
6099 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
6100 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6101 if (FormatPlaneCount(img_format) > 2u) {
6102 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
6103 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6104 }
6105 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006106 skip |= LogError(image, vuid,
6107 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6108 ") must be a single-plane specifier flag.",
6109 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006110 }
6111 } else if (FormatIsColor(img_format)) {
6112 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006113 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6114 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6115 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006116 }
6117 } else if (FormatIsDepthOrStencil(img_format)) {
6118 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6119 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006120 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006121 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6122 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6123 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6124 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006125 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6126 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6127 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006128 }
6129 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006130
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006131 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006132 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006133 }
6134
Mike Weiblen672b58b2017-02-21 14:32:53 -07006135 return skip;
6136}
sfricke-samsung022fa252020-07-24 03:26:16 -07006137
6138// Validates the image is allowed to be protected
6139bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
6140 const char *vuid) const {
6141 bool skip = false;
6142 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6143 LogObjectList objlist(cb_state->commandBuffer);
6144 objlist.add(image_state->image);
6145 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image", cmd_name,
6146 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6147 report_data->FormatHandle(image_state->image).c_str());
6148 }
6149 return skip;
6150}
6151
6152// Validates the image is allowed to be unprotected
6153bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
6154 const char *vuid) const {
6155 bool skip = false;
6156 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6157 LogObjectList objlist(cb_state->commandBuffer);
6158 objlist.add(image_state->image);
6159 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image", cmd_name,
6160 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6161 report_data->FormatHandle(image_state->image).c_str());
6162 }
6163 return skip;
6164}
6165
6166// Validates the buffer is allowed to be protected
6167bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6168 const char *vuid) const {
6169 bool skip = false;
6170 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6171 LogObjectList objlist(cb_state->commandBuffer);
6172 objlist.add(buffer_state->buffer);
6173 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer", cmd_name,
6174 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6175 report_data->FormatHandle(buffer_state->buffer).c_str());
6176 }
6177 return skip;
6178}
6179
6180// Validates the buffer is allowed to be unprotected
6181bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6182 const char *vuid) const {
6183 bool skip = false;
6184 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6185 LogObjectList objlist(cb_state->commandBuffer);
6186 objlist.add(buffer_state->buffer);
6187 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer", cmd_name,
6188 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6189 report_data->FormatHandle(buffer_state->buffer).c_str());
6190 }
6191 return skip;
6192}