blob: 357e8e7cf7051150ed3227bf19e09c83764f0745 [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
John Zulauff660ad62019-03-23 07:16:05 -060041// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
42static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
43 VkImageSubresourceRange subresource_range;
44 subresource_range.aspectMask = subresource_layers.aspectMask;
45 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
46 subresource_range.layerCount = subresource_layers.layerCount;
47 subresource_range.baseMipLevel = subresource_layers.mipLevel;
48 subresource_range.levelCount = 1;
49 return subresource_range;
50}
51
John Zulaufb58415b2019-12-09 15:02:32 -070052static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
53 const auto format = create_info.format;
54 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
55 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
56 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
57 } else {
58 init_range.aspectMask =
59 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
60 }
61 return NormalizeSubresourceRange(create_info, init_range);
62}
63
locke-lunargcac25742020-08-25 16:15:40 -060064std::vector<VkImageView> FRAMEBUFFER_STATE::GetUsedAttachments(
65 const safe_VkSubpassDescription2 &subpasses, const std::vector<IMAGE_VIEW_STATE *> &imagelessFramebufferAttachments) {
locke-lunarg540b2252020-08-03 13:23:36 -060066 std::vector<VkImageView> attachment_views(createInfo.attachmentCount, VK_NULL_HANDLE);
67
locke-lunargcac25742020-08-25 16:15:40 -060068 const bool imageless = (createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) ? true : false;
69
locke-lunarg540b2252020-08-03 13:23:36 -060070 for (uint32_t index = 0; index < subpasses.inputAttachmentCount; ++index) {
locke-lunargcac25742020-08-25 16:15:40 -060071 const uint32_t attachment_index = subpasses.pInputAttachments[index].attachment;
72 if (attachment_index != VK_ATTACHMENT_UNUSED) {
73 if (imageless) {
74 attachment_views[attachment_index] = imagelessFramebufferAttachments[attachment_index]->image_view;
75 } else {
76 attachment_views[attachment_index] = createInfo.pAttachments[attachment_index];
77 }
locke-lunarg540b2252020-08-03 13:23:36 -060078 }
79 }
80 for (uint32_t index = 0; index < subpasses.colorAttachmentCount; ++index) {
locke-lunargcac25742020-08-25 16:15:40 -060081 const uint32_t attachment_index = subpasses.pColorAttachments[index].attachment;
82 if (attachment_index != VK_ATTACHMENT_UNUSED) {
83 if (imageless) {
84 attachment_views[attachment_index] = imagelessFramebufferAttachments[attachment_index]->image_view;
85 } else {
86 attachment_views[attachment_index] = createInfo.pAttachments[attachment_index];
87 }
locke-lunarg540b2252020-08-03 13:23:36 -060088 }
locke-lunargcac25742020-08-25 16:15:40 -060089 if (subpasses.pResolveAttachments) {
90 const uint32_t attachment_index2 = subpasses.pResolveAttachments[index].attachment;
91 if (attachment_index2 != VK_ATTACHMENT_UNUSED) {
92 if (imageless) {
93 attachment_views[attachment_index2] = imagelessFramebufferAttachments[attachment_index2]->image_view;
94 } else {
95 attachment_views[attachment_index2] = createInfo.pAttachments[attachment_index2];
96 }
97 }
locke-lunarg540b2252020-08-03 13:23:36 -060098 }
99 }
locke-lunargcac25742020-08-25 16:15:40 -0600100 if (subpasses.pDepthStencilAttachment) {
101 const uint32_t attachment_index = subpasses.pDepthStencilAttachment->attachment;
102 if (attachment_index != VK_ATTACHMENT_UNUSED) {
103 if (imageless) {
104 attachment_views[attachment_index] = imagelessFramebufferAttachments[attachment_index]->image_view;
105 } else {
106 attachment_views[attachment_index] = createInfo.pAttachments[attachment_index];
107 }
108 }
locke-lunarg540b2252020-08-03 13:23:36 -0600109 }
110 return attachment_views;
111}
112
locke-lunarg296a3c92020-03-25 01:04:29 -0600113IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -0600114 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -0700115 safe_create_info(pCreateInfo),
116 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -0600117 valid(false),
118 acquired(false),
119 shared_presentable(false),
120 layout_locked(false),
121 get_sparse_reqs_called(false),
122 sparse_metadata_required(false),
123 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -0600124 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700125 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -0600126 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700127 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -0600128 create_from_swapchain(VK_NULL_HANDLE),
129 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -0600130 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700131 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -0700132 disjoint(false),
133 plane0_memory_requirements_checked(false),
134 plane1_memory_requirements_checked(false),
135 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -0600136 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -0600137 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -0600138 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
unknown08c57af2019-06-21 16:33:35 -0600139 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600140 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
141 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
142 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
143 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
144 }
145 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
146 }
147
148 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
149 sparse = true;
150 }
Locked8af3732019-05-10 09:47:56 -0600151
sfricke-samsunge2441192019-11-06 14:07:57 -0800152 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
153 if (externalMemoryInfo) {
154 external_memory_handle = externalMemoryInfo->handleTypes;
155 }
John Zulauff660ad62019-03-23 07:16:05 -0600156}
157
unknown2c877272019-07-11 12:56:50 -0600158bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
159 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
160 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
161 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
162 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
163 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
164 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600165 return is_equal &&
166 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600167}
168
Jeff Bolz82f854d2019-09-17 14:56:47 -0500169// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
170bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
171 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
172 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
173 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
174 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
175 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600176 is_compatible = is_compatible &&
177 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
178 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500179
180 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
181 createInfo.extent.height <= other_createInfo.extent.height &&
182 createInfo.extent.depth <= other_createInfo.extent.depth &&
183 createInfo.arrayLayers <= other_createInfo.arrayLayers;
184 return is_compatible;
185}
186
unknown2c877272019-07-11 12:56:50 -0600187bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700188 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
189 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
190 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700191 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
192 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600193 IsCreateInfoEqual(other_image_state->createInfo)) {
194 return true;
195 }
unknowne1661522019-07-11 13:04:18 -0600196 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
197 return true;
198 }
unknown2c877272019-07-11 12:56:50 -0600199 return false;
200}
201
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500202IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
203 : image_view(iv),
204 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700205 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600206 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500207 samplerConversion(VK_NULL_HANDLE),
208 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600209 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
210 if (conversionInfo) samplerConversion = conversionInfo->conversion;
211 if (image_state) {
212 // A light normalization of the createInfo range
213 auto &sub_res_range = create_info.subresourceRange;
214 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
215 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
216
217 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700218 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500219 samples = image_state->createInfo.samples;
220 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600221 }
222}
223
locke-lunarg540b2252020-08-03 13:23:36 -0600224bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600225 if (image_view == compare_view.image_view) {
226 return true;
227 }
locke-lunargdc287022020-08-21 12:03:57 -0600228 if (image_state->image != compare_view.image_state->image) {
229 return false;
230 }
locke-lunarg540b2252020-08-03 13:23:36 -0600231 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
232 return false;
233 }
234
235 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600236 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600237 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600238 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600239 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600240 }
241
242 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600243 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600244 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600245 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600246 }
247
248 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600249 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600250 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600251 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600252 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600253 }
254
255 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600256 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600257 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600258 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600259 }
locke-lunargdc287022020-08-21 12:03:57 -0600260 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600261}
262
Dave Houltond9611312018-11-19 17:03:36 -0700263uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
264 // uint cast applies floor()
265 return 1u + (uint32_t)log2(std::max({height, width, depth}));
266}
267
268uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
269
270uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
271
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500272bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700273 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700274 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700275
John Zulauf2076e812020-01-08 14:55:54 -0700276 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
277 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700278 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
279 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
280
John Zulauf2076e812020-01-08 14:55:54 -0700281 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
282
283 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
284 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700285 return false;
286 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700287
John Zulauf2076e812020-01-08 14:55:54 -0700288 for (auto entry : *layout_range_map) {
289 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700290 }
291 return true;
292}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700293
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600294// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600295void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600296 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
297 VkImageLayout expected_layout) {
298 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
299 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600300 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600301 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700302 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700303 for (const auto &image : image_state.aliasing_images) {
304 auto alias_state = GetImageState(image);
305 // The map state of the aliases should all be in sync, so no need to check the return value
306 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
307 assert(subresource_map);
308 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
309 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700310}
John Zulauff660ad62019-03-23 07:16:05 -0600311
312// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600313void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600314 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500315 return;
316 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500317 IMAGE_STATE *image_state = view_state.image_state.get();
318 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700319 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700320 for (const auto &image : image_state->aliasing_images) {
321 image_state = GetImageState(image);
322 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
323 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
324 }
John Zulauff660ad62019-03-23 07:16:05 -0600325}
326
327// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600328void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600329 const VkImageSubresourceRange &range, VkImageLayout layout) {
330 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
331 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600332 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700333 for (const auto &image : image_state.aliasing_images) {
334 auto alias_state = GetImageState(image);
335 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
336 assert(subresource_map);
337 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
338 }
John Zulauff660ad62019-03-23 07:16:05 -0600339}
340
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600341void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600342 VkImageLayout layout) {
343 const IMAGE_STATE *image_state = GetImageState(image);
344 if (!image_state) return;
345 SetImageInitialLayout(cb_node, *image_state, range, layout);
346};
347
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600348void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600349 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
350 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600351}
Dave Houltonddd65c52018-05-08 14:58:01 -0600352
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600353// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700354void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
355 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500356 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600357
John Zulauff660ad62019-03-23 07:16:05 -0600358 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600359 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
360 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600361 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 -0600362 sub_range.baseArrayLayer = 0;
363 sub_range.layerCount = image_state->createInfo.extent.depth;
364 }
365
Piers Daniell4fde9b72019-11-27 16:19:46 -0700366 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
367 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
368 SetImageLayout(cb_node, *image_state, sub_range, layout);
369 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
370 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
371 } else {
372 SetImageLayout(cb_node, *image_state, sub_range, layout);
373 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600374}
375
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700376bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
377 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700378 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600379 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100380 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700381 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100382 const char *vuid;
383 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700384 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100385
386 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600387 LogObjectList objlist(image);
388 objlist.add(renderpass);
389 objlist.add(framebuffer);
390 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700391 skip |=
392 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
393 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
394 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
395 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100396 return skip;
397 }
398
399 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200400 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
401 if (stencil_usage_info) {
402 image_usage |= stencil_usage_info->stencilUsage;
403 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100404
405 // Check for layouts that mismatch image usages in the framebuffer
406 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800407 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600408 LogObjectList objlist(image);
409 objlist.add(renderpass);
410 objlist.add(framebuffer);
411 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700412 skip |= LogError(objlist, vuid,
413 "%s: Layout/usage mismatch for attachment %u in %s"
414 " - the %s is %s but the image attached to %s via %s"
415 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
416 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
417 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
418 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100419 }
420
421 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
422 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800423 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600424 LogObjectList objlist(image);
425 objlist.add(renderpass);
426 objlist.add(framebuffer);
427 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700428 skip |= LogError(objlist, vuid,
429 "%s: Layout/usage mismatch for attachment %u in %s"
430 " - the %s is %s but the image attached to %s via %s"
431 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
432 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
433 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
434 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100435 }
436
437 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800438 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600439 LogObjectList objlist(image);
440 objlist.add(renderpass);
441 objlist.add(framebuffer);
442 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700443 skip |= LogError(objlist, vuid,
444 "%s: Layout/usage mismatch for attachment %u in %s"
445 " - the %s is %s but the image attached to %s via %s"
446 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
447 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
448 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
449 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100450 }
451
452 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800453 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600454 LogObjectList objlist(image);
455 objlist.add(renderpass);
456 objlist.add(framebuffer);
457 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700458 skip |= LogError(objlist, vuid,
459 "%s: Layout/usage mismatch for attachment %u in %s"
460 " - the %s is %s but the image attached to %s via %s"
461 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
462 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
463 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
464 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100465 }
466
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600467 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100468 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
469 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
470 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
471 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
472 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800473 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600474 LogObjectList objlist(image);
475 objlist.add(renderpass);
476 objlist.add(framebuffer);
477 objlist.add(image_view);
478 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700479 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700480 " - the %s is %s but the image attached to %s via %s"
481 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700482 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700483 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
484 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100485 }
486 } else {
487 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
488 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
489 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
490 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600491 LogObjectList objlist(image);
492 objlist.add(renderpass);
493 objlist.add(framebuffer);
494 objlist.add(image_view);
495 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700496 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700497 " - the %s is %s but the image attached to %s via %s"
498 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700499 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700500 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
501 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100502 }
503 }
504 return skip;
505}
506
John Zulauf17a01bb2019-08-09 16:41:19 -0600507bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700508 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600509 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600510 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700511 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700512 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100513 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100514
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700515 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100516 auto framebuffer = framebuffer_state->framebuffer;
517
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700518 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700519 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
520 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700521 }
John Zulauf8e308292018-09-21 11:34:37 -0600522
Tobias Hectorc9057422019-07-23 12:15:52 +0100523 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
524 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
525 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100526 }
527
Tobias Hectorc9057422019-07-23 12:15:52 +0100528 if (attachments != nullptr) {
529 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
530 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
531 auto image_view = attachments[i];
532 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100533
Tobias Hectorc9057422019-07-23 12:15:52 +0100534 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600535 LogObjectList objlist(pRenderPassBegin->renderPass);
536 objlist.add(framebuffer_state->framebuffer);
537 objlist.add(image_view);
538 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700539 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
540 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
541 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100542 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100543 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100544
545 const VkImage image = view_state->create_info.image;
546 const IMAGE_STATE *image_state = GetImageState(image);
547
548 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600549 LogObjectList objlist(pRenderPassBegin->renderPass);
550 objlist.add(framebuffer_state->framebuffer);
551 objlist.add(image_view);
552 objlist.add(image);
553 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700554 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
555 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
556 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100557 continue;
558 }
559 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
560 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
561
Piers Daniell7f894f62020-01-09 16:33:48 -0700562 // Default to expecting stencil in the same layout.
563 auto attachment_stencil_initial_layout = attachment_initial_layout;
564
565 // If a separate layout is specified, look for that.
566 const auto *attachment_description_stencil_layout =
567 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
568 if (attachment_description_stencil_layout) {
569 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
570 }
571
Tobias Hectorc9057422019-07-23 12:15:52 +0100572 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
573 // in common with the non-const version.)
574 const ImageSubresourceLayoutMap *subresource_map =
575 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
576
577 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
578 LayoutUseCheckAndMessage layout_check(subresource_map);
579 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700580 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
581 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
582 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700583
John Zulauf5e617452019-11-19 14:44:16 -0700584 // Allow for differing depth and stencil layouts
585 VkImageLayout check_layout = attachment_initial_layout;
586 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
587
588 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700589 subres_skip |= LogError(
590 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700591 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
592 "and the %s layout of the attachment is %s. The layouts must match, or the render "
593 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700594 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100595 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700596 }
John Zulauf5e617452019-11-19 14:44:16 -0700597
Tobias Hectorc9057422019-07-23 12:15:52 +0100598 skip |= subres_skip;
599 }
600
601 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
602 framebuffer, render_pass, i, "initial layout");
603
604 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
605 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100606 }
607
Tobias Hectorc9057422019-07-23 12:15:52 +0100608 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
609 auto &subpass = pRenderPassInfo->pSubpasses[j];
610 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
611 auto &attachment_ref = subpass.pInputAttachments[k];
612 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
613 auto image_view = attachments[attachment_ref.attachment];
614 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100615
Tobias Hectorc9057422019-07-23 12:15:52 +0100616 if (view_state) {
617 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700618 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
619 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100620 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100621 }
622 }
623 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100624
Tobias Hectorc9057422019-07-23 12:15:52 +0100625 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
626 auto &attachment_ref = subpass.pColorAttachments[k];
627 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
628 auto image_view = attachments[attachment_ref.attachment];
629 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100630
Tobias Hectorc9057422019-07-23 12:15:52 +0100631 if (view_state) {
632 auto image = view_state->create_info.image;
633 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
634 framebuffer, render_pass, attachment_ref.attachment,
635 "color attachment layout");
636 if (subpass.pResolveAttachments) {
637 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
638 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
639 attachment_ref.attachment, "resolve attachment layout");
640 }
641 }
642 }
643 }
644
645 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
646 auto &attachment_ref = *subpass.pDepthStencilAttachment;
647 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
648 auto image_view = attachments[attachment_ref.attachment];
649 auto view_state = GetImageViewState(image_view);
650
651 if (view_state) {
652 auto image = view_state->create_info.image;
653 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
654 framebuffer, render_pass, attachment_ref.attachment,
655 "input attachment layout");
656 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100657 }
658 }
659 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700660 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600661 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700662}
663
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600664void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700665 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700666 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700667 IMAGE_VIEW_STATE *image_view = nullptr;
668 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
669 const auto attachment_info =
670 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
671 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
672 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300673 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700674 }
John Zulauf8e308292018-09-21 11:34:37 -0600675 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700676 VkImageLayout stencil_layout = kInvalidLayout;
677 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
678 if (attachment_reference_stencil_layout) {
679 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
680 }
681
682 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600683 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700684 }
685}
686
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600687void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
688 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700689 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700690
691 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700692 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700693 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700694 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700695 }
696 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700697 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700698 }
699 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700700 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700701 }
702 }
703}
704
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700705// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
706// 1. Transition into initialLayout state
707// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600708void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700709 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700710 // First transition into initialLayout
711 auto const rpci = render_pass_state->createInfo.ptr();
712 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700713 IMAGE_VIEW_STATE *view_state = nullptr;
714 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
715 const auto attachment_info =
716 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
717 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
718 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300719 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700720 }
John Zulauf8e308292018-09-21 11:34:37 -0600721 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700722 VkImageLayout stencil_layout = kInvalidLayout;
723 const auto *attachment_description_stencil_layout =
724 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
725 if (attachment_description_stencil_layout) {
726 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
727 }
728
729 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600730 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700731 }
732 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700733 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700734}
735
Dave Houlton10b39482017-03-16 13:18:15 -0600736bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600737 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600738 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600739 }
740 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600741 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600742 }
743 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600744 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600745 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700746 if (0 !=
747 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
748 if (FormatPlaneCount(format) == 1) return false;
749 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600750 return true;
751}
752
Mike Weiblen62d08a32017-03-07 22:18:27 -0700753// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200754bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
755 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600756 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700757 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200758 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600759 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700760
761 switch (layout) {
762 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
763 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600764 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700765 }
766 break;
767 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
768 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600769 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700770 }
771 break;
772 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
773 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600774 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700775 }
776 break;
777 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
778 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600779 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700780 }
781 break;
782 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
783 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600784 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700785 }
786 break;
787 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
788 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600789 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700790 }
791 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600792 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500793 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
794 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
795 }
796 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700797 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
798 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
799 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
800 }
801 break;
802 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
803 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
804 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
805 }
806 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700807 default:
808 // Other VkImageLayout values do not have VUs defined in this context.
809 break;
810 }
811
Dave Houlton8e9f6542018-05-18 12:18:22 -0600812 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700813 skip |= LogError(img_barrier.image, msg_code,
814 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
815 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
816 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700817 }
818 return skip;
819}
820
821// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600822bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
823 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700824 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700825
Petr Krausad0096a2019-08-09 18:35:04 +0200826 // Scoreboard for checking for duplicate and inconsistent barriers to images
827 struct ImageBarrierScoreboardEntry {
828 uint32_t index;
829 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
830 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
831 const VkImageMemoryBarrier *barrier;
832 };
833 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
834 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
835
John Zulauf463c51e2018-05-31 13:29:20 -0600836 // Scoreboard for duplicate layout transition barriers within the list
837 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
838 ImageBarrierScoreboardImageMap layout_transitions;
839
Mike Weiblen62d08a32017-03-07 22:18:27 -0700840 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200841 const auto &img_barrier = pImageMemoryBarriers[i];
842 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700843
John Zulauf463c51e2018-05-31 13:29:20 -0600844 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
845 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
846 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200847 if (img_barrier.oldLayout != img_barrier.newLayout) {
848 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
849 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600850 if (image_it != layout_transitions.end()) {
851 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200852 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600853 if (subres_it != subres_map.end()) {
854 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200855 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
856 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
857 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700858 skip = LogError(
859 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200860 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600861 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
862 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200863 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
864 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
865 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600866 }
867 entry = new_entry;
868 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200869 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600870 }
871 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200872 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600873 }
874 }
875
Petr Krausad0096a2019-08-09 18:35:04 +0200876 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600877 if (image_state) {
878 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200879 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
880 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600881
882 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
883 if (image_state->layout_locked) {
884 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700885 skip |= LogError(
886 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700887 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600888 " 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 -0700889 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200890 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600891 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600892
John Zulaufa4472282019-08-22 14:44:34 -0600893 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700894 const VkFormat image_format = image_create_info.format;
895 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600896 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700897 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700898 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600899 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
900 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700901 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
902 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
903 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
904 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700905 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600906 }
907 } else {
908 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
909 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700910 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
911 ? "VUID-VkImageMemoryBarrier-image-03320"
912 : "VUID-VkImageMemoryBarrier-image-01207";
913 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700914 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
915 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
916 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700917 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600918 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700919 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700920 }
John Zulauff660ad62019-03-23 07:16:05 -0600921
Petr Krausad0096a2019-08-09 18:35:04 +0200922 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
923 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600924 // TODO: Set memory invalid which is in mem_tracker currently
925 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
926 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600927 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600928 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600929 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200930 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700931 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
932 const auto &value = *pos;
933 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700934 subres_skip = LogError(
935 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700936 "%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 -0700937 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700938 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -0700939 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
940 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600941 }
John Zulauf5e617452019-11-19 14:44:16 -0700942 }
John Zulauff660ad62019-03-23 07:16:05 -0600943 skip |= subres_skip;
944 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700945
946 // checks color format and (single-plane or non-disjoint)
947 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
948 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700949 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700950 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
951 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
952 ? "VUID-VkImageMemoryBarrier-image-01671"
953 : "VUID-VkImageMemoryBarrier-image-02902";
954 skip |= LogError(img_barrier.image, vuid,
955 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
956 "but its aspectMask is 0x%" PRIx32 ".",
957 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
958 string_VkFormat(image_format), aspect_mask);
959 }
960 }
961
962 VkImageAspectFlags valid_disjoint_mask =
963 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 -0700964 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700965 ((aspect_mask & valid_disjoint_mask) == 0)) {
966 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
967 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
968 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
969 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
970 string_VkFormat(image_format), aspect_mask);
971 }
972
973 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
974 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
975 "%s: Image barrier %s references %s of format %s has only two planes but included "
976 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
977 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
978 string_VkFormat(image_format), aspect_mask);
979 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700980 }
981 }
982 return skip;
983}
984
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600985bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200986 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700987
Jeff Bolz6835fda2019-10-06 00:15:34 -0500988 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200989 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700990}
991
John Zulauf6b4aae82018-05-09 13:03:36 -0600992template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600993bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
994 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600995 using BarrierRecord = QFOTransferBarrier<Barrier>;
996 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500997 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600998 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
999 const char *barrier_name = BarrierRecord::BarrierName();
1000 const char *handle_name = BarrierRecord::HandleName();
1001 const char *transfer_type = nullptr;
1002 for (uint32_t b = 0; b < barrier_count; b++) {
1003 if (!IsTransferOp(&barriers[b])) continue;
1004 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001005 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001006 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001007 const auto found = barrier_sets.release.find(barriers[b]);
1008 if (found != barrier_sets.release.cend()) {
1009 barrier_record = &(*found);
1010 transfer_type = "releasing";
1011 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001012 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001013 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001014 const auto found = barrier_sets.acquire.find(barriers[b]);
1015 if (found != barrier_sets.acquire.cend()) {
1016 barrier_record = &(*found);
1017 transfer_type = "acquiring";
1018 }
1019 }
1020 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001021 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1022 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1023 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1024 func_name, barrier_name, b, transfer_type, handle_name,
1025 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1026 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001027 }
1028 }
1029 return skip;
1030}
1031
John Zulaufa4472282019-08-22 14:44:34 -06001032VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1033 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1034}
1035
1036const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1037 return device_state.GetImageState(barrier.image);
1038}
1039
1040VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1041 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1042}
1043
1044const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1045 return device_state.GetBufferState(barrier.buffer);
1046}
1047
1048VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1049
John Zulauf6b4aae82018-05-09 13:03:36 -06001050template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001051void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1052 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001053 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001054 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1055 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001056 auto &barrier = barriers[b];
1057 if (IsTransferOp(&barrier)) {
1058 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001059 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001060 barrier_sets.release.emplace(barrier);
1061 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001062 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001063 barrier_sets.acquire.emplace(barrier);
1064 }
1065 }
1066
1067 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1068 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1069 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1070 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1071 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1072 auto handle_state = BarrierHandleState(*this, barrier);
1073 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1074 if (!mode_concurrent) {
1075 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001076 cb_state->queue_submit_functions.emplace_back(
1077 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1078 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1079 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1080 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001081 });
1082 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001083 }
1084 }
1085}
1086
John Zulaufa4472282019-08-22 14:44:34 -06001087bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001088 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001089 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001090 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001091 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001092 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1093 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001094 return skip;
1095}
1096
John Zulaufa4472282019-08-22 14:44:34 -06001097void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1098 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1099 const VkImageMemoryBarrier *pImageMemBarriers) {
1100 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1101 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001102}
1103
1104template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001105bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001106 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001107 // Record to the scoreboard or report that we have a duplication
1108 bool skip = false;
1109 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1110 if (!inserted.second && inserted.first->second != cb_state) {
1111 // 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 -06001112 LogObjectList objlist(cb_state->commandBuffer);
1113 objlist.add(barrier.handle);
1114 objlist.add(inserted.first->second->commandBuffer);
1115 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001116 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1117 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1118 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1119 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1120 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001121 }
1122 return skip;
1123}
1124
1125template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001126bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1127 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001128 using BarrierRecord = QFOTransferBarrier<Barrier>;
1129 using TypeTag = typename BarrierRecord::Tag;
1130 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001131 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001132 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001133 const char *barrier_name = BarrierRecord::BarrierName();
1134 const char *handle_name = BarrierRecord::HandleName();
1135 // No release should have an extant duplicate (WARNING)
1136 for (const auto &release : cb_barriers.release) {
1137 // Check the global pending release barriers
1138 const auto set_it = global_release_barriers.find(release.handle);
1139 if (set_it != global_release_barriers.cend()) {
1140 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1141 const auto found = set_for_handle.find(release);
1142 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001143 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1144 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1145 " to dstQueueFamilyIndex %" PRIu32
1146 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1147 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1148 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001149 }
1150 }
1151 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1152 }
1153 // Each acquire must have a matching release (ERROR)
1154 for (const auto &acquire : cb_barriers.acquire) {
1155 const auto set_it = global_release_barriers.find(acquire.handle);
1156 bool matching_release_found = false;
1157 if (set_it != global_release_barriers.cend()) {
1158 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1159 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1160 }
1161 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001162 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1163 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1164 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1165 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1166 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001167 }
1168 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1169 }
1170 return skip;
1171}
1172
John Zulauf3b04ebd2019-07-18 14:08:11 -06001173bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001174 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001175 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001176 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001177 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1178 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001179 return skip;
1180}
1181
1182template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001183void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001184 using BarrierRecord = QFOTransferBarrier<Barrier>;
1185 using TypeTag = typename BarrierRecord::Tag;
1186 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001187 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001188
1189 // Add release barriers from this submit to the global map
1190 for (const auto &release : cb_barriers.release) {
1191 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1192 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1193 global_release_barriers[release.handle].insert(release);
1194 }
1195
1196 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1197 for (const auto &acquire : cb_barriers.acquire) {
1198 // NOTE: We're not using [] because we don't want to create entries for missing releases
1199 auto set_it = global_release_barriers.find(acquire.handle);
1200 if (set_it != global_release_barriers.end()) {
1201 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1202 set_for_handle.erase(acquire);
1203 if (set_for_handle.size() == 0) { // Clean up empty sets
1204 global_release_barriers.erase(set_it);
1205 }
1206 }
1207 }
1208}
1209
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001210void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001211 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1212 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001213}
1214
John Zulauf6b4aae82018-05-09 13:03:36 -06001215// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001216void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001217
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001218void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001219 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001220 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001221 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001222
Chris Forbes4de4b132017-08-21 11:27:08 -07001223 // For ownership transfers, the barrier is specified twice; as a release
1224 // operation on the yielding queue family, and as an acquire operation
1225 // on the acquiring queue family. This barrier may also include a layout
1226 // transition, which occurs 'between' the two operations. For validation
1227 // purposes it doesn't seem important which side performs the layout
1228 // transition, but it must not be performed twice. We'll arbitrarily
1229 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001230 //
1231 // However, we still need to record initial layout for the "initial layout" validation
1232 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001233
Petr Krausad0096a2019-08-09 18:35:04 +02001234 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001235 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001236 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001237 }
1238}
1239
unknown86bcb3a2019-07-11 13:05:36 -06001240void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001241 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001242 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1243 const auto &image_create_info = image_state->createInfo;
1244
1245 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1246 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1247 // for all (potential) layer sub_resources.
1248 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1249 normalized_isr.baseArrayLayer = 0;
1250 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1251 }
1252
Michael Spang8af7c102020-05-03 20:50:09 -04001253 VkImageLayout initial_layout = mem_barrier.oldLayout;
1254
1255 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001256 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001257 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1258 }
1259
John Zulauf2be3fe02019-12-30 09:48:02 -07001260 if (is_release_op) {
1261 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1262 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001263 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001264 }
unknown86bcb3a2019-07-11 13:05:36 -06001265}
1266
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001267bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1268 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1269 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1270 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001271 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001272 assert(cb_node);
1273 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001274 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001275 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001276
John Zulauff660ad62019-03-23 07:16:05 -06001277 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1278 if (subresource_map) {
1279 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001280 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001281 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1282 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001283 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001284 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1285 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1286 "%s layout %s.",
1287 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1288 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1289 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001290 }
John Zulauf5e617452019-11-19 14:44:16 -07001291 }
John Zulauff660ad62019-03-23 07:16:05 -06001292 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001293 }
John Zulauff660ad62019-03-23 07:16:05 -06001294
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001295 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1296 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1297 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001298 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1299 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001300 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1301 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1302 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001303 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001304 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001305 if (image_state->shared_presentable) {
1306 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001307 skip |=
1308 LogError(device, layout_invalid_msg_code,
1309 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1310 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001311 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001312 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001313 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001314 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001315 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1316 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1317 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1318 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001319 }
1320 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001321 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001322}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001323bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001324 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1325 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001326 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001327 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1328 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1329}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001330
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001331void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001332 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001333 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001334 if (!renderPass) return;
1335
Tobias Hectorbbb12282018-10-22 15:17:59 +01001336 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001337 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001338 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001339 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001340 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1341 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1342 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1343 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001344 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001345 }
John Zulauf8e308292018-09-21 11:34:37 -06001346 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001347 VkImageLayout stencil_layout = kInvalidLayout;
1348 const auto *attachment_description_stencil_layout =
1349 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1350 if (attachment_description_stencil_layout) {
1351 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1352 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001353 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001354 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001355 }
1356 }
1357}
Dave Houltone19e20d2018-02-02 16:32:41 -07001358
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001359#ifdef VK_USE_PLATFORM_ANDROID_KHR
1360// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1361// This could also move into a seperate core_validation_android.cpp file... ?
1362
1363//
1364// AHB-specific validation within non-AHB APIs
1365//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001366bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001367 bool skip = false;
1368
1369 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1370 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001371 if (0 != ext_fmt_android->externalFormat) {
1372 if (VK_FORMAT_UNDEFINED != create_info->format) {
1373 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001374 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1375 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1376 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001377 }
1378
1379 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001380 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1381 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1382 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001383 }
1384
1385 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001386 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1387 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001388 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1389 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1390 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001391 }
1392
1393 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001394 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1395 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1396 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001397 }
1398 }
1399
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001400 if ((0 != ext_fmt_android->externalFormat) &&
1401 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001402 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001403 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1404 ") which has "
1405 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1406 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001407 }
1408 }
1409
Dave Houltond9611312018-11-19 17:03:36 -07001410 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001411 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001412 skip |=
1413 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1414 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1415 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001416 }
1417 }
1418
1419 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1420 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1421 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001422 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001423 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1424 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1425 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1426 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001427 }
1428
1429 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001430 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1431 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1432 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1433 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1434 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001435 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001436 }
1437
1438 return skip;
1439}
1440
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001441bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001442 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001443 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001444
1445 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001446 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001447 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1448 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001449 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001450 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001451 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001452
Dave Houltond9611312018-11-19 17:03:36 -07001453 // Chain must include a compatible ycbcr conversion
1454 bool conv_found = false;
1455 uint64_t external_format = 0;
1456 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1457 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001458 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001459 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001460 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001461 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001462 }
Dave Houltond9611312018-11-19 17:03:36 -07001463 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001464 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001465 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001466 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1467 "an externalFormat (%" PRIu64
1468 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1469 "with the same external format.",
1470 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001471 }
1472
1473 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001474 if (IsIdentitySwizzle(create_info->components) == false) {
1475 skip |= LogError(
1476 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1477 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1478 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1479 "= %s.",
1480 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1481 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001482 }
1483 }
Dave Houltond9611312018-11-19 17:03:36 -07001484
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001485 return skip;
1486}
1487
John Zulaufa26d3c82019-08-14 16:09:08 -06001488bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001489 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001490
John Zulaufa26d3c82019-08-14 16:09:08 -06001491 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001492 if (image_state != nullptr) {
1493 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1494 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1495 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1496 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1497 "bound to memory.");
1498 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001499 }
1500 return skip;
1501}
1502
1503#else
1504
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001505bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001506 return false;
1507}
1508
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001509bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001510
John Zulaufa26d3c82019-08-14 16:09:08 -06001511bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001512
1513#endif // VK_USE_PLATFORM_ANDROID_KHR
1514
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001515bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1516 bool skip = false;
1517
1518 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1519 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1520 const VkImageTiling image_tiling = pCreateInfo->tiling;
1521 const VkFormat image_format = pCreateInfo->format;
1522
1523 if (image_format == VK_FORMAT_UNDEFINED) {
1524 // VU 01975 states format can't be undefined unless an android externalFormat
1525#ifdef VK_USE_PLATFORM_ANDROID_KHR
1526 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1527 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1528 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1529 if (it != ahb_ext_formats_map.end()) {
1530 tiling_features = it->second;
1531 }
1532 }
1533#endif
1534 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1535 uint64_t drm_format_modifier = 0;
1536 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1537 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1538 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1539 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1540
1541 if (drm_explicit != nullptr) {
1542 drm_format_modifier = drm_explicit->drmFormatModifier;
1543 } else {
1544 // VUID 02261 makes sure its only explict or implict in parameter checking
1545 assert(drm_implicit != nullptr);
1546 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1547 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1548 }
1549 }
1550
1551 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1552 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1553 nullptr};
1554 format_properties_2.pNext = (void *)&drm_properties_list;
1555 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001556 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1557 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1558 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1559 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001560
1561 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1562 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1563 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1564 }
1565 }
1566 } else {
1567 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1568 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1569 : format_properties.optimalTilingFeatures;
1570 }
1571
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001572 // Lack of disjoint format feature support while using the flag
1573 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1574 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1575 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1576 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1577 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1578 string_VkFormat(pCreateInfo->format));
1579 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001580
1581 return skip;
1582}
1583
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001584bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001585 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001586 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001587
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001588 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001589 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001590 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1591 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001592 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1593 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001594 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001595 }
1596
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001597 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1598 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001599 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1600 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1601 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001602 }
1603
1604 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001605 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1606 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1607 "height (%d) and arrayLayers (%d) must be >= 6.",
1608 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001609 }
Dave Houlton130c0212018-01-29 13:39:56 -07001610 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001611
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001612 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001613 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1614 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1615 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001616 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1617 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1618 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001619 }
1620
1621 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001622 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1623 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1624 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001625 }
1626
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001627 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001628 uint32_t ceiling_width =
1629 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1630 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1631 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1632 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001633 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1634 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1635 "ceiling of device "
1636 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1637 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1638 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001639 }
1640
1641 uint32_t ceiling_height =
1642 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1643 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1644 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1645 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001646 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1647 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1648 "ceiling of device "
1649 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1650 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1651 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001652 }
1653 }
1654
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001655 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001656 VkResult result = VK_SUCCESS;
1657 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1658 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1659 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1660 &format_limits);
1661 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001662 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1663 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1664 if (modifier_list) {
1665 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1666 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1667 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1668 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1669 image_format_info.type = pCreateInfo->imageType;
1670 image_format_info.format = pCreateInfo->format;
1671 image_format_info.tiling = pCreateInfo->tiling;
1672 image_format_info.usage = pCreateInfo->usage;
1673 image_format_info.flags = pCreateInfo->flags;
1674 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1675
1676 result =
1677 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1678 format_limits = image_format_properties.imageFormatProperties;
1679
1680 /* The application gives a list of modifier and the driver
1681 * selects one. If one is wrong, stop there.
1682 */
1683 if (result != VK_SUCCESS) break;
1684 }
1685 } else if (explicit_modifier) {
1686 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1687 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1688 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1689 image_format_info.type = pCreateInfo->imageType;
1690 image_format_info.format = pCreateInfo->format;
1691 image_format_info.tiling = pCreateInfo->tiling;
1692 image_format_info.usage = pCreateInfo->usage;
1693 image_format_info.flags = pCreateInfo->flags;
1694 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1695
1696 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1697 format_limits = image_format_properties.imageFormatProperties;
1698 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001699 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001700
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001701 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1702 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1703 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1704 if (result != VK_SUCCESS) {
1705 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001706#ifdef VK_USE_PLATFORM_ANDROID_KHR
1707 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1708#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001709 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001710 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001711 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1712 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001713 } else {
1714 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1715 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001716 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1717 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1718 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001719 }
Dave Houlton130c0212018-01-29 13:39:56 -07001720
Dave Houltona585d132019-01-18 13:05:42 -07001721 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1722 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1723 (uint64_t)pCreateInfo->samples;
1724 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001725
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001726 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001727 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001728 uint64_t ig_mask = imageGranularity - 1;
1729 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001730
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001731 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001732 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1733 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1734 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1735 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001736 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001737
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001738 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001739 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1740 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1741 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001742 }
1743
1744 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001745 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1746 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1747 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001748 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001749
1750 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1751 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1752 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1753 pCreateInfo->extent.width, format_limits.maxExtent.width);
1754 }
1755
1756 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1757 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1758 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1759 pCreateInfo->extent.height, format_limits.maxExtent.height);
1760 }
1761
1762 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1763 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1764 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1765 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1766 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001767 }
1768
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001769 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001770 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1771 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1772 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1773 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001774 skip |= LogError(device, error_vuid,
1775 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1776 "YCbCr Conversion format, arrayLayers must be 1",
1777 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001778 }
1779
1780 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001781 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1782 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1783 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001784 }
1785
1786 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001787 skip |= LogError(
1788 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001789 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1790 string_VkSampleCountFlagBits(pCreateInfo->samples));
1791 }
1792
1793 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001794 skip |= LogError(
1795 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001796 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1797 string_VkImageType(pCreateInfo->imageType));
1798 }
1799 }
1800
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001801 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001802 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001803 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001804 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001805 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1806 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1807 "format must be block, ETC or ASTC compressed, but is %s",
1808 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001809 }
1810 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001811 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1812 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1813 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001814 }
1815 }
1816 }
1817
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001818 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001819 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1820 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1821 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001822 }
1823
unknown2c877272019-07-11 12:56:50 -06001824 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1825 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1826 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001827 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1828 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1829 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001830 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001831
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001832 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1833 if (swapchain_create_info != nullptr) {
1834 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1835 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1836 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1837
1838 // Validate rest of Swapchain Image create check that require swapchain state
1839 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1840 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1841 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1842 skip |= LogError(
1843 device, vuid,
1844 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1845 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1846 }
1847 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1848 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1849 skip |= LogError(device, vuid,
1850 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1851 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1852 }
1853 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1854 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1855 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1856 skip |= LogError(device, vuid,
1857 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1858 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1859 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1860 }
1861 }
1862 }
1863
sfricke-samsungedce77a2020-07-03 22:35:13 -07001864 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1865 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1866 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1867 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1868 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1869 }
1870 const VkImageCreateFlags invalid_flags =
1871 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1872 if ((pCreateInfo->flags & invalid_flags) != 0) {
1873 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1874 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1875 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1876 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1877 }
1878 }
1879
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001880 skip |= ValidateImageFormatFeatures(pCreateInfo);
1881
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001882 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001883}
1884
John Zulauf7eeb6f72019-06-17 11:56:36 -06001885void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1886 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1887 if (VK_SUCCESS != result) return;
1888
1889 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001890 auto image_state = Get<IMAGE_STATE>(*pImage);
1891 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001892}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001893
Jeff Bolz5c801d12019-10-09 10:38:45 -05001894bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001895 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001896 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001897 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001898 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001899 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001900 }
1901 return skip;
1902}
1903
John Zulauf7eeb6f72019-06-17 11:56:36 -06001904void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1905 // Clean up validation specific data
1906 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001907
locke-lunargcba7d5f2019-12-30 16:59:11 -07001908 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001909
1910 // Clean up generic image state
1911 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001912}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001913
sfricke-samsungcd924d92020-05-20 23:51:17 -07001914bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1915 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001916 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001917 const VkImage image = image_state->image;
1918 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001919
1920 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001921 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1922 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001923 }
1924
sfricke-samsungcd924d92020-05-20 23:51:17 -07001925 if (FormatIsDepthOrStencil(format)) {
1926 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1927 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1928 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1929 } else if (FormatIsCompressed(format)) {
1930 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1931 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1932 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001933 }
1934
1935 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001936 skip |=
1937 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1938 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1939 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001940 }
1941 return skip;
1942}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001943
John Zulauf07288512019-07-05 11:09:50 -06001944bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1945 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1946 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001947 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001948 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1949 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001950 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1951 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1952 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001953 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001954
1955 } else {
1956 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1957 if (!device_extensions.vk_khr_shared_presentable_image) {
1958 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001959 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1960 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1961 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001962 }
1963 } else {
1964 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1965 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001966 skip |= LogError(
1967 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001968 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1969 func_name, string_VkImageLayout(dest_image_layout));
1970 }
1971 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001972 }
1973
John Zulauff660ad62019-03-23 07:16:05 -06001974 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001975 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001976 if (subresource_map) {
1977 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001978 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001979 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001980 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1981 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001982 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1983 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1984 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1985 } else {
1986 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001987 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001988 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1989 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1990 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1991 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001992 }
John Zulauf5e617452019-11-19 14:44:16 -07001993 }
John Zulauff660ad62019-03-23 07:16:05 -06001994 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001995 }
1996
1997 return skip;
1998}
1999
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002000bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2001 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002002 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002003 bool skip = false;
2004 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002005 const auto *cb_node = GetCBState(commandBuffer);
2006 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002007 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002008 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002009 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002010 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002011 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002012 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002013 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2014 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002015 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002016 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002017 skip |=
2018 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2019 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2020 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002021 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002022 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002023 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002024 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002025 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002026 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002027 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2028 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2029 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2030 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2031 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2032 string_VkFormat(image_state->createInfo.format));
2033 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002034 }
2035 return skip;
2036}
2037
John Zulaufeabb4462019-07-05 14:13:03 -06002038void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2039 const VkClearColorValue *pColor, uint32_t rangeCount,
2040 const VkImageSubresourceRange *pRanges) {
2041 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2042
2043 auto cb_node = GetCBState(commandBuffer);
2044 auto image_state = GetImageState(image);
2045 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002046 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002047 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002048 }
2049 }
2050}
2051
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002052bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2053 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002054 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002055 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002056
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002057 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002058 const auto *cb_node = GetCBState(commandBuffer);
2059 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002060 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002061 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002062 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002063 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002064 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002065 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002066 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002067 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002068 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002069 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002070 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002071 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002072 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2073 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2074 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2075 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002076
2077 bool any_include_aspect_depth_bit = false;
2078 bool any_include_aspect_stencil_bit = false;
2079
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002080 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002081 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002082 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002083 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002084 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002085 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2086 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002087 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2088 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2089 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2090 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002091 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002092 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2093 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002094 if (FormatHasDepth(image_format) == false) {
2095 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2096 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2097 "doesn't have a depth component.",
2098 i, string_VkFormat(image_format));
2099 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002100 }
2101 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2102 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002103 if (FormatHasStencil(image_format) == false) {
2104 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2105 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2106 "%s doesn't have a stencil component.",
2107 i, string_VkFormat(image_format));
2108 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002109 }
2110 }
2111 if (any_include_aspect_stencil_bit) {
2112 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2113 if (image_stencil_struct != nullptr) {
2114 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2115 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002116 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2117 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2118 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2119 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002120 }
2121 } else {
2122 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002123 skip |= LogError(
2124 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002125 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2126 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2127 "in VkImageCreateInfo::usage used to create image");
2128 }
2129 }
2130 }
2131 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002132 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2133 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2134 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002135 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002136 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002137 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2138 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002139 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002140 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002141 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002142 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2143 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2144 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2145 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002146 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002147 }
2148 return skip;
2149}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002150
John Zulaufeabb4462019-07-05 14:13:03 -06002151void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2152 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2153 const VkImageSubresourceRange *pRanges) {
2154 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2155 auto cb_node = GetCBState(commandBuffer);
2156 auto image_state = GetImageState(image);
2157 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002158 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002159 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002160 }
2161 }
2162}
2163
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002164// Returns true if [x, xoffset] and [y, yoffset] overlap
2165static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2166 bool result = false;
2167 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2168 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2169
2170 if (intersection_max > intersection_min) {
2171 result = true;
2172 }
2173 return result;
2174}
2175
Dave Houltonc991cc92018-03-06 11:08:51 -07002176// Returns true if source area of first copy region intersects dest area of second region
2177// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2178static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002179 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002180
Dave Houltonc991cc92018-03-06 11:08:51 -07002181 // Separate planes within a multiplane image cannot intersect
2182 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002183 return result;
2184 }
2185
Dave Houltonc991cc92018-03-06 11:08:51 -07002186 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2187 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2188 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002189 result = true;
2190 switch (type) {
2191 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002192 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002193 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002194 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002195 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002196 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002197 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002198 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002199 break;
2200 default:
2201 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2202 assert(false);
2203 }
2204 }
2205 return result;
2206}
2207
Dave Houltonfc1a4052017-04-27 14:32:45 -06002208// Returns non-zero if offset and extent exceed image extents
2209static const uint32_t x_bit = 1;
2210static const uint32_t y_bit = 2;
2211static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002212static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002213 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002214 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002215 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2216 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002217 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002218 }
2219 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2220 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002221 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002222 }
2223 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2224 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002225 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002226 }
2227 return result;
2228}
2229
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002230// Test if two VkExtent3D structs are equivalent
2231static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2232 bool result = true;
2233 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2234 (extent->depth != other_extent->depth)) {
2235 result = false;
2236 }
2237 return result;
2238}
2239
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002240// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002241static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002242 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2243}
2244
2245// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002246VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002247 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2248 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002249 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002250 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002251 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002252 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002253 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002254 granularity.width *= block_size.width;
2255 granularity.height *= block_size.height;
2256 }
2257 }
2258 return granularity;
2259}
2260
2261// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2262static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2263 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002264 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2265 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002266 valid = false;
2267 }
2268 return valid;
2269}
2270
2271// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002272bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002273 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002274 bool skip = false;
2275 VkExtent3D offset_extent = {};
2276 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2277 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2278 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002279 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002280 // 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 -07002281 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002282 skip |= LogError(cb_node->commandBuffer, vuid,
2283 "%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 "
2284 "image transfer granularity is (w=0, h=0, d=0).",
2285 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002286 }
2287 } else {
2288 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2289 // integer multiples of the image transfer granularity.
2290 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002291 skip |= LogError(cb_node->commandBuffer, vuid,
2292 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2293 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2294 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2295 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002296 }
2297 }
2298 return skip;
2299}
2300
2301// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002302bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002303 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002304 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002305 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002306 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002307 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2308 // subresource extent.
2309 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002310 skip |= LogError(cb_node->commandBuffer, vuid,
2311 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2312 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2313 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2314 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002315 }
2316 } else {
2317 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2318 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2319 // subresource extent dimensions.
2320 VkExtent3D offset_extent_sum = {};
2321 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2322 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2323 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002324 bool x_ok = true;
2325 bool y_ok = true;
2326 bool z_ok = true;
2327 switch (image_type) {
2328 case VK_IMAGE_TYPE_3D:
2329 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2330 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002331 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002332 case VK_IMAGE_TYPE_2D:
2333 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2334 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002335 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002336 case VK_IMAGE_TYPE_1D:
2337 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2338 (subresource_extent->width == offset_extent_sum.width));
2339 break;
2340 default:
2341 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2342 assert(false);
2343 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002344 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002345 skip |=
2346 LogError(cb_node->commandBuffer, vuid,
2347 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2348 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2349 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2350 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2351 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2352 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002353 }
2354 }
2355 return skip;
2356}
2357
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002358bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002359 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002360 bool skip = false;
2361 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002362 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2363 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002364 }
2365 return skip;
2366}
2367
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002368bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002369 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002370 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002371 bool skip = false;
2372 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2373 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002374 skip |= LogError(cb_node->commandBuffer, vuid,
2375 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2376 "%u, but provided %s has %u array layers.",
2377 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2378 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002379 }
2380 return skip;
2381}
2382
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002383// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002384bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002385 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002386 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002387 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002388 VkExtent3D granularity = GetScaledItg(cb_node, img);
2389 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002390 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002391 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002392 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002393 return skip;
2394}
2395
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002396// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002397bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002398 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002399 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002400 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002401 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002402 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2403 skip |=
2404 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002405 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002406 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002407 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2408 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002409
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002410 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002411 granularity = GetScaledItg(cb_node, dst_img);
2412 skip |=
2413 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002414 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002415 const VkExtent3D dest_effective_extent =
2416 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002417 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002418 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002419 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002420 return skip;
2421}
2422
Dave Houlton6f9059e2017-05-02 17:15:13 -06002423// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002424bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002425 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002426 bool skip = false;
2427
2428 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002429 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002430
2431 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002432 const VkExtent3D src_copy_extent = region.extent;
2433 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002434 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2435
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 bool slice_override = false;
2437 uint32_t depth_slices = 0;
2438
2439 // Special case for copying between a 1D/2D array and a 3D image
2440 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2441 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002442 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002443 slice_override = (depth_slices != 1);
2444 } 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 -07002445 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002446 slice_override = (depth_slices != 1);
2447 }
2448
2449 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002450 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002451 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002452 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002453 LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-00146",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002454 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2455 "be 0 and 1, respectively.",
2456 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002457 }
2458 }
2459
Dave Houlton533be9f2018-03-26 17:08:30 -06002460 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002461 skip |= LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-01785",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002462 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2463 "these must be 0 and 1, respectively.",
2464 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002465 }
2466
Dave Houlton533be9f2018-03-26 17:08:30 -06002467 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002468 skip |= LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-01787",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002469 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2470 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002471 }
2472
Dave Houltonc991cc92018-03-06 11:08:51 -07002473 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002474 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002475 if (FormatIsCompressed(src_state->createInfo.format) ||
2476 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002477 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002478 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002479 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2480 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2481 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002482 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002483 skip |= LogError(src_state->image, vuid,
2484 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2485 "texel width & height (%d, %d).",
2486 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002487 }
2488
Dave Houlton94a00372017-12-14 15:08:47 -07002489 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002490 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2491 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002492 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002493 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002494 LogError(src_state->image, vuid,
2495 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2496 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2497 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002498 }
2499
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002500 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002501 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2502 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002503 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002504 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002505 LogError(src_state->image, vuid,
2506 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2507 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2508 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002509 }
2510
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002511 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002512 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2513 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002514 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002515 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002516 LogError(src_state->image, vuid,
2517 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2518 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2519 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002520 }
2521 } // Compressed
2522
2523 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002524 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002525 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002526 skip |= LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-00152",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002527 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2528 "these must be 0 and 1, respectively.",
2529 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002530 }
2531 }
2532
Dave Houlton533be9f2018-03-26 17:08:30 -06002533 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002534 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002535 LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-01786",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002536 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2537 "and 1, respectively.",
2538 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002539 }
2540
Dave Houlton533be9f2018-03-26 17:08:30 -06002541 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002542 skip |= LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-01788",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002543 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2544 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002545 }
2546
sfricke-samsung30b094c2020-05-30 11:42:11 -07002547 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002548 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002549 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2550 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2551 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002552 LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-04443",
sfricke-samsung30b094c2020-05-30 11:42:11 -07002553 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2554 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2555 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2556 }
2557 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002558 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002559 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002560 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002561 LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-04444",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002562 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2563 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2564 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002565 }
2566 }
2567 } else { // Pre maint 1
2568 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002569 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002570 skip |= LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-00139",
sfricke-samsung30b094c2020-05-30 11:42:11 -07002571 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2572 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2573 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2574 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2575 }
Dave Houltonee281a52017-12-08 13:51:02 -07002576 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002577 skip |= LogError(dst_state->image, "VUID-vkCmdCopyImage-srcImage-00139",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002578 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2579 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2580 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2581 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002582 }
2583 }
2584 }
2585
Dave Houltonc991cc92018-03-06 11:08:51 -07002586 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2587 if (FormatIsCompressed(dst_state->createInfo.format) ||
2588 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002589 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002590
2591 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002592 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2593 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2594 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002595 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002596 skip |= LogError(dst_state->image, vuid,
2597 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2598 "texel width & height (%d, %d).",
2599 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002600 }
2601
Dave Houlton94a00372017-12-14 15:08:47 -07002602 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002603 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2604 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002605 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002606 skip |= LogError(
2607 dst_state->image, vuid,
2608 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2609 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2610 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002611 }
2612
Dave Houltonee281a52017-12-08 13:51:02 -07002613 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2614 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2615 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002616 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002617 skip |= LogError(dst_state->image, vuid,
2618 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2619 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2620 "height (%d).",
2621 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002622 }
2623
Dave Houltonee281a52017-12-08 13:51:02 -07002624 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2625 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2626 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002627 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002628 skip |= LogError(
2629 dst_state->image, vuid,
2630 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2631 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2632 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002633 }
2634 } // Compressed
2635 }
2636 return skip;
2637}
2638
Dave Houltonc991cc92018-03-06 11:08:51 -07002639// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002640bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002641 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002642 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002643
2644 // Neither image is multiplane
2645 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2646 // If neither image is multi-plane the aspectMask member of src and dst must match
2647 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2648 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002649 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002650 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002651 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002652 }
2653 } else {
2654 // Source image multiplane checks
2655 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2656 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2657 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2658 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002659 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002660 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002661 }
2662 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2663 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2664 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002665 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002666 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002667 }
2668 // Single-plane to multi-plane
2669 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2670 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2671 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002672 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002673 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002674 }
2675
2676 // Dest image multiplane checks
2677 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2678 aspect = region.dstSubresource.aspectMask;
2679 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2680 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002681 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002682 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002683 }
2684 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2685 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2686 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002687 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002688 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002689 }
2690 // Multi-plane to single-plane
2691 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2692 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2693 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002694 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002695 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002696 }
2697 }
2698
2699 return skip;
2700}
2701
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002702bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2703 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002704 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002705 const auto *cb_node = GetCBState(commandBuffer);
2706 const auto *src_image_state = GetImageState(srcImage);
2707 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002708 const VkFormat src_format = src_image_state->createInfo.format;
2709 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002710 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002711
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002712 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002713
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002714 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2715
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002716 for (uint32_t i = 0; i < regionCount; i++) {
2717 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002718
2719 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2720 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002721 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002722
Dave Houlton6f9059e2017-05-02 17:15:13 -06002723 bool slice_override = false;
2724 uint32_t depth_slices = 0;
2725
2726 // Special case for copying between a 1D/2D array and a 3D image
2727 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2728 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2729 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002730 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002731 slice_override = (depth_slices != 1);
2732 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2733 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002734 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002735 slice_override = (depth_slices != 1);
2736 }
2737
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002738 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2739 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2740 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002741 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002742 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002743 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002744 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002745 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2746 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002747 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002748 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2749 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002750
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002751 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002752 // No chance of mismatch if we're overriding depth slice count
2753 if (!slice_override) {
2754 // The number of depth slices in srcSubresource and dstSubresource must match
2755 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2756 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002757 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2758 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002759 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002760 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2761 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002762 if (src_slices != dst_slices) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002763 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140",
2764 "vkCmdCopyImage(): number of depth slices in source and destination subresources for "
2765 "pRegions[%u] do not match.",
2766 i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002767 }
2768 }
2769 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002770 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002771 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002772 skip |= LogError(
2773 command_buffer, "VUID-VkImageCopy-layerCount-00138",
2774 "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[%u] do not match", i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002775 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002776 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002777
Dave Houltonc991cc92018-03-06 11:08:51 -07002778 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002779 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002780 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002781 }
2782
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002783 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002784 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2785 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002786 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002787 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002788 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002789 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002790
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002791 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002792 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002793 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002794 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002795 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002796 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002797 }
2798
2799 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002800 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002801 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002802 ss << "vkCmdCopyImage(): pRegion[" << i
2803 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002804 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002805 }
2806
Dave Houltonfc1a4052017-04-27 14:32:45 -06002807 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002808 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2809 if (slice_override) src_copy_extent.depth = depth_slices;
2810 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002811 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002812 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002813 LogError(command_buffer, "VUID-vkCmdCopyImage-srcOffset-00144",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002814 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2815 "width [%1d].",
2816 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002817 }
2818
2819 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002820 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002821 LogError(command_buffer, "VUID-vkCmdCopyImage-srcOffset-00145",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002822 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2823 "height [%1d].",
2824 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002825 }
2826 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002827 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002828 LogError(command_buffer, "VUID-vkCmdCopyImage-srcOffset-00147",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002829 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2830 "depth [%1d].",
2831 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002832 }
2833
Dave Houltonee281a52017-12-08 13:51:02 -07002834 // Adjust dest extent if necessary
2835 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2836 if (slice_override) dst_copy_extent.depth = depth_slices;
2837
2838 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002839 if (extent_check & x_bit) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002840 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstOffset-00150",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002841 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2842 "width [%1d].",
2843 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002844 }
2845 if (extent_check & y_bit) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002846 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstOffset-00151",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002847 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2848 "height [%1d].",
2849 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002850 }
2851 if (extent_check & z_bit) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002852 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstOffset-00153",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002853 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2854 "depth [%1d].",
2855 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002856 }
2857
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002858 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2859 // must not overlap in memory
2860 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002861 for (uint32_t j = 0; j < regionCount; j++) {
2862 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002863 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002864 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002865 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002866 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002867 }
2868 }
2869 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002870
2871 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2872 if (device_extensions.vk_khr_maintenance1) {
2873 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2874 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2875 (src_copy_extent.depth != 1)) {
2876 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002877 command_buffer, "VUID-vkCmdCopyImage-srcImage-01790",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002878 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2879 src_copy_extent.depth);
2880 }
2881 } else {
2882 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2883 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2884 (src_copy_extent.depth != 1)) {
2885 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002886 command_buffer, "VUID-vkCmdCopyImage-srcImage-01789",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002887 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2888 src_copy_extent.depth);
2889 }
2890 }
2891
2892 // Check if 2D with 3D and depth not equal to 2D layerCount
2893 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2894 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2895 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002896 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01791",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002897 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2898 "srcSubresource.layerCount (%u)",
2899 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2900 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2901 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2902 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002903 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01792",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002904 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2905 "dstSubresource.layerCount (%u)",
2906 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2907 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002908
2909 // Check for multi-plane format compatiblity
2910 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2911 size_t src_format_size = 0;
2912 size_t dst_format_size = 0;
2913 if (FormatIsMultiplane(src_format)) {
2914 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2915 src_format_size = FormatElementSize(planeFormat);
2916 } else {
2917 src_format_size = FormatElementSize(src_format);
2918 }
2919 if (FormatIsMultiplane(dst_format)) {
2920 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2921 dst_format_size = FormatElementSize(planeFormat);
2922 } else {
2923 dst_format_size = FormatElementSize(dst_format);
2924 }
2925 // If size is still zero, then format is invalid and will be caught in another VU
2926 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2927 skip |=
2928 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2929 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2930 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2931 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2932 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2933 }
2934 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002935 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002936
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002937 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2938 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2939 // because because both texels are 4 bytes in size.
2940 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2941 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2942 : "VUID-vkCmdCopyImage-srcImage-00135";
2943 // Depth/stencil formats must match exactly.
2944 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2945 if (src_format != dst_format) {
2946 skip |= LogError(command_buffer, compatible_vuid,
2947 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2948 string_VkFormat(src_format), string_VkFormat(dst_format));
2949 }
2950 } else {
2951 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2952 skip |= LogError(command_buffer, compatible_vuid,
2953 "vkCmdCopyImage(): Unmatched image format sizes. "
2954 "The src format %s has size of %zu and dst format %s has size of %zu.",
2955 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2956 FormatElementSize(dst_format));
2957 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002958 }
2959 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002960
Dave Houlton33c22b72017-02-28 13:16:02 -07002961 // Source and dest image sample counts must match
2962 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2963 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002964 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002965 }
2966
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002967 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2968 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002969 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002970 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2971 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2972 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2973 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07002974 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01825");
2975 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01826");
2976 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01827");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02002977
2978 // Validation for VK_EXT_fragment_density_map
2979 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2980 skip |= LogError(
2981 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2982 "vkCmdCopyImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2983 }
2984 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2985 skip |= LogError(
2986 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2987 "vkCmdCopyImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2988 }
2989
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002990 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002991 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002992 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002993 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002994 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002995 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002996 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002997 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002998 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2999 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06003000 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003001 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3002 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
3003 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
3004 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3005 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
3006 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003007 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003008 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003009 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
3010 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003011 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003012 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
3013 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003014 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
3015 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003016 }
3017
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003018 return skip;
3019}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003020
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003021void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3022 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3023 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003024 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3025 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003026 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003027 auto src_image_state = GetImageState(srcImage);
3028 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003029
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003030 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003031 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003032 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3033 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003034 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003035}
3036
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003037// Returns true if sub_rect is entirely contained within rect
3038static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3039 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3040 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3041 return false;
3042 return true;
3043}
3044
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003045bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003046 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
3047 const VkRect2D &render_area, uint32_t rect_count,
3048 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003049 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003050 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3051 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06003052 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07003053 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003054
3055 for (uint32_t j = 0; j < rect_count; j++) {
3056 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003057 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3058 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3059 "the current render pass instance.",
3060 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003061 }
3062
3063 if (image_view_state) {
3064 // The layers specified by a given element of pRects must be contained within every attachment that
3065 // pAttachments refers to
3066 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3067 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3068 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003069 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3070 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3071 "of pAttachment[%d].",
3072 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003073 }
3074 }
3075 }
3076 return skip;
3077}
3078
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003079bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3080 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003081 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003082 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003083 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003084 if (!cb_node) return skip;
3085
3086 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3087 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3088 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003089 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003090
3091 // Validate that attachment is in reference list of active subpass
3092 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003093 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003094 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003095 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003096 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003097 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003098
John Zulauf3a548ef2019-02-01 16:14:07 -07003099 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3100 auto clear_desc = &pAttachments[attachment_index];
3101 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003102
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003103 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003104 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003105 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003106 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003107 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003108 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3109 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3110 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3111 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003112 skip |= LogError(
3113 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3114 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3115 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3116 attachment_index, clear_desc->colorAttachment,
3117 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3118 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003119
John Zulauff2582972019-02-09 14:53:30 -07003120 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3121 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003122 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003123 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3124 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3125 " subpass %u. colorAttachmentCount=%u",
3126 attachment_index, clear_desc->colorAttachment,
3127 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3128 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003129 }
John Zulauff2582972019-02-09 14:53:30 -07003130 fb_attachment = color_attachment;
3131
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003132 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3133 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3134 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003135 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003136 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003137 }
3138 } else { // Must be depth and/or stencil
3139 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3140 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003141 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003142 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003143 }
3144 if (!subpass_desc->pDepthStencilAttachment ||
3145 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003146 skip |= LogPerformanceWarning(
3147 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003148 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003149 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003150 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003151 }
3152 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003153 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003154 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3155 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003156 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003157
3158 // Once the framebuffer attachment is found, can get the image view state
3159 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3160 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3161 const IMAGE_VIEW_STATE *image_view_state =
3162 GetAttachmentImageViewState(GetCBState(commandBuffer), framebuffer, fb_attachment);
3163 if (image_view_state != nullptr) {
3164 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3165 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3166 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3167 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3168 }
3169 }
John Zulauf441558b2019-08-12 11:47:39 -06003170 }
3171 }
3172 return skip;
3173}
3174
3175void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3176 const VkClearAttachment *pAttachments, uint32_t rectCount,
3177 const VkClearRect *pRects) {
3178 auto *cb_node = GetCBState(commandBuffer);
3179 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3180 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3181 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3182 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3183 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3184 const auto clear_desc = &pAttachments[attachment_index];
3185 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3186 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3187 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3188 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3189 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3190 subpass_desc->pDepthStencilAttachment) {
3191 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3192 }
3193 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003194 if (!clear_rect_copy) {
3195 // We need a copy of the clear rectangles that will persist until the last lambda executes
3196 // but we want to create it as lazily as possible
3197 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003198 }
John Zulauf441558b2019-08-12 11:47:39 -06003199 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3200 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003201 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003202 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003203 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003204 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3205 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003206 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
3207 clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003208 return skip;
3209 };
3210 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003211 }
3212 }
3213 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003214}
3215
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003216bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3217 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003218 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003219 const auto *cb_node = GetCBState(commandBuffer);
3220 const auto *src_image_state = GetImageState(srcImage);
3221 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003222
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003223 bool skip = false;
3224 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003225 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3226 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003227 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003228 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003229 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3230 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003231 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003232 "VUID-vkCmdResolveImage-dstImage-02003");
sfricke-samsung022fa252020-07-24 03:26:16 -07003233 skip |=
3234 ValidateProtectedImage(cb_node, src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01837");
3235 skip |=
3236 ValidateProtectedImage(cb_node, dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01838");
3237 skip |=
3238 ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01839");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003239
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003240 // Validation for VK_EXT_fragment_density_map
3241 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3242 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3243 "vkCmdResolveImage(): srcImage must not have been created with flags containing "
3244 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3245 }
3246 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3247 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3248 "vkCmdResolveImage(): dstImage must not have been created with flags containing "
3249 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3250 }
3251
Cort Stratton7df30962018-05-17 19:45:57 -07003252 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003253 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003254 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003255 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3256 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3257 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003258 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003259 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3260 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003261 // For each region, the number of layers in the image subresource should not be zero
3262 // For each region, src and dest image aspect must be color only
3263 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003264 const VkImageResolve region = pRegions[i];
3265 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3266 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003267 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, "vkCmdResolveImage()", "srcSubresource", i);
3268 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, "vkCmdResolveImage()", "dstSubresource", i);
3269 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003270 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3271 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003272 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003273 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3274 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003275 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003276 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003277 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003278 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003279 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
3280 src_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003281 "VUID-vkCmdResolveImage-srcSubresource-01711");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003282 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
3283 dst_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003284 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003285
3286 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003287 if (src_subresource.layerCount != dst_subresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003288 skip |= LogError(
3289 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003290 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%u] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003291 }
Cort Stratton7df30962018-05-17 19:45:57 -07003292 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003293 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3294 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3295 skip |= LogError(
3296 cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266",
3297 "vkCmdResolveImage(): src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3298 i);
3299 }
3300
3301 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3302 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3303
3304 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003305 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003306 LogObjectList objlist(cb_node->commandBuffer);
3307 objlist.add(src_image_state->image);
3308 objlist.add(dst_image_state->image);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003309 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-04446",
3310 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3311 "subresources if the src or dst image is 3D.",
3312 i);
3313 }
3314 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3315 LogObjectList objlist(cb_node->commandBuffer);
3316 objlist.add(src_image_state->image);
3317 objlist.add(dst_image_state->image);
3318 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-04447",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003319 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3320 "subresources if the src or dst image is 3D.",
3321 i);
3322 }
3323 }
3324
3325 if (VK_IMAGE_TYPE_1D == src_image_type) {
3326 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3327 LogObjectList objlist(cb_node->commandBuffer);
3328 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003329 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-00271",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003330 "vkCmdResolveImage(): srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
3331 "extent.height (%u) is not 1.",
3332 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.y,
3333 pRegions[i].extent.height);
3334 }
3335 }
3336 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3337 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3338 LogObjectList objlist(cb_node->commandBuffer);
3339 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003340 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-00273",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003341 "vkCmdResolveImage(): srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
3342 "extent.depth (%u) is not 1.",
3343 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.z,
3344 pRegions[i].extent.depth);
3345 }
3346 }
3347
3348 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3349 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3350 LogObjectList objlist(cb_node->commandBuffer);
3351 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003352 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstImage-00276",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003353 "vkCmdResolveImage(): dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
3354 "extent.height (%u) is not 1.",
3355 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.y,
3356 pRegions[i].extent.height);
3357 }
3358 }
3359 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3360 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3361 LogObjectList objlist(cb_node->commandBuffer);
3362 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003363 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstImage-00278",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003364 "vkCmdResolveImage(): dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
3365 "extent.depth (%u) is not 1.",
3366 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.z,
3367 pRegions[i].extent.depth);
3368 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003369 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003370
3371 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3372 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3373 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3374 // developer
3375 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3376 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3377 if ((extent_check & x_bit) != 0) {
3378 LogObjectList objlist(cb_node->commandBuffer);
3379 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003380 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcOffset-00269",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003381 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
3382 "exceeds subResource width [%u].",
3383 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
3384 region.extent.width, subresource_extent.width);
3385 }
3386
3387 if ((extent_check & y_bit) != 0) {
3388 LogObjectList objlist(cb_node->commandBuffer);
3389 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003390 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcOffset-00270",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003391 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
3392 "exceeds subResource height [%u].",
3393 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
3394 region.extent.height, subresource_extent.height);
3395 }
3396
3397 if ((extent_check & z_bit) != 0) {
3398 LogObjectList objlist(cb_node->commandBuffer);
3399 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003400 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcOffset-00272",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003401 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
3402 "exceeds subResource depth [%u].",
3403 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
3404 region.extent.depth, subresource_extent.depth);
3405 }
3406 }
3407
3408 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3409 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3410 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3411 // developer
3412 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3413 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3414 if ((extent_check & x_bit) != 0) {
3415 LogObjectList objlist(cb_node->commandBuffer);
3416 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003417 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstOffset-00274",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003418 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
3419 "exceeds subResource width [%u].",
3420 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
3421 region.extent.width, subresource_extent.width);
3422 }
3423
3424 if ((extent_check & y_bit) != 0) {
3425 LogObjectList objlist(cb_node->commandBuffer);
3426 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003427 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstOffset-00275",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003428 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
3429 "exceeds subResource height [%u].",
3430 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
3431 region.extent.height, subresource_extent.height);
3432 }
3433
3434 if ((extent_check & z_bit) != 0) {
3435 LogObjectList objlist(cb_node->commandBuffer);
3436 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003437 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstOffset-00277",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003438 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
3439 "exceeds subResource depth [%u].",
3440 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
3441 region.extent.depth, subresource_extent.depth);
3442 }
3443 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003444 }
3445
3446 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003447 skip |=
3448 LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-01386",
3449 "vkCmdResolveImage(): srcImage format (%s) and dstImage format (%s) are not the same.",
3450 string_VkFormat(src_image_state->createInfo.format), string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003451 }
3452 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003453 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
3454 "vkCmdResolveImage(): srcImage type (%s) and dstImage type (%s) are not the same.",
3455 string_VkImageType(src_image_state->createInfo.imageType),
3456 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003457 }
3458 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003459 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257",
3460 "vkCmdResolveImage(): srcImage sample count is VK_SAMPLE_COUNT_1_BIT.");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003461 }
3462 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003463 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259",
3464 "vkCmdResolveImage(): dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3465 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003466 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003467 } else {
3468 assert(0);
3469 }
3470 return skip;
3471}
3472
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003473bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3474 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003475 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003476 const auto *cb_node = GetCBState(commandBuffer);
3477 const auto *src_image_state = GetImageState(srcImage);
3478 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003479
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003480 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003481 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003482 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003483 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003484 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003485 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003486 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003487 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003488 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003489 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3490 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003491 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003492 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3493 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003494 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003495 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3496 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003497 skip |=
3498 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003499 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3500 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003501 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003502 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003503 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003504 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003505
sfricke-samsung022fa252020-07-24 03:26:16 -07003506 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01834");
3507 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01835");
3508 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01836");
3509
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003510 // Validation for VK_EXT_fragment_density_map
3511 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3512 skip |= LogError(
3513 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3514 "vkCmdBlitImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3515 }
3516 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3517 skip |= LogError(
3518 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3519 "vkCmdBlitImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3520 }
3521
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003522 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003523
Dave Houlton33c2d252017-06-09 17:08:32 -06003524 VkFormat src_format = src_image_state->createInfo.format;
3525 VkFormat dst_format = dst_image_state->createInfo.format;
3526 VkImageType src_type = src_image_state->createInfo.imageType;
3527 VkImageType dst_type = dst_image_state->createInfo.imageType;
3528
Cort Stratton186b1a22018-05-01 20:18:06 -04003529 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003530 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003531 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003532 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003533 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003534 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003535 }
3536
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003537 if (FormatRequiresYcbcrConversion(src_format)) {
3538 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3539 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3540 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3541 string_VkFormat(src_format));
3542 }
3543
3544 if (FormatRequiresYcbcrConversion(dst_format)) {
3545 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3546 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3547 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3548 string_VkFormat(dst_format));
3549 }
3550
Dave Houlton33c2d252017-06-09 17:08:32 -06003551 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003552 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3553 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003554 }
3555
Dave Houlton33c2d252017-06-09 17:08:32 -06003556 // Validate consistency for unsigned formats
3557 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3558 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003559 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003560 << "the other one must also have unsigned integer format. "
3561 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003562 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003563 }
3564
3565 // Validate consistency for signed formats
3566 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3567 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003568 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003569 << "the other one must also have signed integer format. "
3570 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003571 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003572 }
3573
3574 // Validate filter for Depth/Stencil formats
3575 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3576 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003577 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003578 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003579 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003580 }
3581
3582 // Validate aspect bits and formats for depth/stencil images
3583 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3584 if (src_format != dst_format) {
3585 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003586 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003587 << "stencil, the other one must have exactly the same format. "
3588 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3589 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003590 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003591 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003592 } // Depth or Stencil
3593
3594 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003595 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003596 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003597 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3598 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3599 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003600 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003601 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3602 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003603 for (uint32_t i = 0; i < regionCount; i++) {
3604 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003605 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003606 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003607 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3608 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003609 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003610 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3611 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003612 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3613 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3614 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003615 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003616 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003617 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003618 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003619 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3620 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003621 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003622 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3623 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003624 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003625 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3626 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003627 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003628 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003629 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003630 }
Dave Houlton48989f32017-05-26 15:01:46 -06003631 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3632 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003633 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003634 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003635 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003636 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003637
3638 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003639 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003640 skip |= LogError(
3641 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003642 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003643 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003644
Dave Houlton48989f32017-05-26 15:01:46 -06003645 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003646 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3647 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003648 }
Dave Houlton48989f32017-05-26 15:01:46 -06003649
Dave Houlton33c2d252017-06-09 17:08:32 -06003650 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003651 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-aspectMask-00241",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003652 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3653 "image format %s.",
3654 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003655 }
3656
3657 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003658 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003659 cb_node->commandBuffer, "VUID-vkCmdBlitImage-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003660 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3661 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003662 }
3663
Dave Houlton48989f32017-05-26 15:01:46 -06003664 // Validate source image offsets
3665 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003666 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003667 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003668 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003669 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00245",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003670 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3671 "of (%1d, %1d). These must be (0, 1).",
3672 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003673 }
3674 }
3675
Dave Houlton33c2d252017-06-09 17:08:32 -06003676 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003677 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003678 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003679 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00247",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003680 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3681 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3682 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003683 }
3684 }
3685
Dave Houlton33c2d252017-06-09 17:08:32 -06003686 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003687 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3688 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003689 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003690 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003691 cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003692 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3693 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003694 }
3695 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3696 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003697 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003698 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003699 cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003700 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003701 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003702 }
3703 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3704 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003705 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003706 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003707 cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003708 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3709 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003710 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003711 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003712 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3713 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003714 }
Dave Houlton48989f32017-05-26 15:01:46 -06003715
3716 // Validate dest image offsets
3717 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003718 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003719 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003720 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003721 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-00250",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003722 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3723 "(%1d, %1d). These must be (0, 1).",
3724 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003725 }
3726 }
3727
Dave Houlton33c2d252017-06-09 17:08:32 -06003728 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003729 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003730 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-00252",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003731 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3732 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3733 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003734 }
3735 }
3736
Dave Houlton33c2d252017-06-09 17:08:32 -06003737 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003738 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3739 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003740 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003741 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003742 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003743 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3744 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003745 }
3746 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3747 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003748 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003749 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003750 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003751 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003752 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003753 }
3754 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3755 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003756 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003757 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003758 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003759 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3760 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003761 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003762 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003763 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3764 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003765 }
3766
Dave Houlton33c2d252017-06-09 17:08:32 -06003767 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3768 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3769 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003770 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003771 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00240",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003772 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3773 "layerCount other than 1.",
3774 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003775 }
3776 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003777 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003778 } else {
3779 assert(0);
3780 }
3781 return skip;
3782}
3783
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003784void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3785 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3786 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003787 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3788 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003789 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003790 auto src_image_state = GetImageState(srcImage);
3791 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003792
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003793 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003794 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003795 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3796 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003797 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003798}
3799
John Zulauf2076e812020-01-08 14:55:54 -07003800GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3801 assert(map);
3802 // This approach allows for a single hash lookup or/create new
3803 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3804 if (inserted.second) {
3805 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06003806 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07003807 inserted.first->second.reset(layout_map);
3808 return layout_map;
3809 } else {
3810 assert(nullptr != inserted.first->second.get());
3811 return inserted.first->second.get();
3812 }
3813 return nullptr;
3814}
3815
3816const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3817 auto it = map.find(image);
3818 if (it != map.end()) {
3819 return it->second.get();
3820 }
3821 return nullptr;
3822}
3823
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003824// 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 -07003825bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3826 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06003827 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003828 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003829 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003830 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003831 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003832 for (const auto &layout_map_entry : pCB->image_layout_map) {
3833 const auto image = layout_map_entry.first;
3834 const auto *image_state = GetImageState(image);
3835 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003836 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003837 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003838 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003839 if (initial_layout_map.empty()) continue;
3840
3841 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3842 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3843 if (global_map == nullptr) {
3844 global_map = &empty_map;
3845 }
3846
3847 // Note: don't know if it would matter
3848 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3849
3850 auto pos = initial_layout_map.begin();
3851 const auto end = initial_layout_map.end();
3852 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3853 pos->first.begin);
3854 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003855 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003856 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003857 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 -07003858 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003859 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003860 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003861 image_layout = current_layout->pos_B->lower_bound->second;
3862 }
3863 const auto intersected_range = pos->first & current_layout->range;
3864 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3865 // TODO: Set memory invalid which is in mem_tracker currently
3866 } else if (image_layout != initial_layout) {
3867 // Need to look up the inital layout *state* to get a bit more information
3868 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3869 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3870 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3871 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003872 // We can report all the errors for the intersected range directly
3873 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06003874 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003875 skip |= LogError(
3876 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003877 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003878 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003879 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003880 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003881 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003882 }
3883 }
John Zulauf2076e812020-01-08 14:55:54 -07003884 if (pos->first.includes(intersected_range.end)) {
3885 current_layout.seek(intersected_range.end);
3886 } else {
3887 ++pos;
3888 if (pos != end) {
3889 current_layout.seek(pos->first.begin);
3890 }
3891 }
John Zulauff660ad62019-03-23 07:16:05 -06003892 }
3893
locke-lunargf155ccf2020-02-18 11:34:15 -07003894 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003895 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003896 }
John Zulauff660ad62019-03-23 07:16:05 -06003897
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003898 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003899}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003900
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003901void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003902 for (const auto &layout_map_entry : pCB->image_layout_map) {
3903 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003904 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003905 const auto *image_state = GetImageState(image);
3906 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003907 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3908 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003909 }
3910}
3911
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003912// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003913// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3914// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003915bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3916 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003917 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003918 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003919 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3920
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003921 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003922 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3923 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003924 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003925 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3926 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3927 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003928 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003929 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003930 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003931 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3932 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3933 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003934 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003935 string_VkImageLayout(first_layout));
3936 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3937 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003938 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003939 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003940 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003941 }
3942 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003943
3944 // Same as above for loadOp, but for stencilLoadOp
3945 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3946 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3947 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3948 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3949 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003950 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003951 string_VkImageLayout(first_layout));
3952 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3953 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3954 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003955 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003956 string_VkImageLayout(first_layout));
3957 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3958 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3959 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003960 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003961 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003962 }
3963 }
3964
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003965 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003966}
3967
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003968bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3969 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003970 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003971 const char *vuid;
3972 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003973
Jason Ekstranda1906302017-12-03 20:16:32 -08003974 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3975 VkFormat format = pCreateInfo->pAttachments[i].format;
3976 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3977 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3978 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003979 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003980 "%s: Render pass pAttachment[%u] has loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003981 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3982 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
sfricke-samsung6595d272020-05-13 22:43:06 -07003983 "render pass.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003984 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003985 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003986 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003987 skip |=
3988 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3989 "%s: Render pass pAttachment[%u] has stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3990 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3991 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3992 "render pass.",
3993 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003994 }
3995 }
3996 }
3997
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003998 // Track when we're observing the first use of an attachment
3999 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
4000 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004001 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07004002
4003 // Check input attachments first, so we can detect first-use-as-input for VU #00349
4004 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
4005 auto attach_index = subpass.pInputAttachments[j].attachment;
4006 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07004007 switch (subpass.pInputAttachments[j].layout) {
4008 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
4009 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
4010 // These are ideal.
4011 break;
4012
4013 case VK_IMAGE_LAYOUT_GENERAL:
4014 // May not be optimal. TODO: reconsider this warning based on other constraints.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004015 skip |= LogPerformanceWarning(
4016 device, kVUID_Core_DrawState_InvalidImageLayout,
4017 "%s: Layout for input attachment reference %u in subpass %u is GENERAL but should be READ_ONLY_OPTIMAL.",
4018 function_name, j, i);
Cort Stratton7547f772017-05-04 15:18:52 -07004019 break;
4020
Tobias Hectorbbb12282018-10-22 15:17:59 +01004021 case VK_IMAGE_LAYOUT_UNDEFINED:
4022 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004023 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004024 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004025 "%s: Layout for input attachment reference %u in subpass %u is %s but must be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004026 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004027 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004028 break;
4029
Piers Daniell9af77cd2019-10-16 13:54:12 -06004030 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4031 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4032 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4033 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004034 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004035 skip |= LogError(
4036 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004037 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004038 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4039 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004040 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004041 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004042 skip |= LogError(
4043 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004044 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004045 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4046 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004047 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004048 } else if ((subpass.pInputAttachments[j].aspectMask &
4049 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4050 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4051 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4052 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4053 const auto *attachment_reference_stencil_layout =
4054 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
4055 if (attachment_reference_stencil_layout) {
4056 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4057 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4058 attachment_reference_stencil_layout->stencilLayout ==
4059 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4060 attachment_reference_stencil_layout->stencilLayout ==
4061 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4062 attachment_reference_stencil_layout->stencilLayout ==
4063 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4064 attachment_reference_stencil_layout->stencilLayout ==
4065 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4066 attachment_reference_stencil_layout->stencilLayout ==
4067 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4068 attachment_reference_stencil_layout->stencilLayout ==
4069 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4070 attachment_reference_stencil_layout->stencilLayout ==
4071 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4072 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004073 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004074 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004075 "VkAttachmentReferenceStencilLayoutKHR"
4076 "the stencilLayout member but must not be "
4077 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4078 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4079 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4080 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4081 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4082 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4083 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4084 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4085 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004086 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004087 }
4088 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004089 skip |= LogError(
4090 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004091 "%s: When the layout for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004092 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4093 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4094 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004095 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004096 }
4097 }
4098 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4099 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4100 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004101 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
4102 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
4103 "VK_IMAGE_ASPECT_DEPTH_BIT "
4104 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4105 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4106 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004107 }
4108 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4109 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4110 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004111 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004112 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004113 "VK_IMAGE_ASPECT_STENCIL_BIT "
4114 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4115 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004116 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004117 }
4118 }
4119 break;
4120
Graeme Leese668a9862018-10-08 10:40:02 +01004121 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4122 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004123 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01004124 break;
4125 } else {
4126 // Intentionally fall through to generic error message
4127 }
4128 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004129
Cort Stratton7547f772017-05-04 15:18:52 -07004130 default:
4131 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004132 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004133 "%s: Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
4134 function_name, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07004135 }
4136
Cort Stratton7547f772017-05-04 15:18:52 -07004137 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004138 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
4139 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07004140
4141 bool used_as_depth =
4142 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
4143 bool used_as_color = false;
4144 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
4145 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
4146 }
4147 if (!used_as_depth && !used_as_color &&
4148 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08004149 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004150 skip |= LogError(device, vuid,
4151 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
Mark Lobodzinski6ff146b2020-05-22 14:37:05 -06004152 function_name, attach_index, i);
Cort Stratton7547f772017-05-04 15:18:52 -07004153 }
4154 }
4155 attach_first_use[attach_index] = false;
4156 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01004157
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004158 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
4159 auto attach_index = subpass.pColorAttachments[j].attachment;
4160 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
4161
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004162 // TODO: Need a way to validate shared presentable images here, currently just allowing
4163 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
4164 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004165 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004166 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06004167 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004168 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
4169 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004170 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004171
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004172 case VK_IMAGE_LAYOUT_GENERAL:
4173 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004174 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004175 "%s: Layout for color attachment reference %u in subpass %u is GENERAL but "
4176 "should be COLOR_ATTACHMENT_OPTIMAL.",
4177 function_name, j, i);
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004178 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004179
Tobias Hectorbbb12282018-10-22 15:17:59 +01004180 case VK_IMAGE_LAYOUT_UNDEFINED:
4181 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004182 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004183 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004184 "%s: Layout for color attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004185 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004186 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004187 break;
4188
Piers Daniell9af77cd2019-10-16 13:54:12 -06004189 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4190 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4191 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4192 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004193 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004194 skip |= LogError(
4195 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004196 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004197 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4198 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004199 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004200 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004201 skip |= LogError(
4202 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004203 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004204 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4205 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004206 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004207 } else if ((subpass.pColorAttachments[j].aspectMask &
4208 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4209 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4210 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4211 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4212 const auto *attachment_reference_stencil_layout =
4213 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
4214 if (attachment_reference_stencil_layout) {
4215 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4216 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4217 attachment_reference_stencil_layout->stencilLayout ==
4218 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4219 attachment_reference_stencil_layout->stencilLayout ==
4220 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4221 attachment_reference_stencil_layout->stencilLayout ==
4222 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4223 attachment_reference_stencil_layout->stencilLayout ==
4224 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4225 attachment_reference_stencil_layout->stencilLayout ==
4226 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4227 attachment_reference_stencil_layout->stencilLayout ==
4228 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4229 attachment_reference_stencil_layout->stencilLayout ==
4230 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4231 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004232 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004233 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004234 "VkAttachmentReferenceStencilLayoutKHR"
4235 "the stencilLayout member but must not be "
4236 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4237 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4238 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4239 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4240 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4241 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4242 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4243 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4244 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004245 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004246 }
4247 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004248 skip |= LogError(
4249 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004250 "%s: When the layout for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004251 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4252 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4253 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004254 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004255 }
4256 }
4257 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4258 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4259 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004260 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
4261 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
4262 "VK_IMAGE_ASPECT_DEPTH_BIT "
4263 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4264 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4265 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004266 }
4267 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4268 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4269 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004270 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004271 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004272 "VK_IMAGE_ASPECT_STENCIL_BIT "
4273 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4274 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004275 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004276 }
4277 }
4278 break;
4279
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004280 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004281 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004282 "%s: Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
4283 function_name, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004284 }
4285
John Zulauf4eee2692019-02-09 16:14:25 -07004286 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
4287 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
4288 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08004289 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004290 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004291 "%s: Layout for resolve attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004292 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004293 function_name, j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004294 }
4295
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004296 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004297 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
4298 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004299 }
4300 attach_first_use[attach_index] = false;
4301 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004302
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004303 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
4304 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004305 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
4306 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
4307 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06004308 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06004309
Dave Houltona9df0ce2018-02-07 10:51:23 -07004310 case VK_IMAGE_LAYOUT_GENERAL:
4311 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
4312 // doing a bunch of transitions.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004313 skip |= LogPerformanceWarning(
4314 device, kVUID_Core_DrawState_InvalidImageLayout,
4315 "%s: GENERAL layout for depth attachment reference in subpass %u may not give optimal performance.",
4316 function_name, i);
Dave Houltona9df0ce2018-02-07 10:51:23 -07004317 break;
4318
Tobias Hectorbbb12282018-10-22 15:17:59 +01004319 case VK_IMAGE_LAYOUT_UNDEFINED:
4320 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004321 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004322 skip |=
4323 LogError(device, vuid,
4324 "%s: Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4325 "layout or GENERAL.",
4326 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004327 break;
4328
Piers Daniell9af77cd2019-10-16 13:54:12 -06004329 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4330 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4331 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4332 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004333 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004334 skip |= LogError(
4335 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004336 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004337 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4338 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004339 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004340 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004341 skip |= LogError(
4342 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004343 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004344 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4345 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004346 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004347 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4348 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4349 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4350 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4351 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4352 const auto *attachment_reference_stencil_layout =
4353 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4354 if (attachment_reference_stencil_layout) {
4355 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4356 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4357 attachment_reference_stencil_layout->stencilLayout ==
4358 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4359 attachment_reference_stencil_layout->stencilLayout ==
4360 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4361 attachment_reference_stencil_layout->stencilLayout ==
4362 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4363 attachment_reference_stencil_layout->stencilLayout ==
4364 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4365 attachment_reference_stencil_layout->stencilLayout ==
4366 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4367 attachment_reference_stencil_layout->stencilLayout ==
4368 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4369 attachment_reference_stencil_layout->stencilLayout ==
4370 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4371 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004372 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004373 "%s: In the attachment reference in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004374 "VkAttachmentReferenceStencilLayoutKHR"
4375 "the stencilLayout member but must not be "
4376 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4377 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4378 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4379 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4380 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4381 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4382 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4383 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4384 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004385 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004386 }
4387 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004388 skip |= LogError(
4389 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004390 "%s: When the layout for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004391 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4392 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4393 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004394 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004395 }
4396 }
4397 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4398 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4399 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004400 skip |= LogError(
4401 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004402 "%s: When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004403 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4404 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004405 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004406 }
4407 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4408 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4409 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004410 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004411 "%s: When the aspectMask for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004412 "VK_IMAGE_ASPECT_STENCIL_BIT "
4413 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4414 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004415 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004416 }
4417 }
4418 break;
4419
Dave Houltona9df0ce2018-02-07 10:51:23 -07004420 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4421 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004422 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004423 break;
4424 } else {
4425 // Intentionally fall through to generic error message
4426 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004427 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004428
Dave Houltona9df0ce2018-02-07 10:51:23 -07004429 default:
4430 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004431 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004432 "%s: Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004433 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004434 function_name, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004435 }
4436
4437 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4438 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004439 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4440 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004441 }
4442 attach_first_use[attach_index] = false;
4443 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004444 }
4445 return skip;
4446}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004447
Mark Lobodzinski96210742017-02-09 10:33:46 -07004448// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4449// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004450template <typename T1>
4451bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4452 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4453 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004454 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004455 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004456 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004457 if (strict) {
4458 correct_usage = ((actual & desired) == desired);
4459 } else {
4460 correct_usage = ((actual & desired) != 0);
4461 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004462
Mark Lobodzinski96210742017-02-09 10:33:46 -07004463 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004464 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004465 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004466 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4467 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4468 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004469 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004470 skip = LogError(object, msgCode,
4471 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4472 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004473 }
4474 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004475 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004476}
4477
4478// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4479// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004480bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004481 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004482 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004483 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004484}
4485
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004486bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004487 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004488 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004489 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4490 if ((image_format_features & desired) != desired) {
4491 // Same error, but more details if it was an AHB external format
4492 if (image_state->has_ahb_format == true) {
4493 skip |= LogError(image_state->image, vuid,
4494 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4495 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4496 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004497 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004498 } else {
4499 skip |= LogError(image_state->image, vuid,
4500 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4501 "with tiling %s.",
4502 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4503 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4504 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004505 }
4506 }
4507 return skip;
4508}
4509
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004510bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004511 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004512 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004513 // layerCount must not be zero
4514 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004515 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4516 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004517 }
4518 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4519 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004520 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4521 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004522 }
4523 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4524 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4525 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004526 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4527 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4528 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4529 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004530 }
4531 return skip;
4532}
4533
Mark Lobodzinski96210742017-02-09 10:33:46 -07004534// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4535// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004536bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004537 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004538 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004539 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004540}
4541
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004542bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004543 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004544 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004545
4546 const VkDeviceSize &range = pCreateInfo->range;
4547 if (range != VK_WHOLE_SIZE) {
4548 // Range must be greater than 0
4549 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004550 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004551 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004552 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4553 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004554 }
4555 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004556 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4557 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004558 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004559 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004560 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4561 "(%" PRIu32 ").",
4562 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004563 }
4564 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004565 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004566 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004567 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004568 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4569 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4570 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004571 }
4572 // The sum of range and offset must be less than or equal to the size of buffer
4573 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004574 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004575 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004576 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4577 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4578 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004579 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004580 } else {
4581 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4582
4583 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4584 // VkPhysicalDeviceLimits::maxTexelBufferElements
4585 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4586 device_limits->maxTexelBufferElements) {
4587 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4588 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4589 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4590 "), divided by the element size of the format (%" PRIu32
4591 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4592 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4593 device_limits->maxTexelBufferElements);
4594 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004595 }
4596 return skip;
4597}
4598
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004599bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004600 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004601 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004602 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4603 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004604 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004605 "vkCreateBufferView(): If buffer was created with `usage` containing "
4606 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004607 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004608 }
4609 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4610 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004611 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004612 "vkCreateBufferView(): If buffer was created with `usage` containing "
4613 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004614 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004615 }
4616 return skip;
4617}
4618
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004619bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004620 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004621 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004622
Dave Houltond8ed0212018-05-16 17:18:24 -06004623 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004624
Jeff Bolz87697532019-01-11 22:54:00 -06004625 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4626 if (chained_devaddr_struct) {
4627 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4628 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004629 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4630 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4631 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004632 }
4633 }
4634
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004635 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4636 if (chained_opaqueaddr_struct) {
4637 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4638 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004639 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4640 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4641 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004642 }
4643 }
4644
Shannon McPherson4984e642019-12-05 13:04:34 -07004645 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004646 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4647 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004648 skip |= LogError(
4649 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004650 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4651 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4652 }
4653
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004654 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004655 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4656 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4657 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004658 }
4659
sfricke-samsungedce77a2020-07-03 22:35:13 -07004660 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4661 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4662 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4663 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4664 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4665 }
4666 const VkBufferCreateFlags invalid_flags =
4667 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4668 if ((pCreateInfo->flags & invalid_flags) != 0) {
4669 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4670 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4671 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4672 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4673 }
4674 }
4675
Mark Lobodzinski96210742017-02-09 10:33:46 -07004676 return skip;
4677}
4678
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004679bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004680 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004681 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004682 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004683 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4684 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004685 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004686 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4687 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004688 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004689 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4690 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4691 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004692
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004693 // Buffer view offset must be less than the size of buffer
4694 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004695 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004696 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004697 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4698 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004699 }
4700
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004701 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004702 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4703 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4704 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004705 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4706 : "VUID-VkBufferViewCreateInfo-offset-00926";
4707 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004708 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004709 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4710 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004711 }
4712
4713 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4714 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4715 if ((elementSize % 3) == 0) {
4716 elementSize /= 3;
4717 }
4718 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4719 VkDeviceSize alignmentRequirement =
4720 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4721 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4722 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4723 }
4724 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004725 skip |= LogError(
4726 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004727 "vkCreateBufferView(): If buffer was created with usage containing "
4728 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004729 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4730 ") must be a multiple of the lesser of "
4731 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4732 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4733 "(%" PRId32
4734 ") is VK_TRUE, the size of a texel of the requested format. "
4735 "If the size of a texel is a multiple of three bytes, then the size of a "
4736 "single component of format is used instead",
4737 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4738 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4739 }
4740 }
4741 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4742 VkDeviceSize alignmentRequirement =
4743 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4744 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4745 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4746 }
4747 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004748 skip |= LogError(
4749 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004750 "vkCreateBufferView(): If buffer was created with usage containing "
4751 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004752 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4753 ") must be a multiple of the lesser of "
4754 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4755 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4756 "(%" PRId32
4757 ") is VK_TRUE, the size of a texel of the requested format. "
4758 "If the size of a texel is a multiple of three bytes, then the size of a "
4759 "single component of format is used instead",
4760 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4761 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4762 }
4763 }
4764 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004765
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004766 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004767
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004768 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004769 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004770 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004771}
4772
Mark Lobodzinski602de982017-02-09 11:01:33 -07004773// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004774bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004775 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004776 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004777 const IMAGE_STATE *image_state = GetImageState(image);
4778 // checks color format and (single-plane or non-disjoint)
4779 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004780 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004781 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004782 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 -07004783 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004784 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 -07004785 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004786 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004787 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004788 skip |= LogError(image, vuid,
4789 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4790 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4791 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004792 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004793 skip |= LogError(image, vuid,
4794 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4795 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4796 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004797 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004798 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004799 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004800 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 -07004801 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004802 skip |=
4803 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 -07004804 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004805 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004806 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004807 skip |=
4808 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 -07004809 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004810 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4811 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004812 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004813 } else if (FormatIsMultiplane(format)) {
4814 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4815 if (3 == FormatPlaneCount(format)) {
4816 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4817 }
4818 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004819 skip |=
4820 LogError(image, vuid,
4821 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4822 "set, where n = [0, 1, 2].",
4823 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004824 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004825 }
4826 return skip;
4827}
4828
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004829bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4830 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004831 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4832 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004833 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004834
4835 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004836 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004837 skip |= LogError(image, errorCodes.base_mip_err,
4838 "%s: %s.baseMipLevel (= %" PRIu32
4839 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4840 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004841 }
Petr Kraus4d718682017-05-18 03:38:41 +02004842
Petr Krausffa94af2017-08-08 21:46:02 +02004843 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4844 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004845 skip |=
4846 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004847 } else {
4848 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004849
Petr Krausffa94af2017-08-08 21:46:02 +02004850 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004851 skip |= LogError(image, errorCodes.mip_count_err,
4852 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4853 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4854 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4855 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004856 }
Petr Kraus4d718682017-05-18 03:38:41 +02004857 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004858 }
Petr Kraus4d718682017-05-18 03:38:41 +02004859
4860 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004861 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004862 skip |= LogError(image, errorCodes.base_layer_err,
4863 "%s: %s.baseArrayLayer (= %" PRIu32
4864 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4865 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004866 }
Petr Kraus4d718682017-05-18 03:38:41 +02004867
Petr Krausffa94af2017-08-08 21:46:02 +02004868 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4869 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004870 skip |=
4871 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004872 } else {
4873 const uint64_t necessary_layer_count =
4874 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004875
Petr Krausffa94af2017-08-08 21:46:02 +02004876 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004877 skip |= LogError(image, errorCodes.layer_count_err,
4878 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4879 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4880 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4881 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004882 }
Petr Kraus4d718682017-05-18 03:38:41 +02004883 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004884 }
Petr Kraus4d718682017-05-18 03:38:41 +02004885
Mark Lobodzinski602de982017-02-09 11:01:33 -07004886 return skip;
4887}
4888
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004889bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004890 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004891 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004892 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4893 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4894 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4895
4896 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4897 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4898
4899 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004900 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4901 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004902 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004903 : "VUID-VkImageViewCreateInfo-image-01482")
4904 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4905 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004906 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004907 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4908 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004909
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004910 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004911 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004912 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004913}
4914
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004915bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004916 const VkImageSubresourceRange &subresourceRange,
4917 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004918 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004919 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4920 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4921 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4922 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004923
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004924 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004925 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004926 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004927}
4928
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004929bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004930 const VkImageSubresourceRange &subresourceRange,
4931 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004932 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004933 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4934 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4935 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4936 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004937
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004938 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004939 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4940 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004941}
4942
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004943bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004944 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004945 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004946 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004947 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4948 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4949 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4950 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004951
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004952 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004953 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004954}
4955
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004956bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4957 const VkImageUsageFlags image_usage) const {
4958 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4959 bool skip = false;
4960
4961 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4962 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4963
4964 if (image_state->has_ahb_format == true) {
4965 // AHB image view and image share same feature sets
4966 tiling_features = image_state->format_features;
4967 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4968 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4969 assert(device_extensions.vk_ext_image_drm_format_modifier);
4970 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4971 nullptr};
4972 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4973
4974 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4975 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4976 nullptr};
4977 format_properties_2.pNext = (void *)&drm_properties_list;
4978 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4979
4980 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4981 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4982 0) {
4983 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4984 }
4985 }
4986 } else {
4987 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4988 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4989 : format_properties.optimalTilingFeatures;
4990 }
4991
4992 if (tiling_features == 0) {
4993 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4994 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4995 "physical device.",
4996 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4997 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4998 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4999 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5000 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5001 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5002 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
5003 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
5004 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5005 "VK_IMAGE_USAGE_STORAGE_BIT.",
5006 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5007 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
5008 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
5009 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5010 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5011 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5012 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5013 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
5014 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
5015 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5016 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5017 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5018 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5019 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
5020 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
5021 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5022 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5023 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5024 }
5025
5026 return skip;
5027}
5028
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005029bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005030 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005031 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005032 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005033 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005034 skip |=
5035 ValidateImageUsageFlags(image_state,
5036 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5037 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
5038 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5039 false, kVUIDUndefined, "vkCreateImageView()",
5040 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
5041 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005042 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005043 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005044 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005045 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005046 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005047 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005048
5049 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5050 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005051 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005052 VkFormat view_format = pCreateInfo->format;
5053 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005054 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005055 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005056
Dave Houltonbd2e2622018-04-10 16:41:14 -06005057 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005058 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005059 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005060 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005061 if (!device_extensions.vk_ext_separate_stencil_usage) {
5062 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005063 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5064 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5065 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005066 }
5067 } else {
5068 const auto image_stencil_struct =
5069 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
5070 if (image_stencil_struct == nullptr) {
5071 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005072 skip |= LogError(
5073 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005074 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5075 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5076 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5077 }
5078 } else {
5079 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5080 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5081 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005082 skip |= LogError(
5083 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005084 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5085 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5086 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5087 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5088 }
5089 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5090 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005091 skip |= LogError(
5092 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005093 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5094 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5095 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5096 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5097 }
5098 }
5099 }
5100 }
5101
Dave Houltonbd2e2622018-04-10 16:41:14 -06005102 image_usage = chained_ivuci_struct->usage;
5103 }
5104
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005105 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5106 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005107 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005108 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005109 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005110 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005111 std::stringstream ss;
5112 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005113 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005114 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005115 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005116 }
5117 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005118 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06005119 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5120 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005121 const char *error_vuid;
5122 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5123 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5124 } else if ((device_extensions.vk_khr_maintenance2) &&
5125 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5126 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5127 } else if ((!device_extensions.vk_khr_maintenance2) &&
5128 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5129 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5130 } else {
5131 // both enabled
5132 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5133 }
Dave Houltonc7988072018-04-16 11:46:56 -06005134 std::stringstream ss;
5135 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005136 << " is not in the same format compatibility class as "
5137 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005138 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5139 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005140 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005141 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005142 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005143 }
5144 } else {
5145 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005146 // Unless it is a multi-planar color bit aspect
5147 if ((image_format != view_format) &&
5148 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5149 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5150 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005151 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005152 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005153 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005154 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005155 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005156 }
5157 }
5158
5159 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005160 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005161
5162 switch (image_type) {
5163 case VK_IMAGE_TYPE_1D:
5164 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005165 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5166 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5167 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005168 }
5169 break;
5170 case VK_IMAGE_TYPE_2D:
5171 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5172 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5173 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005174 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5175 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5176 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005177 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005178 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5179 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5180 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005181 }
5182 }
5183 break;
5184 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005185 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005186 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5187 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5188 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005189 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005190 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5191 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5192 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005193 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5194 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005195 skip |= LogError(
5196 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5197 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5198 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5199 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5200 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005201 }
5202 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005203 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5204 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5205 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005206 }
5207 }
5208 } else {
5209 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005210 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5211 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5212 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005213 }
5214 }
5215 break;
5216 default:
5217 break;
5218 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005219
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005220 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005221 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005222 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005223 }
5224
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005225 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005226
Jeff Bolz9af91c52018-09-01 21:53:57 -05005227 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5228 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005229 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5230 "vkCreateImageView() If image was created with usage containing "
5231 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
5232 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005233 }
5234 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005235 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5236 "vkCreateImageView() If image was created with usage containing "
5237 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005238 }
5239 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005240
5241 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5242 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5243 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5244 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5245 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5246 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5247 }
5248 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5249 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5250 skip |= LogError(
5251 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5252 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5253 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5254 }
5255 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005256
5257 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5258 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005259 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005260 "vkCreateImageView(): If image was created with usage containing "
5261 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5262 pCreateInfo->subresourceRange.levelCount);
5263 }
5264 }
5265 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5266 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005267 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005268 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5269 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5270 }
5271 } else {
5272 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5273 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5274 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005275 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005276 "vkCreateImageView(): If image was created with usage containing "
5277 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5278 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5279 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5280 }
5281 }
5282 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005283
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005284 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5285 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5286 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5287 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5288 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5289 }
5290 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5291 skip |=
5292 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5293 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5294 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5295 }
5296 }
5297 if (device_extensions.vk_ext_fragment_density_map_2) {
5298 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5299 (pCreateInfo->subresourceRange.layerCount >
5300 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5301 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5302 "vkCreateImageView(): If image was created with flags containing "
5303 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5304 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5305 pCreateInfo->subresourceRange.layerCount,
5306 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5307 }
5308 }
5309
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005310 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5311 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5312 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5313 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5314 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5315 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5316 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5317 }
5318 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005319 }
5320 return skip;
5321}
5322
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005323bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
5324 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005325 bool skip = false;
5326
5327 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5328 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5329 VkDeviceSize src_min = UINT64_MAX;
5330 VkDeviceSize src_max = 0;
5331 VkDeviceSize dst_min = UINT64_MAX;
5332 VkDeviceSize dst_max = 0;
5333
5334 for (uint32_t i = 0; i < regionCount; i++) {
5335 src_min = std::min(src_min, pRegions[i].srcOffset);
5336 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5337 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5338 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5339
5340 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5341 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005342 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
5343 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
5344 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5345 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005346 }
5347
5348 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5349 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005350 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
5351 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
5352 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5353 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005354 }
5355
5356 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5357 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005358 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
5359 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5360 ") is greater than the source buffer size (%" PRIuLEAST64
5361 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
5362 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005363 }
5364
5365 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5366 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005367 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
5368 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5369 ") is greater than the destination buffer size (%" PRIuLEAST64
5370 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
5371 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005372 }
5373 }
5374
5375 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5376 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5377 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005378 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
5379 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005380 }
5381 }
5382
5383 return skip;
5384}
5385
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005386bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005387 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005388 const auto cb_node = GetCBState(commandBuffer);
5389 const auto src_buffer_state = GetBufferState(srcBuffer);
5390 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005391
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005392 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005393 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5394 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005395 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005396 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005397 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5398 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005399 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005400 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5401 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005402 skip |=
5403 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5404 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005405 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5406 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005407 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
sfricke-samsung022fa252020-07-24 03:26:16 -07005408 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5409 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5410 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005411 return skip;
5412}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005413
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005414bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005415 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005416 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005417 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005418 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005419 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5420 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005421 }
5422 }
5423 return skip;
5424}
5425
Jeff Bolz5c801d12019-10-09 10:38:45 -05005426bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5427 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005428 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005429 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005430
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005431 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005432 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005433 skip |=
5434 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005435 }
5436 return skip;
5437}
5438
Jeff Bolz5c801d12019-10-09 10:38:45 -05005439bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005440 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005441
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005442 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005443 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005444 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005445 }
5446 return skip;
5447}
5448
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005449bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005450 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005451 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005452 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005453 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005454 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005455 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005456 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005457 }
5458 return skip;
5459}
5460
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005461bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005462 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005463 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005464 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005465 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005466 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005467 skip |=
5468 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5469 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005470 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005471 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005472 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5473 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005474 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005475
sfricke-samsung022fa252020-07-24 03:26:16 -07005476 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5477 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5478
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005479 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005480 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5481 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5482 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5483 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005484 }
5485
5486 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005487 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5488 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5489 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5490 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005491 }
5492
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005493 return skip;
5494}
5495
sfricke-samsungd0659242020-08-18 22:38:43 -07005496bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
5497 const VkBufferImageCopy *pRegions, const IMAGE_STATE *image_state,
5498 const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005499 bool skip = false;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005500 assert(image_state != nullptr);
5501 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005502
5503 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005504 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005505 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5506 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005507 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005508 LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00199",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005509 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5510 "and 1, respectively.",
5511 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005512 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005513 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005514
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005515 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5516 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005517 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00201",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005518 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5519 "must be 0 and 1, respectively.",
5520 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005521 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005522 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005523
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005524 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5525 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005526 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005527 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5528 "For 3D images these must be 0 and 1, respectively.",
5529 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005530 }
5531 }
5532
5533 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005534 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005535 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005536
sfricke-samsung125d2b42020-05-28 06:32:43 -07005537 // If not depth/stencil and not multi-plane
5538 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5539 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005540 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5541 ? "VUID-vkCmdCopyBufferToImage-bufferOffset-01558"
5542 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00193";
sfricke-samsung125d2b42020-05-28 06:32:43 -07005543 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005544 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5545 " must be a multiple of this format's texel size (%" PRIu32 ").",
5546 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005547 }
5548
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005549 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5550 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005551 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005552 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5553 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5554 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005555 }
5556
5557 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5558 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005559 skip |= LogError(
5560 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005561 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5562 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005563 }
5564
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005565 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005566 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005567 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005568 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 -06005569 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5570 static_cast<int32_t>(adjusted_image_extent.width))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005571 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005572 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5573 "zero or <= image subresource width (%d).",
5574 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005575 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005576 }
5577
5578 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005579 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 -06005580 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5581 static_cast<int32_t>(adjusted_image_extent.height))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005582 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005583 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5584 "zero or <= image subresource height (%d).",
5585 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005586 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005587 }
5588
5589 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005590 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 -06005591 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5592 static_cast<int32_t>(adjusted_image_extent.depth))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005593 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005594 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5595 "zero or <= image subresource depth (%d).",
5596 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005597 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005598 }
5599
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005600 // subresource aspectMask must have exactly 1 bit set
5601 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005602 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005603 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005604 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005605 "%s(): aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005606 }
5607
5608 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005609 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005610 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005611 image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005612 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
sfricke-samsung125d2b42020-05-28 06:32:43 -07005613 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005614 }
5615
5616 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005617 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5618 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005619
5620 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005621 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005622 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005623 ? "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203"
5624 : "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005625 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005626 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005627 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5628 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005629 }
5630
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005631 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005632 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005633 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005634 ? "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204"
5635 : "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005636 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005637 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005638 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5639 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005640 }
5641
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005642 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005643 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5644 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5645 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005646 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5647 ? "VUID-vkCmdCopyBufferToImage-imageOffset-00205"
5648 : "VUID-vkCmdCopyBufferToImage-imageOffset-00205";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005649 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005650 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5651 "width & height (%d, %d)..",
5652 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5653 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005654 }
5655
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005656 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005657 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005658 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005659 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005660 ? "VUID-vkCmdCopyBufferToImage-bufferOffset-00206"
5661 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00206";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005662 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005663 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5664 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5665 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005666 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005667
5668 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005669 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005670 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005671 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005672 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5673 ? "VUID-vkCmdCopyBufferToImage-imageExtent-00207"
5674 : "VUID-vkCmdCopyBufferToImage-imageExtent-00207";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005675 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005676 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5677 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5678 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5679 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005680 }
5681
5682 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005683 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005684 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005685 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5686 ? "VUID-vkCmdCopyBufferToImage-imageExtent-00208"
5687 : "VUID-vkCmdCopyBufferToImage-imageExtent-00208";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005688 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005689 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5690 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5691 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5692 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005693 }
5694
5695 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005696 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005697 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005698 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5699 ? "VUID-vkCmdCopyBufferToImage-imageExtent-00209"
5700 : "VUID-vkCmdCopyBufferToImage-imageExtent-00209";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005701 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005702 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5703 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5704 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5705 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005706 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005707 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005708
5709 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005710 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005711 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005712 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005713 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005714 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5715 "format has three planes.",
5716 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005717 }
5718
5719 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005720 if (0 ==
5721 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005722 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005723 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5724 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5725 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005726 } else {
5727 // Know aspect mask is valid
5728 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5729 const uint32_t compatible_size = FormatElementSize(compatible_format);
5730 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5731 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005732 image_state->image, "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
sfricke-samsung125d2b42020-05-28 06:32:43 -07005733 "%s(): pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
5734 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5735 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5736 string_VkFormat(compatible_format));
5737 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005738 }
5739 }
sfricke-samsungd0659242020-08-18 22:38:43 -07005740
5741 // Checks depth or stencil aspect are used in graphics queue
5742 if ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0) {
5743 assert(cb_node != nullptr);
5744 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5745 if (command_pool != nullptr) {
5746 const uint32_t queueFamilyIndex = command_pool->queueFamilyIndex;
5747 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queueFamilyIndex].queueFlags;
5748
5749 if ((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) {
5750 LogObjectList objlist(cb_node->commandBuffer);
5751 objlist.add(command_pool->commandPool);
5752 // TODO - Label when future headers get merged in from internral MR 4077 fix
5753 skip |=
5754 LogError(image_state->image, "UNASSIGNED-VkBufferImageCopy-aspectMask",
5755 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5756 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5757 "which was create with queueFamilyIndex %u which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5758 function, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5759 report_data->FormatHandle(command_pool->commandPool).c_str(), queueFamilyIndex);
5760 }
5761 }
5762 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005763 }
5764
5765 return skip;
5766}
5767
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005768bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5769 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005770 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005771 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005772
5773 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005774 VkExtent3D extent = pRegions[i].imageExtent;
5775 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005776
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005777 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5778 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005779 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5780 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5781 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005782 }
5783
5784 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5785
5786 // 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 -06005787 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005788 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005789 if (image_extent.width % block_extent.width) {
5790 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5791 }
5792 if (image_extent.height % block_extent.height) {
5793 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5794 }
5795 if (image_extent.depth % block_extent.depth) {
5796 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5797 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005798 }
5799
Dave Houltonfc1a4052017-04-27 14:32:45 -06005800 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005801 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005802 }
5803 }
5804
5805 return skip;
5806}
5807
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005808bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5809 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005810 bool skip = false;
5811
5812 VkDeviceSize buffer_size = buff_state->createInfo.size;
5813
5814 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005815 VkDeviceSize max_buffer_offset =
5816 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5817 if (buffer_size < max_buffer_offset) {
5818 skip |=
5819 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 -07005820 }
5821 }
5822
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005823 return skip;
5824}
5825
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005826bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005827 VkBuffer dstBuffer, uint32_t regionCount,
5828 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005829 const auto cb_node = GetCBState(commandBuffer);
5830 const auto src_image_state = GetImageState(srcImage);
5831 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005832
sfricke-samsungd0659242020-08-18 22:38:43 -07005833 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005834
5835 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005836 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005837
5838 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005839 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005840
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005841 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005842
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005843 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005844 skip |=
5845 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5846 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5847 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005848 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005849 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005850 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005851 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005852 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005853
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005854 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005855 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005856 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5857 skip |=
5858 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005859
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005860 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005861 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005862 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5863 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005864 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005865 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5866 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07005867 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdCopyImageToBuffer()",
5868 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831");
5869 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyImageToBuffer()",
5870 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832");
5871 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyImageToBuffer()",
5872 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005873
5874 // Validation for VK_EXT_fragment_density_map
5875 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5876 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyImageToBuffer-srcImage-02544",
5877 "vkCmdCopyBufferToImage(): srcImage must not have been created with flags containing "
5878 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5879 }
5880
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005881 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005882 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005883 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005884 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005885 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005886 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005887 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5888 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5889 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005890 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005891 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005892 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005893 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005894 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5895 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005896 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5897 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5898 skip |=
5899 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5900 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5901 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005902 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5903 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005904 }
5905 return skip;
5906}
5907
John Zulauf1686f232019-07-09 16:27:11 -06005908void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5909 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5910 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5911
5912 auto cb_node = GetCBState(commandBuffer);
5913 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005914 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005915 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005916 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005917 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005918}
5919
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005920bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5921 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005922 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005923 const auto cb_node = GetCBState(commandBuffer);
5924 const auto src_buffer_state = GetBufferState(srcBuffer);
5925 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005926
sfricke-samsungd0659242020-08-18 22:38:43 -07005927 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005928
5929 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005930 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005931
5932 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005933 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005934 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005935 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005936 skip |=
5937 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5938 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5939 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005940 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005941 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005942 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005943 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005944 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005945 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005946 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005947 skip |=
5948 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5949 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005950 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005951 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5952 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005953 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005954 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5955 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07005956 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBufferToImage()",
5957 "VUID-vkCmdCopyBufferToImage-commandBuffer-01828");
5958 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdCopyBufferToImage()",
5959 "VUID-vkCmdCopyBufferToImage-commandBuffer-01829");
5960 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdCopyBufferToImage()",
5961 "VUID-vkCmdCopyBufferToImage-commandBuffer-01830");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005962
5963 // Validation for VK_EXT_fragment_density_map
5964 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5965 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyBufferToImage-dstImage-02543",
5966 "vkCmdCopyBufferToImage(): dstImage must not have been created with flags containing "
5967 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5968 }
5969
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005970 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005971 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005972 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005973 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005974 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005975 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005976 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5977 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5978 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005979 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005980 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005981 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005982 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005983 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5984 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005985 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5986 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5987 skip |=
5988 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5989 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5990 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005991 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5992 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005993 }
5994 return skip;
5995}
5996
John Zulauf1686f232019-07-09 16:27:11 -06005997void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5998 VkImageLayout dstImageLayout, uint32_t regionCount,
5999 const VkBufferImageCopy *pRegions) {
6000 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6001
6002 auto cb_node = GetCBState(commandBuffer);
6003 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006004 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006005 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006006 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006007 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006008}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006009
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006010bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006011 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006012 bool skip = false;
6013 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6014
Dave Houlton1d960ff2018-01-19 12:17:05 -07006015 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006016 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6017 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6018 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006019 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6020 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006021 }
6022
John Zulaufa26d3c82019-08-14 16:09:08 -06006023 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006024 if (!image_entry) {
6025 return skip;
6026 }
6027
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006028 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6029 if (device_extensions.vk_ext_image_drm_format_modifier) {
6030 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6031 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006032 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6033 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6034 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006035 }
6036 } else {
6037 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006038 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6039 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006040 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006041 }
6042
Dave Houlton1d960ff2018-01-19 12:17:05 -07006043 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006044 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006045 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6046 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6047 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006048 }
6049
Dave Houlton1d960ff2018-01-19 12:17:05 -07006050 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006051 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006052 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6053 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6054 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006055 }
6056
Dave Houlton1d960ff2018-01-19 12:17:05 -07006057 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006058 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006059 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6060 if (FormatIsMultiplane(img_format)) {
6061 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
6062 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6063 if (FormatPlaneCount(img_format) > 2u) {
6064 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
6065 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6066 }
6067 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006068 skip |= LogError(image, vuid,
6069 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6070 ") must be a single-plane specifier flag.",
6071 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006072 }
6073 } else if (FormatIsColor(img_format)) {
6074 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006075 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6076 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6077 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006078 }
6079 } else if (FormatIsDepthOrStencil(img_format)) {
6080 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6081 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006082 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006083 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6084 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6085 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6086 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006087 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6088 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6089 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006090 }
6091 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006092
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006093 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006094 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006095 }
6096
Mike Weiblen672b58b2017-02-21 14:32:53 -07006097 return skip;
6098}
sfricke-samsung022fa252020-07-24 03:26:16 -07006099
6100// Validates the image is allowed to be protected
6101bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
6102 const char *vuid) const {
6103 bool skip = false;
6104 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6105 LogObjectList objlist(cb_state->commandBuffer);
6106 objlist.add(image_state->image);
6107 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image", cmd_name,
6108 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6109 report_data->FormatHandle(image_state->image).c_str());
6110 }
6111 return skip;
6112}
6113
6114// Validates the image is allowed to be unprotected
6115bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
6116 const char *vuid) const {
6117 bool skip = false;
6118 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6119 LogObjectList objlist(cb_state->commandBuffer);
6120 objlist.add(image_state->image);
6121 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image", cmd_name,
6122 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6123 report_data->FormatHandle(image_state->image).c_str());
6124 }
6125 return skip;
6126}
6127
6128// Validates the buffer is allowed to be protected
6129bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6130 const char *vuid) const {
6131 bool skip = false;
6132 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6133 LogObjectList objlist(cb_state->commandBuffer);
6134 objlist.add(buffer_state->buffer);
6135 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer", cmd_name,
6136 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6137 report_data->FormatHandle(buffer_state->buffer).c_str());
6138 }
6139 return skip;
6140}
6141
6142// Validates the buffer is allowed to be unprotected
6143bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6144 const char *vuid) const {
6145 bool skip = false;
6146 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6147 LogObjectList objlist(cb_state->commandBuffer);
6148 objlist.add(buffer_state->buffer);
6149 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer", cmd_name,
6150 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6151 report_data->FormatHandle(buffer_state->buffer).c_str());
6152 }
6153 return skip;
6154}